Enum LinkState

#[non_exhaustive]
pub enum LinkState {
    NoCarrier,
    Searching,
    Reading,
    Burst(Vec<u8>),
}

SAME Link Layer Status

The SAME receiver decodes data in three basic steps:

1. Synchronization: the receiver estimates the bit and byte synchronization of the incoming signal.

2. Burst decoding: SAME transmissions are repeated three times. Each “burst” is decoded individually.

3. Message framing: three bursts are assembled into a single message, which receives some basic validity checks before being emitted to the client.

The LinkState reflects the overall state of this system as it detects the carrier, SAME preamble, and reads a Burst.

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.

NoCarrier

Dropped data carrier

Searching

Searching for burst prefix

The framer has synchronized to the bit/byte boundaries and is searching for a message prefix like “ZCZC.”

Reading

Now reading a burst

A SAME burst has been detected and is now being decoded.

Burst(Vec<u8>)

A burst has been completely read

The current burst has ended, and the raw burst bytes are included. SAME messages use only ASCII printable characters, but no such guarantees are made about the contents of this enum. The Burst is aligned to the start of the transmission (“ZCZC” or “NNNN”), but even those bytes may have errors.

Clients MUST NOT report a single Burst as a SAME message. Messages should instead be obtained from from the transport layer’s TransportState::Message.

Trait Implementations

impl AsRef<str> for LinkState

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for LinkState

fn clone(&self) -> LinkState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkState

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

Formats the value using the given formatter.

impl Display for LinkState

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

Formats the value using the given formatter.

impl From<LinkState> for SameEventType

fn from(inp: LinkState) -> Self

Converts to this type from the input type.

impl Hash for LinkState

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 PartialEq for LinkState

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

impl StructuralPartialEq for LinkState