Struct Ramp

pub struct Ramp { /* private fields */ }

Utility data structure to display one of several strings based on a value in a range, like a volume icon.

Implementations

impl Ramp

pub const fn empty() -> Self

Creates an empty instance (no icons).

When Ramp::choose is called on an empty ramp, it will always return an empty string.

pub fn choose<T>(&self, value: T, min: T, max: T) -> String

where T: Sub + Copy, f64: From<T>,

Given a value and a range, chooses the appropriate icon.

pub fn parse(name: impl AsRef<str>) -> Option<Self>

Parses a new instance with a given name from the global Config.

Ramps should be defined in a table called [ramps]. Each ramp should be a table with keys ranging from 0 to any number. The values should be pango markup strings.

Trait Implementations

impl Clone for Ramp

fn clone(&self) -> Ramp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ramp

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

Formats the value using the given formatter.

impl Default for Ramp

fn default() -> Ramp

Returns the “default value” for a type.

impl Extend<String> for Ramp

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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.

impl From<Vec<String>> for Ramp

fn from(icons: Vec<String>) -> Self

Converts to this type from the input type.

impl FromIterator<String> for Ramp

fn from_iter<T: IntoIterator<Item = String>>(iter: T) -> Self

Creates a value from an iterator.

impl Ord for Ramp

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Ramp

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Ramp

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Ramp

impl StructuralPartialEq for Ramp