Struct EnvelopeHeader 

pub struct EnvelopeHeader {
    pub format_version: u32,
    pub kind: String,
    pub created_at: String,
    pub count: usize,
    pub generator: String,
}

Header of an enveloped record stream.

Fields

format_version: u32

Stream format version. This build writes ENVELOPE_FORMAT_VERSION.

kind: String

What the stream carries: "session_export", "store_backup", …

created_at: String

RFC 3339 creation timestamp of the stream.

count: usize

Declared record count (advisory; validated as a warning on mismatch).

generator: String

Producing binary and version, e.g. "wm 9.0.0".

Implementations

impl EnvelopeHeader

pub fn new(kind: &str, count: usize) -> Self

A header for a stream being written right now.

pub fn header_line(&self) -> String

The header as a single JSON line for stream prefixes.

pub fn check_version(&self) -> Result<(), String>

Validate format_version against this build. Newer formats are refused with an actionable message; equal or older are accepted.

Errors

When the header declares a format newer than this build supports.

Trait Implementations

impl Clone for EnvelopeHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvelopeHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EnvelopeHeader

impl PartialEq for EnvelopeHeader

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EnvelopeHeader

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 EnvelopeHeader