Enum oasiscap::Alert

pub enum Alert {
    V1dot0(Alert),
    V1dot1(Alert),
    V1dot2(Alert),
}

A CAP alert message.

Variants

V1dot0(Alert)

A CAP v1.0 alert message

V1dot1(Alert)

A CAP v1.1 alert message

V1dot2(Alert)

A CAP v1.2 alert message

Implementations

impl Alert

pub fn identifier(&self) -> &Id

A unique identifier for this alert, assigned by the sender

pub fn sender(&self) -> &Id

A globally-unique identifier for the sender

pub fn sent(&self) -> DateTime

The date and time at which this alert originated

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

Returns the XML namespace corresponding to the encapsulated CAP alert version.

pub fn into_latest(self) -> Alert

Return this alert as the latest supported alert version, upgrading it as necessary.

CAP v1.2 is mostly a superset of earlier versions, with two exceptions:

1. CAP <= v1.1 Resource has an optional mime_type, whereas it’s required for CAP v1.2. This crate supplies application/octet-stream as a default if needed.

// let input: &str = /* CAP v1.0 appendix A.1 */;
let alert: oasiscap::Alert = input.parse().unwrap();
match &alert {
    oasiscap::Alert::V1dot0(alert) => {
        assert!(alert.info[0].resources[0].mime_type.is_none());
    }
    _ => unreachable!(),
}

let alert = alert.into_latest();
assert_eq!(alert.info[0].resources[0].mime_type, "application/octet-stream");

2. CAP v1.0 has Certainty::VeryLikely, while later versions do not. The specification recommends substituting Certainty::Likely, so this crate does.

// let input: &str = /* CAP v1.0 appendix A.3 */;
let alert: oasiscap::Alert = input.parse().unwrap();
match &alert {
    oasiscap::Alert::V1dot0(alert) => {
        assert_eq!(alert.info[0].certainty, oasiscap::v1dot0::Certainty::VeryLikely);
    }
    _ => unreachable!(),
}

let alert = alert.into_latest();
assert_eq!(alert.info[0].certainty, oasiscap::v1dot2::Certainty::Likely);

Trait Implementations

impl Clone for Alert

fn clone(&self) -> Alert

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Alert

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Alert

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Alert

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

Formats the value using the given formatter.

impl From<Alert> for Alert

fn from(v: Alert) -> Self

Performs the conversion.

impl From<Alert> for Alert

fn from(v: Alert) -> Self

Performs the conversion.

impl From<Alert> for Alert

fn from(v: Alert) -> Self

Performs the conversion.

impl FromStr for Alert

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Alert> for Alert

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

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

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

This method tests for !=.

impl Serialize for Alert

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Alert