Struct Mode 

pub struct Mode(pub u8);

Mode defined by a line tag.

See MXP specification: MXP Line Tags.

Tuple Fields

0: u8

Implementations

impl Mode

pub const OPEN: Self

Only MXP commands in the OPEN category are allowed. When a newline is received from the MUD, the mode reverts back to the default mode. This mode starts as the default mode.

pub const SECURE: Self

All tags and commands in MXP are allowed within the line. When a newline is received from the MUD, the mode reverts back to the default mode.

pub const LOCKED: Self

No MXP or HTML commands are allowed in the line. The line is not parsed for any tags at all. When a newline is received from the MUD, the mode reverts back to the Default mode.

pub const RESET: Self

Close all open tags. Set active mode and default mode to OPEN. Set text color and properties to default.

pub const SECURE_ONCE: Self

Set SECURE mode for the next tag only. Must be immediately followed by a '<' character to start a tag.

pub const PERM_OPEN: Self

Set OPEN mode. Mode remains in effect until changed. OPEN mode becomes the new default mode.

pub const PERM_SECURE: Self

Set SECURE mode. Mode remains in effect until changed. SECURE mode becomes the new default mode.

pub const PERM_LOCKED: Self

Set LOCKED mode. Mode remains in effect until changed. LOCKED mode becomes the new default mode.

pub const ROOM_NAME: Self

The line is parsed as the name of a room.

pub const ROOM_DESC: Self

The line is parsed as the description of a room.

pub const ROOM_EXITS: Self

The line is parsed as the name of a room.

pub const WELCOME_TEXT: Self

This text is sent from the MUD at the beginning of a session to welcome the user to the MUD.

pub const USER_DEFINED_MIN: Self

Minimum value of a user-defined line mode. See Mode::is_user_defined.

pub const USER_DEFINED_MAX: Self

Maximum value of a user-defined line mode. See Mode::is_user_defined.

impl Mode

pub const fn is_open(self) -> bool

When this mode is active, only MXP commands in the OPEN category are allowed.

The following modes are OPEN:

• OPEN
• PERM_OPEN
• User defined line tags (see is_user_defined)

pub const fn is_locked(self) -> bool

When this mode is active, MXP tags should not be parsed.

The following modes are locked:

• LOCKED
• PERM_LOCKED

pub const fn is_automapping(self) -> bool

When this mode is active, the line is tagged for automappers.

Line modes between 10 ROOM_NAME and 19 WELCOME_TEXT are reserved for automappers.

pub const fn parse_as(self) -> Option<ParseAs>

How the line should be parsed by an automapper. This only applies to ROOM_NAME, Mode::ROOM_DESC, and ROOM_EXITS.

pub const fn is_user_defined(self) -> bool

When this mode is active, the line is tagged for a MUD-specific purpose. The tag must have been previously defined using an MXP definition command to tell the client how to handle the line.

A common use for these is to tag various chat channels to allow client-side filtering or redirection of the text.

User-defined tags must be between 20 (USER_DEFINED_MIN) and 99 (USER_DEFINED_MAX).

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Mode

Returns the “default value” for a type.

impl Display for Mode

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

Formats the value using the given formatter.

impl From<Mode> for usize

fn from(value: Mode) -> Self

Converts to this type from the input type.

impl Hash for Mode

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Mode

fn cmp(&self, other: &Mode) -> 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<Mode> for u8

fn eq(&self, other: &Mode) -> 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<Mode> for usize

fn eq(&self, other: &Mode) -> 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<u8> for Mode

fn eq(&self, other: &u8) -> 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<usize> for Mode

fn eq(&self, other: &usize) -> 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 for Mode

fn eq(&self, other: &Mode) -> 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<Mode> for u8

fn partial_cmp(&self, other: &Mode) -> 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 PartialOrd<Mode> for usize

fn partial_cmp(&self, other: &Mode) -> 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 PartialOrd<u8> for Mode

fn partial_cmp(&self, other: &u8) -> 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 PartialOrd<usize> for Mode

fn partial_cmp(&self, other: &usize) -> 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 PartialOrd for Mode

fn partial_cmp(&self, other: &Mode) -> 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 TryFrom<i16> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Mode

type Error = ModeRangeError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode