Enum Word

pub enum Word<'a> {
    Category(WordCategory),
    Tag(u16),
    Attribute(WordAttribute<'a>),
    Message(&'a str),
}

Represents a word in a Mikrotik [Sentence].

Words can be of three types:

• A category word, which represents the type of sentence, such as !done, !re, !trap, or !fatal.
• A tag word, which represents a tag value like .tag=123.
• An attribute word, which represents a key-value pair like =name=ether1.

The word can be converted into one of these types using the TryFrom trait.

Examples

use mikrotik::command::reader::Word;

let word = Word::try_from(b"=name=ether1");
assert_eq!(word.unwrap().attribute(), Some(("name", Some("ether1"))));

Variants

Category(WordCategory)

A category word, such as !done, !re, !trap, or !fatal.

Tag(u16)

A tag word, such as .tag=123.

Attribute(WordAttribute<'a>)

An attribute word, such as =name=ether1.

Message(&'a str)

An unrecognized word. Usually this is a !fatal reason message.

Implementations

impl Word<'_>

pub fn category(&self) -> Option<&WordCategory>

Returns the category of the word, if it is a category word.

pub fn tag(&self) -> Option<u16>

Returns the tag of the word, if it is a tag word.

pub fn attribute(&self) -> Option<(&str, Option<&str>)>

Returns the attribute of the word, if it is an attribute word.

pub fn generic(&self) -> Option<&str>

Returns the generic word, if it is a generic word. This is usually a !fatal reason message.

pub fn word_type(&self) -> WordType

Returns the type of the Word.

Trait Implementations

impl<'a> Debug for Word<'a>

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

Formats the value using the given formatter.

impl Display for Word<'_>

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

Formats the value using the given formatter.

impl From<Word<'_>> for WordType

fn from(word: Word<'_>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Word<'a>

fn eq(&self, other: &Word<'a>) -> 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 [u8]> for Word<'a>

type Error = WordError

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for Word<'a>