Struct SameReceiverEvent

pub struct SameReceiverEvent { /* private fields */ }

Full SAME receiver status

SAME decoding occurs at two separate layers:

1. Link layer: the demodulator, synchronizer, and framer convert analog waveforms into frames of data. Each individual SAME “burst” is a frame.

2. Transport layer: each SAME frame is transmitted three times for redundancy. These retransmissions are combined together to form a single Message estimate.

The what() method returns the event, which may originate from either layer.

You can also query for the message() or an individual burst() estimate, if one is available now. Not all events have either of these things to report.

Implementations

impl SameReceiverEvent

pub fn message(&self) -> Option<&MessageResult>

Message or message decoding error, if any

If the current update includes a message or a reportable decoding error, returns Some() with a message result.

pub fn message_ok(&self) -> Option<&Message>

Successfully-decoded message, if any

If the current update includes a successfully-decoded message, returns it. If no message is available, returns None. Consider using message() instead to report errors.

pub fn burst(&self) -> Option<&[u8]>

Raw SAME data burst, if any

Digital SAME headers are transmitted three times for redundancy. This method retrieves the raw received bytes from the link layer if any are available with this event.

If present, the link layer guarantees that:

1. No further bytes will be added to this burst. It is complete as far as the modem is aware.

2. The bytes are aligned to the start of the transmission after the preamble. If the bytes were received error-free, they begin with ZCZC or NNNN, but this itself is not guaranteed.

SAME messages use only ASCII printable characters, but no such guarantees are made about this field.

Clients MUST NOT report a single burst as a SAME message. Messages should instead be obtained from from the transport layer’s message().

pub fn into_message(self) -> Option<MessageResult>

Consume event, returning successfully-decoded message, if any

If the current update includes a successfully-decoded message, returns it. If no message is available, returns None.

pub fn into_message_ok(self) -> Option<Message>

Consume event, returning successfully-decoded message, if any

If the current update includes a successfully-decoded message, returns it. If no message is available, returns None. Consider using SameReceiverEvent::into_message instead.

pub fn what(&self) -> &SameEventType

The event which triggered the output

Either the link layer or the transport layer may trigger an event.

pub fn input_sample_counter(&self) -> u64

Event time, measured in input samples

Reports the “time” of the event using a monotonic count of input samples.

Trait Implementations

impl Clone for SameReceiverEvent

fn clone(&self) -> SameReceiverEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SameReceiverEvent

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

Formats the value using the given formatter.

impl Display for SameReceiverEvent

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

Formats the value using the given formatter.

impl From<SameReceiverEvent> for Option<Message>

fn from(rx: SameReceiverEvent) -> Self

Converts to this type from the input type.

impl From<SameReceiverEvent> for Option<MessageResult>

fn from(rx: SameReceiverEvent) -> Self

Converts to this type from the input type.

impl Hash for SameReceiverEvent

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 SameReceiverEvent

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

impl StructuralPartialEq for SameReceiverEvent