Struct BarConfigBuilder

pub struct BarConfigBuilder { /* private fields */ }

Builder for BarConfig.

Implementations

impl BarConfigBuilder

pub fn name(self, value: String) -> Self

The bar name to look for in the config file

pub fn left(self, value: Vec<Box<dyn PanelConfig>>) -> Self

pub fn center(self, value: Vec<Box<dyn PanelConfig>>) -> Self

pub fn right(self, value: Vec<Box<dyn PanelConfig>>) -> Self

pub fn position(self, value: Position) -> Self

Whether the bar should be rendered at the top or bottom of the screen

pub fn height(self, value: u16) -> Self

In pixels

pub fn transparent(self, value: bool) -> Self

Whether the bar can be transparent. The background color still applies!

pub fn bg(self, value: Color) -> Self

The background color. Supports transparency if transparent is true.

pub fn margins(self, value: Margins) -> Self

The minimum gaps between the edges of the screen and panel sections. See Margins for details.

pub fn attrs(self, value: Attrs) -> Self

The default attributes of panels on the bar. See Attrs for details.

pub fn reverse_scroll(self, value: bool) -> Self

Whether to reverse the scrolling direction for panel events.

pub fn ipc(self, value: bool) -> Self

Whether inter-process communication (via Unix socket) is enabled. See crate::ipc for details.

pub fn monitor(self, value: Option<String>) -> Self

Which monitor to display the bar on. Defaults to the primary monitor.

pub fn build(self) -> Result<BarConfig, BarConfigBuilderError>

Builds a new BarConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for BarConfigBuilder

fn default() -> Self

Returns the “default value” for a type.