Struct bitbar::Menu

source · [−]

pub struct Menu(pub Vec<MenuItem>);

Expand description

A BitBar menu.

Usually constructed by calling collect on an Iterator of MenuItems.

Tuple Fields

0: Vec<MenuItem>

Implementations

source

impl Menu

source

pub fn push(&mut self, item: impl Into<MenuItem>)

Adds a menu item to the bottom of the menu.

Trait Implementations

source

impl Debug for Menu

source

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

Formats the value using the given formatter. Read more

source

impl Default for Menu

source

fn default() -> Menu

Returns the “default value” for a type. Read more

source

impl Display for Menu

This provides the main functionality of this crate: rendering a BitBar plugin.

Note that the output this generates already includes a trailing newline, so it should be used with print! instead of println!.

source

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

Formats the value using the given formatter. Read more

source

impl<A: Into<MenuItem>> Extend<A> for Menu

source

fn extend<T: IntoIterator<Item = A>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more

source

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

source

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

source

impl<C: TryInto<Command>> From<NotificationCommandError<C>> for Menu where
C::Error: Error,

source

fn from(e: NotificationCommandError<C>) -> Menu

Converts to this type from the input type.

source

impl From<PluginNameError> for Menu

source

fn from(e: PluginNameError) -> Menu

Converts to this type from the input type.

source

impl From<VersionCheckError> for Menu

source

fn from(e: VersionCheckError) -> Menu

Converts to this type from the input type.

source

impl<A: Into<MenuItem>> FromIterator<A> for Menu

source

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Menu

Creates a value from an iterator. Read more

source

impl IntoIterator for Menu

type Item = MenuItem

The type of the elements being iterated over.

type IntoIter = IntoIter<MenuItem, Global>

Which kind of iterator are we turning this into?

source

fn into_iter(self) -> IntoIter<MenuItem>

Creates an iterator from a value. Read more

Auto Trait Implementations

impl RefUnwindSafe for Menu

impl Send for Menu

impl Sync for Menu

impl Unpin for Menu

impl UnwindSafe for Menu

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<'a, T> AsyncMainOutput<'a> for T where
T: 'a + MainOutput,

source

fn main_output(
self,
error_template_image: Option<Image>
) -> Pin<Box<dyn Future<Output = ()> + 'a, Global>>

Available on crate feature tokio only.

Displays this value as a menu, using the given template image in case of an error.

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> MainOutput for T where
T: Into<Menu>,

source

fn main_output(self, Option<Image>)

Displays this value as a menu, using the given template image in case of an error.

impl<T> NoneValue for T where
T: Default,

type NoneType = T

fn null_value() -> T

The none-equivalent value.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian,
P: Default,

source

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

source

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

source

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bitbar::Menu

Tuple Fields

Implementations

impl Menu

pub fn push(&mut self, item: impl Into<MenuItem>)

Trait Implementations

impl Debug for Menu

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

impl Default for Menu

fn default() -> Menu

impl Display for Menu

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

impl<A: Into<MenuItem>> Extend<A> for Menu

fn extend<T: IntoIterator<Item = A>>(&mut self, iter: T)

fn extend_one(&mut self, item: A)

fn extend_reserve(&mut self, additional: usize)

impl<C: TryInto<Command>> From<NotificationCommandError<C>> for Menu where C::Error: Error,

fn from(e: NotificationCommandError<C>) -> Menu

impl From<PluginNameError> for Menu

fn from(e: PluginNameError) -> Menu

impl From<VersionCheckError> for Menu

fn from(e: VersionCheckError) -> Menu

impl<A: Into<MenuItem>> FromIterator<A> for Menu

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Menu

impl IntoIterator for Menu

type Item = MenuItem

type IntoIter = IntoIter<MenuItem, Global>

fn into_iter(self) -> IntoIter<MenuItem>

Auto Trait Implementations

impl RefUnwindSafe for Menu

impl Send for Menu

impl Sync for Menu

impl Unpin for Menu

impl UnwindSafe for Menu

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<'a, T> AsyncMainOutput<'a> for T where T: 'a + MainOutput,

fn main_output( self, error_template_image: Option<Image>) -> Pin<Box<dyn Future<Output = ()> + 'a, Global>>

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> MainOutput for T where T: Into<Menu>,

fn main_output(self, Option<Image>)

impl<T> NoneValue for T where T: Default,

type NoneType = T

fn null_value() -> T

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<R, P> ReadPrimitive<R> for P where R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<C: TryInto<Command>> From<NotificationCommandError<C>> for Menu where
C::Error: Error,

impl<T> Any for T where
T: 'static + ?Sized,

impl<'a, T> AsyncMainOutput<'a> for T where
T: 'a + MainOutput,

fn main_output(
self,
error_template_image: Option<Image>
) -> Pin<Box<dyn Future<Output = ()> + 'a, Global>>

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> MainOutput for T where
T: Into<Menu>,

impl<T> NoneValue for T where
T: Default,

impl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian<P>,
P: Default,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,