Skip to main content

Alert

Struct Alert 

Source
pub struct Alert {
Show 15 fields pub communication_period: Option<Vec<TimeRange>>, pub impact_period: Option<Vec<TimeRange>>, pub cause: Option<AlertCause>, pub cause_detail: Option<String>, pub effect: Option<AlertEffect>, pub effect_detail: Option<String>, pub url: Option<String>, pub header_text: String, pub description_text: String, pub tts_header_text: Option<String>, pub tts_description_text: Option<String>, pub severity_level: Option<AlertSeverityLevel>, pub image_url: Option<String>, pub image_media_type: Option<String>, pub image_alternative_text: Option<String>,
}
Expand description

Alert : An alert, indicating some sort of incident in the public transit network.

Fields§

§communication_period: Option<Vec<TimeRange>>

Time when the alert should be shown to the user. If missing, the alert will be shown as long as it appears in the feed. If multiple ranges are given, the alert will be shown during all of them.

§impact_period: Option<Vec<TimeRange>>

Time when the services are affected by the disruption mentioned in the alert.

§cause: Option<AlertCause>§cause_detail: Option<String>

Description of the cause of the alert that allows for agency-specific language; more specific than the Cause.

§effect: Option<AlertEffect>§effect_detail: Option<String>

Description of the effect of the alert that allows for agency-specific language; more specific than the Effect.

§url: Option<String>

The URL which provides additional information about the alert.

§header_text: String

Header for the alert. This plain-text string will be highlighted, for example in boldface.

§description_text: String

Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header.

§tts_header_text: Option<String>

Text containing the alert’s header to be used for text-to-speech implementations. This field is the text-to-speech version of header_text. It should contain the same information as headerText but formatted such that it can read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.)

§tts_description_text: Option<String>

Text containing a description for the alert to be used for text-to-speech implementations. This field is the text-to-speech version of description_text. It should contain the same information as description_text but formatted such that it can be read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.)

§severity_level: Option<AlertSeverityLevel>

Severity of the alert.

§image_url: Option<String>

String containing an URL linking to an image.

§image_media_type: Option<String>

IANA media type as to specify the type of image to be displayed. The type must start with "image/"

§image_alternative_text: Option<String>

Text describing the appearance of the linked image in the image field (e.g., in case the image can’t be displayed or the user can’t see the image for accessibility reasons). See the HTML spec for alt image text.

Implementations§

Source§

impl Alert

Source

pub fn new(header_text: String, description_text: String) -> Alert

An alert, indicating some sort of incident in the public transit network.

Trait Implementations§

Source§

impl Clone for Alert

Source§

fn clone(&self) -> Alert

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Alert

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Alert

Source§

fn default() -> Alert

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Alert

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Alert

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Alert

Auto Trait Implementations§

§

impl Freeze for Alert

§

impl RefUnwindSafe for Alert

§

impl Send for Alert

§

impl Sync for Alert

§

impl Unpin for Alert

§

impl UnsafeUnpin for Alert

§

impl UnwindSafe for Alert

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more