Enum sameold::FrameOut

pub enum FrameOut {
    NoCarrier,
    Searching,
    Reading,
    Ready(Result<Message, MessageDecodeErr>),
}

SAME/EAS Receiver 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.

This enum reports changes in the framing state to the caller. Each state change is emitted individually.

Variants

NoCarrier

No signal detected

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.

Ready(Result<Message, MessageDecodeErr>)

A message has been completely read

The current burst has ended, and the framer attempted to frame a complete message. It succeeded if the value is Ok.

The result contains either a fully-decoded Message that is ready for presentation to the user or an error decoding the same. Errors indicate only that decoding has failed for the moment, and future decodes may yield a useful message.

Implementations

impl FrameOut

pub fn is_active(&self) -> bool

True if the Framer wants data

Returns true if the framer is either searching for a burst prefix or reading burst data. When this value is true, the framer wants data. When this value is false, the framer needs to be restarted before it will do anything.

Trait Implementations

impl AsRef<str> for FrameOut

fn as_ref(&self) -> &str

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

impl Clone for FrameOut

fn clone(&self) -> FrameOut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameOut

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

Formats the value using the given formatter.

impl Display for FrameOut

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

Formats the value using the given formatter.

impl Hash for FrameOut

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<FrameOut> for FrameOut

fn eq(&self, other: &FrameOut) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FrameOut

impl StructuralEq for FrameOut

impl StructuralPartialEq for FrameOut