Trait i3status_rs::blocks::ConfigBlock

pub trait ConfigBlock: Block {
    type Config;
    fn new(
        id: usize, 
        block_config: Self::Config, 
        shared_config: SharedConfig, 
        update_request: Sender<Task>
    ) -> Result<Self, Error>
    where
        Self: Sized;

    fn override_on_click(&mut self) -> Option<&mut Option<String>> { ... }
}

The ConfigBlock trait combines a constructor (new(...)) and an associated configuration type to form a block that can be instantiated from a piece of TOML (from the block configuration). The associated type has to be a deserializable struct, which you can then use to get your configurations from. The template shows you how to instantiate a simple Text widget. For more info on how to use widgets, just look into other Blocks. More documentation to come.

The sender object can be used to send asynchronous update request for any block from a separate thread, provide you know the Block's ID. This advanced feature can be used to reduce the number of system calls by asynchronously waiting for events. A usage example can be found in the Music block, which updates only when dbus signals a new song.

Associated Types

type Config

Loading content...

Required methods

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    update_request: Sender<Task>
) -> Result<Self, Error> where
    Self: Sized, 

Creates a new block from the relevant configuration.

Loading content...

Provided methods

fn override_on_click(&mut self) -> Option<&mut Option<String>>

TODO: write documentation

Loading content...

Implementors

impl ConfigBlock for Apt

type Config = AptConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Backlight

type Config = BacklightConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Battery

type Config = BatteryConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Bluetooth

type Config = BluetoothConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Cpu

type Config = CpuConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Custom

type Config = CustomConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx: Sender<Task>
) -> Result<Self, Error>

fn override_on_click(&mut self) -> Option<&mut Option<String>>

impl ConfigBlock for CustomDBus

type Config = CustomDBusConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for DiskSpace

type Config = DiskSpaceConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Docker

type Config = DockerConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for FocusedWindow

type Config = FocusedWindowConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Github

type Config = GithubConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Hueshift

type Config = HueshiftConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for IBus

type Config = IBusConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for KDEConnect

type Config = KDEConnectConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for KeyboardLayout

type Config = KeyboardLayoutConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Load

type Config = LoadConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Memory

type Config = MemoryConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Music

type Config = MusicConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

fn override_on_click(&mut self) -> Option<&mut Option<String>>

impl ConfigBlock for Net

type Config = NetConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for NetworkManager

type Config = NetworkManagerConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Notify

type Config = NotifyConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for NvidiaGpu

type Config = NvidiaGpuConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Pacman

type Config = PacmanConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Pomodoro

type Config = PomodoroConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _send: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Sound

type Config = SoundConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx_update_request: Sender<Task>
) -> Result<Self, Error>

fn override_on_click(&mut self) -> Option<&mut Option<String>>

impl ConfigBlock for SpeedTest

type Config = SpeedTestConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    done: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Taskwarrior

type Config = TaskwarriorConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Temperature

type Config = TemperatureConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Template

type Config = TemplateConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Time

type Config = TimeConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Toggle

type Config = ToggleConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Uptime

type Config = UptimeConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Watson

type Config = WatsonConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Weather

type Config = WeatherConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

impl ConfigBlock for Xrandr

type Config = XrandrConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    _tx_update_request: Sender<Task>
) -> Result<Self, Error>

Loading content...