Enum Message

pub enum Message {
    StartOfMessage(MessageHeader),
    EndOfMessage,
}

A fully-decoded SAME/EAS message

In the EAS, the “message” is actually the audio signal to be broadcast to the human listener: i.e., the “message” is the synthesized voice you hear on weather radio. The message is wrapped in audio pass-band digital data. The digital data demarcates the StartOfMessage and the EndOfMessage.

The StartOfMessage contains digital codes and timestamps which summarize the audio message to follow. Some messages are intended for either silent or audible tests. Others report actual emergencies; these either may or must interrupt normal broadcast programming.

The audio message immediately follows. The audio message may be up to two minutes long.

The EndOfMessage demarcates the end of the audio message.

Message implements Display and efficient conversion to &str.

More information on the SAME/EAS standard may be found in,

• “NOAA Weather Radio (NWR) All Hazards Specific Area Message Encoding (SAME),” NWSI 10-172, 3 Oct. 2011, https://www.nws.noaa.gov/directives/sym/pd01017012curr.pdf

Variants

StartOfMessage(MessageHeader)

Indicates start of audio message

A StartOfMessage indicates that a SAME/EAS audio message immediately follows. The message header contains the event type, affected areas, time extents, and originator information.

For broadcast stations, the in-band audio which immediately follows the StartOfMessage may break station programming and be aired directly to listeners.

EndOfMessage

Indicates end of audio message

An EndOfMessage marks the conclusion of the SAME/EAS audio message. For broadcast stations, it is an indication that normal programming may resume.

Implementations

impl Message

pub fn as_str(&self) -> &str

Convert to string representation

pub fn parity_error_count(&self) -> usize

Count of parity errors

The number of bit errors which were corrected by the 2-of-3 parity correction algorithm. High parity error counts indicate a high bit error rate in the receiving system.

Parity errors are not tracked for the EndOfMessage variant.

pub fn voting_byte_count(&self) -> usize

Number of bytes which were bit-voted

voting_byte_count is the total number of bytes which were checked via the “two of three” bitwise voting algorithm—i.e., the total number of bytes for which all three SAME bursts were available.

Voting counts are not tracked for the EndOfMessage variant.

Trait Implementations

impl AsRef<str> for Message

fn as_ref(&self) -> &str

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

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Display for Message

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

Formats the value using the given formatter.

impl Hash for Message

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 Message

fn eq(&self, other: &Message) -> 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 TryFrom<(&[u8], &[u8], &[u8])> for Message

type Error = MessageDecodeErr

The type returned in the event of a conversion error.

fn try_from(inp: (&[u8], &[u8], &[u8])) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(String, &[u8])> for Message

type Error = MessageDecodeErr

The type returned in the event of a conversion error.

fn try_from(inp: (String, &[u8])) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Message

type Error = MessageDecodeErr

The type returned in the event of a conversion error.

fn try_from(inp: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Message

impl StructuralPartialEq for Message