Enum xosd_rs::Command

pub enum Command {
    Percentage(u16),
    String(String),
    Slider(u16),
}

Various types that can be displayed with Xosd::display

You should not construct any of these variants manually. Instead use one of the constructors below.

Variants

Percentage(u16)

Used to display a percentage

String(String)

Used to display text

Slider(u16)

Used to display a slider

Implementations

impl Command

pub fn percentage(percentage: u16) -> Result<Self>

Construct the Command::Percentage variant

Errors

If precentage is greater than 100 or less than 1 return Error::OutOfRangePercentage

pub fn string<S>(string: S) -> Result<Self> where
    S: ToString, 

Construct the Command::String variant

Errors

This function never fails

pub fn slider(slider: u16) -> Result<Self>

Construct the Command::Slider variant

Errors

If precentage is greater than 100 or less than 1 return Error::OutOfRangePercentage

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Eq for Command

impl Hash for Command

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Command

fn cmp(&self, other: &Command) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Command> for Command

fn eq(&self, other: &Command) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Command) -> bool

This method tests for !=.

impl PartialOrd<Command> for Command

fn partial_cmp(&self, other: &Command) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Command) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Command) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Command) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Command) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Command

impl StructuralPartialEq for Command