Enum sermux_proto::WellKnown

#[non_exhaustive]
#[repr(u16)]
pub enum WellKnown {
    Loopback = 0,
    HelloWorld = 1,
    PseudoKeyboard = 2,
    BinaryTracing = 3,
    ForthShell0 = 10,
    ForthShell1 = 11,
    ForthShell2 = 12,
    ForthShell3 = 13,
}

Well known SerialMuxService ports

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Loopback = 0

A bidirectional loopback channel - echos all characters back

HelloWorld = 1

An output-only channel for sending periodic sign of life messages

PseudoKeyboard = 2

An input-only channel to act as a keyboard for a GUI application such as a forth console, when there is no hardware keyboard available.

Unlike the ForthShell ports, which serve as ssh/telnet like bidirectional items, PseudoKeyboard is only used to receive the input, as the output is shown on a graphical terminal

BinaryTracing = 3

A bidirectional for binary encoded tracing messages

ForthShell0 = 10

A bidirectional interactive forth shell (1/4)

ForthShell1 = 11

A bidirectional interactive forth shell (2/4)

ForthShell2 = 12

A bidirectional interactive forth shell (3/4)

ForthShell3 = 13

A bidirectional interactive forth shell (4/4)

Trait Implementations

impl From<WellKnown> for u16

fn from(port: WellKnown) -> Self

Converts to this type from the input type.