Struct Envelope 

pub struct Envelope {
    pub warden_version: &'static str,
    pub record_version: u32,
    pub report: String,
    pub period: Period,
    pub rows: Vec<Value>,
    pub notes: Vec<String>,
}

The one shape every --json response has.

rows is Value rather than a typed row: the row shape is per report and may gain fields freely, so the envelope stays report-agnostic.

Fields

warden_version: &'static str

record_version: u32

report: String

period: Period

rows: Vec<Value>

notes: Vec<String>

Implementations

impl Envelope

pub fn new( report: impl Into<String>, window: TimeWindow, rows: Vec<Value>, ) -> Self

pub fn with_notes<S: Into<String>>( self, notes: impl IntoIterator<Item = S>, ) -> Self

Attach the caller-supplied notes (e.g. "cost figures are estimates").

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Serialize for Envelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.