Struct Gauge 

pub struct Gauge<S = String> {
    pub entity: S,
    pub max: Option<S>,
    pub caption: Option<S>,
    pub color: Option<RgbColor>,
}

Displays an MXP entity value as a gauge.

See MXP specification: <GAUGE>.

Examples

use mxp::RgbColor;

assert_eq!(
    "<GAUGE Hp MAX=HpMax CAPTION=Health COLOR=red>".parse::<mxp::Gauge>(),
    Ok(mxp::Gauge {
        entity: "Hp".into(),
        max: Some("HpMax".into()),
        caption: Some("Health".into()),
        color: Some(RgbColor::hex(0xFF0000)),
    }),
);

Fields

entity: S

Name of the entity to use as gauge data.

max: Option<S>

Name of the entity to use for the maximum value of the gauge.

caption: Option<S>

Optional text to display on the gauge.

color: Option<RgbColor>

Color of the gauge bar.

Implementations

impl<S> Gauge<S>

pub fn map_text<T, F>(self, f: F) -> Gauge<T>

where F: FnMut(S) -> T,

Applies a type transformation to all text, returning a new struct.

impl<S: IntoOwnedString> Gauge<S>

pub fn into_owned(self) -> Gauge<String>

impl<S: AsRef<str>> Gauge<S>

pub fn borrow_text(&self) -> Gauge<&str>

Returns a new struct that borrows text from this one.

Trait Implementations

impl<S: Clone> Clone for Gauge<S>

fn clone(&self) -> Gauge<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Gauge<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Gauge<S>

fn default() -> Gauge<S>

Returns the “default value” for a type.

impl<S: AsRef<str>> Display for Gauge<S>

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

Formats the value using the given formatter.

impl FromStr for Gauge

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Gauge<&str>> for Gauge<String>

fn eq(&self, other: &Gauge<&str>) -> 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 PartialEq<Gauge<&str>> for Gauge<Cow<'_, str>>

fn eq(&self, other: &Gauge<&str>) -> 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 PartialEq<Gauge<Cow<'_, str>>> for Gauge<String>

fn eq(&self, other: &Gauge<Cow<'_, str>>) -> 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 PartialEq<Gauge<Cow<'_, str>>> for Gauge<&str>

fn eq(&self, other: &Gauge<Cow<'_, str>>) -> 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 PartialEq<Gauge> for Gauge<&str>

fn eq(&self, other: &Gauge<String>) -> 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 PartialEq<Gauge> for Gauge<Cow<'_, str>>

fn eq(&self, other: &Gauge<String>) -> 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<S: PartialEq> PartialEq for Gauge<S>

fn eq(&self, other: &Gauge<S>) -> 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<'a> TryFrom<&'a str> for Gauge<Cow<'a, str>>

type Error = FromStrError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<S: Copy> Copy for Gauge<S>

impl<S: Eq> Eq for Gauge<S>

impl<S> StructuralPartialEq for Gauge<S>