Trait ruci::MessageParameterPointer

pub trait MessageParameterPointer: Copy + Debug + Hash + Eq + PartialEq {
    type MessagePointer: MessagePointer;

    // Required methods
    fn as_string(self) -> &'static str;
    fn from_message_and_str(
        message_pointer: Self::MessagePointer,
        s: &str
    ) -> Result<Self, MessageParameterPointerParseError>;
    fn has_value(self) -> bool;
}

This is a simple Copy “pointer” enum necessary for parsing.

Required Associated Types

type MessagePointer: MessagePointer

Required Methods

fn as_string(self) -> &'static str

fn from_message_and_str( message_pointer: Self::MessagePointer, s: &str ) -> Result<Self, MessageParameterPointerParseError>

Parses a string to a message parameter pointer.

Errors

• MessageParameterPointerParseError::MessageHasNoParameters: if the message_pointer argument points to a message without parameters, such as uciok.
• MessageParameterPointerParseError::StringDoesNotMapToParameterPointer: if the message_pointer argument points to a message, which does have parameters, but the s argument doesn’t match any of them. For example, if you pass in a message pointer for the id command, but the s argument is "developer", this will error because id only has name and author parameters.

fn has_value(self) -> bool

Whether this parameter has a value. Almost all do, but ponder and infinite of the go message don’t. They are referred to as “void parameters”.

Object Safety

This trait is not object safe.

Implementors