Struct bitbar::flavor::swiftbar::SwiftBar

pub struct SwiftBar(_);

A type-safe handle for SwiftBar-specific features.

Some SwiftBar-specific features are currently unsupported:

• Script metadata is unsupported since cargo does not support adding metadata to binaries it produces. You will have to add any metadata via xattr.

Implementations

impl SwiftBar

pub fn check() -> Option<Self>

Checks whether the plugins is running in SwiftBar by checking environment variables. If it does, returns a handle allowing use of SwiftBar-specific features.

pub fn assume() -> Self

This is supported on crate feature assume-flavor only.

Returns a handle allowing use of SwiftBar-specific features without checking whether the plugin is actually running inside SwiftBar. If the plugin is actually running in a different implementation, this may lead to incorrect behavior.

pub fn running_version(&self) -> Result<Version, VersionCheckError>

Returns the SwiftBar version on which the plugin is running by checking environment variables.

pub fn command(&self, cmd: impl IntoParams) -> Params

Unlike BitBar, SwiftBar supports more than 5 parameters for bash= commands.

pub fn themed_color(&self, light: Color, dark: Color) -> Color

Returns a Color that renders differently depending on whether the system is in dark mode.

pub fn sf_image(&self, item: &mut ContentItem, image: impl ToString)

Adds a SF Symbols image to a menu item.

Trait Implementations

impl Clone for SwiftBar

fn clone(&self) -> SwiftBar

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SwiftBar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for SwiftBar