Struct Var 

pub struct Var<S = String> {
    pub name: S,
    pub desc: Option<S>,
    pub keywords: FlagSet<EntityKeyword>,
}

The <VAR> tag is just like the <!ENTITY> tag, except that the value of the variable is placed between the <VAR> and </VAR> tags, and this value is displayed to the user.

Examples

use mxp::entity::EntityKeyword;

assert_eq!(
    "<VAR Hp DESC=Health PUBLISH>".parse::<mxp::Var>(),
    Ok(mxp::Var {
        name: "Hp".into(),
        desc: Some("Health".into()),
        keywords: EntityKeyword::Publish.into(),
    }),
);

Fields

name: S

Variable name.

desc: Option<S>

Variable description.

keywords: FlagSet<EntityKeyword>

Keywords.

Implementations

impl<S> Var<S>

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

where F: FnMut(S) -> T,

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

impl<S: IntoOwnedString> Var<S>

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

impl<S: AsRef<str>> Var<S>

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

Returns a new struct that borrows text from this one.

pub fn with_value<'a>(&'a self, value: &'a str) -> EntityDefinition<'a>

Creates an EntityDefinition from properties and a value.

Trait Implementations

impl<S: Clone> Clone for Var<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Var<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Var<S>

fn default() -> Var<S>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<S> From<S> for Var<S>

fn from(name: S) -> Self

Converts to this type from the input type.

impl FromStr for Var

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<Var<&str>> for Var<String>

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

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

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

fn eq(&self, other: &Var<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<Var> for Var<&str>

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

fn eq(&self, other: &Var<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 Var<S>

fn eq(&self, other: &Var<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 Var<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 Var<S>

impl<S: Eq> Eq for Var<S>

impl<S> StructuralPartialEq for Var<S>