Trait i3status_rs::blocks::Block

pub trait Block {
    fn id(&self) -> usize;
    fn view(&self) -> Vec<&dyn I3BarWidget>;

    fn update(&mut self) -> Result<Option<Update>, Error> { ... }
    fn signal(&mut self, _signal: i32) -> Result<(), Error> { ... }
    fn click(&mut self, _event: &I3BarEvent) -> Result<(), Error> { ... }
}

The Block trait is used to interact with a block after it has been instantiated from ConfigBlock

Required methods

fn id(&self) -> usize

A unique id for the block (asigend by the constructor).

fn view(&self) -> Vec<&dyn I3BarWidget>

Use this function to return the widgets that comprise the UI of your component.

The music block may, for example, be comprised of a text widget and multiple buttons (buttons are also TextWidgets). Use a vec to wrap the references to your view.

Loading content...

Provided methods

fn update(&mut self) -> Result<Option<Update>, Error>

Required if you don't want a static block.

Use this function to update the internal state of your block, for example during periodic updates. Return the duration until your block wants to be updated next. For example, a clock could request only to be updated every 60 seconds by returning Some(Update::Every(Duration::new(60, 0))) every time. If you return None, this function will not be called again automatically.

fn signal(&mut self, _signal: i32) -> Result<(), Error>

Sends a signal event with the provided signal, this function is called on every block for every signal event

fn click(&mut self, _event: &I3BarEvent) -> Result<(), Error>

Sends click events to the block.

Here you can react to the user clicking your block. The I3BarEvent instance contains all fields to describe the click action, including mouse button and location down to the pixel. You may also update the internal state here.

If block uses more that one widget, use the event.instance property to determine which widget was clicked.

Loading content...

Implementors

impl Block for Apt

fn id(&self) -> usize

fn view(&self) -> Vec<&dyn I3BarWidget>

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

impl Block for Backlight

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Battery

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Bluetooth

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for Cpu

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Custom

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn signal(&mut self, signal: i32) -> Result<(), Error>

fn click(&mut self, _e: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for CustomDBus

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for DiskSpace

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Docker

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for FocusedWindow

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Github

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Hueshift

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for IBus

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, _: &I3BarEvent) -> Result<(), Error>

impl Block for KDEConnect

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for KeyboardLayout

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for Load

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Memory

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for Music

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for Net

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for NetworkManager

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for Notify

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

impl Block for NvidiaGpu

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Pacman

fn id(&self) -> usize

fn view(&self) -> Vec<&dyn I3BarWidget>

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

impl Block for Pomodoro

fn id(&self) -> usize

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

impl Block for Sound

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for SpeedTest

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Taskwarrior

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Temperature

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Template

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, _: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Time

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Toggle

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, _e: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Uptime

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Watson

fn update(&mut self) -> Result<Option<Update>, Error>

fn click(&mut self, _e: &I3BarEvent) -> Result<(), Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn id(&self) -> usize

impl Block for Weather

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, event: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl Block for Xrandr

fn update(&mut self) -> Result<Option<Update>, Error>

fn view(&self) -> Vec<&dyn I3BarWidget>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

fn id(&self) -> usize

impl<T: Block> Block for BaseBlock<T>

fn id(&self) -> usize

fn view(&self) -> Vec<&dyn I3BarWidget>

fn update(&mut self) -> Result<Option<Update>, Error>

fn signal(&mut self, signal: i32) -> Result<(), Error>

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

Loading content...