Enum Phenomenon 

#[non_exhaustive]
pub enum Phenomenon {
    NationalEmergency,
    NationalInformationCenter,
    NationalAudibleTest,
    NationalPeriodicTest,
    NationalSilentTest,
    RequiredMonthlyTest,
    RequiredWeeklyTest,
    AdministrativeMessage,
    Avalanche,
    Blizzard,
    BlueAlert,
    ChildAbduction,
    CivilDanger,
    CivilEmergency,
    CoastalFlood,
    DustStorm,
    Earthquake,
    Evacuation,
    ExtremeWind,
    Fire,
    FlashFlood,
    FlashFreeze,
    Flood,
    Freeze,
    HazardousMaterials,
    HighWind,
    Hurricane,
    HurricaneLocalStatement,
    LawEnforcementWarning,
    LocalAreaEmergency,
    NetworkMessageNotification,
    TelephoneOutage,
    NuclearPowerPlant,
    PracticeDemoWarning,
    RadiologicalHazard,
    SevereThunderstorm,
    SevereWeather,
    ShelterInPlace,
    SnowSquall,
    SpecialMarine,
    SpecialWeatherStatement,
    StormSurge,
    Tornado,
    TropicalStorm,
    Tsunami,
    Volcano,
    WinterStorm,
    Unrecognized,
}

SAME message phenomenon

A Phenomenon code indicates what prompted the message. These include tests, such as the required weekly test, and live messages like floods. Some events have multiple significance levels: floods can be reported as both a “Flood Watch” and a “Flood Warning.” The Phenomenon only encodes Phenomenon::Flood—the significance is left to other types.

Phenomenon may be matched individually if the user wishes to take special action…

match phenomenon {
    Phenomenon::Flood => println!("this message describes a flood"),
    _ => { /* pass */ }
}

… but the programmer must exercise caution here. Flooding may also result from a Phenomenon::FlashFlood or a larger event like a Phenomenon::Hurricane. An evacuation might be declared with Phenomenon::Evacuation, but many other messages might prompt an evacuation as part of the response. So:

⚠️ When in doubt, play the message and let the user decide! ⚠️

sameplace does separate Phenomenon into broad categories. These include:

assert!(Phenomenon::NationalPeriodicTest.is_national());
assert!(Phenomenon::NationalPeriodicTest.is_test());
assert!(Phenomenon::SevereThunderstorm.is_weather());
assert!(Phenomenon::Fire.is_non_weather());

All Phenomenon Display a human-readable description of the event, without its significance level.

use std::fmt;

assert_eq!(format!("{}", Phenomenon::HazardousMaterials), "Hazardous Materials");
assert_eq!(Phenomenon::HazardousMaterials.as_brief_str(), "Hazardous Materials");

but you probably want to display the full EventCode instead.

NOTE: the strum traits on this type are not considered API.

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.

NationalEmergency

National Emergency Message

This was previously known as Emergency Action Notification

NationalInformationCenter

National Information Center (United States, part of national activation)

NationalAudibleTest

National Audible Test (Canada)

NationalPeriodicTest

National Periodic Test (United States)

NationalSilentTest

National Silent Test (Canada)

RequiredMonthlyTest

Required Monthly Test

RequiredWeeklyTest

Required Weekly Test

AdministrativeMessage

Administrative Message

Used as follow-up for non-weather messages, including potentially to issue an all-clear.

Avalanche

Avalanche

Blizzard

Blizzard

BlueAlert

Blue Alert (state/local)

ChildAbduction

Child Abduction Emergency (state/local)

CivilDanger

Civil Danger Warning (state/local)

CivilEmergency

Civil Emergency Message (state/local)

CoastalFlood

Coastal Flood

DustStorm

Dust Storm

Earthquake

Earthquake Warning

NOTE: It is unclear if SAME is fast enough to provide timely notifications of earthquakes.

Evacuation

Evacuation Immediate

ExtremeWind

Extreme Wind

Fire

Fire Warning

FlashFlood

Flash Flood

FlashFreeze

Flash Freeze (Canada)

Flood

Flood

Freeze

Freeze (Canada)

HazardousMaterials

Hazardous Materials (Warning)

HighWind

High Wind

Hurricane

Hurricane

HurricaneLocalStatement

Hurricane Local Statement

LawEnforcementWarning

Law Enforcement Warning

LocalAreaEmergency

Local Area Emergency

NetworkMessageNotification

Network Message Notification

TelephoneOutage

911 Telephone Outage Emergency

NuclearPowerPlant

Nuclear Power Plant (Warning)

PracticeDemoWarning

Practice/Demo Warning

RadiologicalHazard

Radiological Hazard

SevereThunderstorm

Severe Thunderstorm

SevereWeather

Severe Weather Statement

ShelterInPlace

Shelter In Place

SnowSquall

Snow Squall

SpecialMarine

Special Marine

SpecialWeatherStatement

Special Weather Statement

StormSurge

Storm Surge

Tornado

Tornado Warning

TropicalStorm

Tropical Storm

Tsunami

Tsunami

Volcano

Volcano

WinterStorm

Winter Storm

Unrecognized

Unrecognized phenomenon

A catch-all for unrecognized event codes which either did not decode properly or are not known to sameold. If you encounter an Unrecognized event code in a production message, please report it as a bug right away.

Implementations

impl Phenomenon

pub fn as_brief_str(&self) -> &'static str

Describes the event without its accompanying severity information. For example,

assert_eq!(Phenomenon::RadiologicalHazard.as_brief_str(), "Radiological Hazard");

as opposed to the full human-readable description of the event code, “Radiological Hazard Warning.” If you want the full description, use EventCode instead.

pub fn is_national(&self) -> bool

True if the phenomenon is associated with a national activation

Returns true if the underlying event code is typically used for national activations. This includes both live National Emergency Messages and the National Periodic Test.

Clients should consult the message’s location codes to determine if the message actually has national scope.

pub fn is_test(&self) -> bool

True if the phenomenon is associated with tests

Returns true if the underlying event code is used only for tests. Test messages do not represent actual, real-world conditions. Test messages should also have a SignificanceLevel::Test.

pub fn is_weather(&self) -> bool

True if the represented phenomenon is weather

In the United States, weather phenomenon codes like “Severe Thunderstorm Warning” (SVR) are typically only issued by the National Weather Service. The list of weather event codes is taken from:

• “National Weather Service Instruction 10-1708,” 11 Dec 2017, https://www.nws.noaa.gov/directives/sym/pd01017008curr.pdf

Not all natural phenomenon are considered weather. Volcanoes, avalanches, and wildfires are examples of non-weather phenomenon that are naturally occurring. The National Weather Service does not itself issue these types of alerts; they are generally left to state and local authorities.

pub fn is_non_weather(&self) -> bool

True if the represented phenomenon is not weather

The opposite of Phenomenon::is_weather(). The list of non-weather event codes available for national, state, and/or local use is taken from:

• “National Weather Service Instruction 10-1708,” 11 Dec 2017, https://www.nws.noaa.gov/directives/sym/pd01017008curr.pdf

pub fn is_unrecognized(&self) -> bool

True if the phenomenon is not recognized

assert!(Phenomenon::Unrecognized.is_unrecognized());

pub fn is_recognized(&self) -> bool

True if the phenomenon is recognized

assert!(Phenomenon::TropicalStorm.is_recognized());

The opposite of is_unrecognized().

Trait Implementations

impl AsRef<str> for Phenomenon

fn as_ref(&self) -> &str

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

impl Clone for Phenomenon

fn clone(&self) -> Phenomenon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Phenomenon

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

Formats the value using the given formatter.

impl Default for Phenomenon

fn default() -> Phenomenon

Returns the “default value” for a type.

impl Display for Phenomenon

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

Formats the value using the given formatter.

impl EnumMessage for Phenomenon

fn get_message(&self) -> Option<&'static str>

fn get_detailed_message(&self) -> Option<&'static str>

fn get_documentation(&self) -> Option<&'static str>

Get the doc comment associated with a variant if it exists.

fn get_serializations(&self) -> &'static [&'static str]

impl EnumProperty for Phenomenon

fn get_str(&self, prop: &str) -> Option<&'static str>

fn get_int(&self, prop: &str) -> Option<i64>

fn get_bool(&self, prop: &str) -> Option<bool>

impl Hash for Phenomenon

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 IntoEnumIterator for Phenomenon

type Iterator = PhenomenonIter

fn iter() -> PhenomenonIter

impl PartialEq for Phenomenon

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

impl Eq for Phenomenon

impl StructuralPartialEq for Phenomenon