Struct EventCode 

pub struct EventCode { /* private fields */ }

Decoded SAME event code

Represents the decoding of a three-character SAME event code, like “RWT,” into a phenomenon and significance.

• The phenomenon describes what is occurring

• The significance indicates the overall severity and/or how “noisy” or intrusive the alert should be.

EventCode are usually constructed via MessageHeader::event() but may also be directly created from string.

use sameplace::{EventCode, Phenomenon, SignificanceLevel};

let evt = EventCode::from("RWT");
assert_eq!(evt.phenomenon(), Phenomenon::RequiredWeeklyTest);
assert_eq!(evt.significance(), SignificanceLevel::Test);

EventCode are Ord by their significance levels.

assert!(EventCode::from("RWT") < EventCode::from("SVA"));
assert!(EventCode::from("SVA") < EventCode::from("SVR"));

The Display representation is a human-readable string representing both phenomenon and significance.

assert_eq!(EventCode::from("SVA").to_string(), "Severe Thunderstorm Watch");

The conversion from string is infallible, but invalid strings will result in an unrecognized message.

let watch = EventCode::from("??A");
assert!(watch.is_unrecognized());
assert_eq!(watch.significance(), SignificanceLevel::Watch);
assert_eq!(watch.to_string(), "Unrecognized Watch");

let unrec = EventCode::from("???");
assert!(unrec.is_unrecognized());
assert_eq!(unrec.significance(), SignificanceLevel::Unknown);
assert_eq!(unrec.to_string(), "Unrecognized Warning");

If the phenomenon portion cannot be decoded, the third character is parsed as a SignificanceLevel if possible. Unrecognized messages are still valid, and clients are encouraged to handle them at their significance level as normal.

Implementations

impl EventCode

pub fn from<S>(code: S) -> Self

where S: AsRef<str>,

Parse from SAME code, like “RWT”

This type is usually constructed via MessageHeader::event(), but you can also construct them directly. This method decodes the string representation of a three-character SAME event code, like “RWT,” into a machine-readable event.

If the input code is not known to sameplace, is not in the required format (i.e., three ASCII characters), or is otherwise not valid, the output of is_unrecognized() will be true.

pub fn phenomenon(&self) -> Phenomenon

What is occurring?

pub fn significance(&self) -> SignificanceLevel

What is the anticipated severity?

pub fn to_display_string(&self) -> String

Human-readable string representation

Converts to a human-readable string, like “Required Monthly Test.”

pub fn is_test(&self) -> bool

True for test messages

Test messages do not represent real-life events or emergencies.

pub fn is_unrecognized(&self) -> bool

True if any part of the event code was unrecognized

Indicates that either the phenomenon or the significance could not be determined from the input SAME code.

Unrecognized messages are still valid, and clients are encouraged to handle them at their significance level as normal.

Trait Implementations

impl Clone for EventCode

fn clone(&self) -> EventCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventCode

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

Formats the value using the given formatter.

impl Default for EventCode

fn default() -> Self

Returns the “default value” for a type.

impl Display for EventCode

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

Formats the value using the given formatter.

impl From<&String> for EventCode

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for EventCode

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<(Phenomenon, SignificanceLevel)> for EventCode

fn from(value: (Phenomenon, SignificanceLevel)) -> Self

Converts to this type from the input type.

impl Hash for EventCode

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 Ord for EventCode

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EventCode

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for EventCode

impl Eq for EventCode

impl StructuralPartialEq for EventCode