Struct Briefing 

#[non_exhaustive]
pub struct Briefing {
    pub source: String,
    pub generated_at: Option<DateTime<Utc>>,
    pub narrative: Option<String>,
    pub products: Vec<Product>,
}

A completed weather briefing.

Sources differ in shape: product-oriented APIs fill Self::products, document-oriented services (one rendered briefing text) fill Self::narrative. Either may be empty, both may be present. #[non_exhaustive]: construct with Briefing::new and the with_* setters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

source: String

crate::ContextProvider::name of the producing source.

generated_at: Option<DateTime<Utc>>

When the briefing was generated, if the source reports it.

narrative: Option<String>

Single-document briefing text, for document-oriented sources.

products: Vec<Product>

Discrete products, for product-oriented sources.

Implementations

impl Briefing

pub fn new(source: impl Into<String>) -> Self

An empty briefing attributed to source; fill it with the with_* setters.

pub fn with_generated_at(self, generated_at: Option<DateTime<Utc>>) -> Self

Set the generation time.

pub fn with_narrative(self, narrative: Option<String>) -> Self

Set the single-document narrative.

pub fn with_products(self, products: Vec<Product>) -> Self

Set the discrete products.

Trait Implementations

impl Clone for Briefing

fn clone(&self) -> Briefing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Briefing

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Briefing

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Briefing

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

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 Briefing