Struct Relocate 

pub struct Relocate<S = String> {
    pub hostname: S,
    pub port: u16,
    pub quiet: bool,
}

Closes the current MUD connection and causes a new connect to open on a new server.

See MXP specification: <RELOCATE>.

Examples

assert_eq!(
    "<RELOCATE new.server.com 1000>".parse::<mxp::Relocate>(),
    Ok(mxp::Relocate {
        hostname: "new.server.com".into(),
        port: 1000,
        quiet: false,
    }),
);

Fields

hostname: S

Hostname of the new connection.

port: u16

Port of the new connection.

quiet: bool

The optional keyword QUIET can be used to suppress further output from the MUD. When the closing </RELOCATE> tag is used, MUD output is resumed.

Implementations

impl<S> Relocate<S>

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

where F: FnOnce(S) -> T,

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

impl<S: IntoOwnedString> Relocate<S>

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

impl<S: AsRef<str>> Relocate<S>

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

Returns a new struct that borrows text from this one.

Trait Implementations

impl<S: Clone> Clone for Relocate<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Relocate<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Relocate<S>

fn default() -> Relocate<S>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl FromStr for Relocate

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

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

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

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

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

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

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

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

impl<S: Eq> Eq for Relocate<S>

impl<S> StructuralPartialEq for Relocate<S>