Struct TranscriptHeader 

#[non_exhaustive]
pub struct TranscriptHeader {
    pub rite_transcript: u32,
    pub vocabulary: u32,
    pub producer: String,
    pub run_id: String,
    pub dry_run: bool,
    pub levels: BTreeMap<String, Level>,
}

First line of every transcript: what the file is, read before any fact.

Chained like every other line, so it cannot be swapped without breaking the fingerprint. A reader checks rite_transcript before parsing anything else and refuses a value it does not know.

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.

rite_transcript: u32

Format version of the envelope and chain rule (TRANSCRIPT_FORMAT).

vocabulary: u32

Version of the fact vocabulary (FACT_VOCABULARY).

producer: String

Program and version that wrote the transcript, as it reports itself. Informational: a binary cannot vouch for its own identity.

run_id: String

Random identifier of this run, 32 lowercase hex digits.

dry_run: bool

Whether the run was a dry run. A dry-run transcript is a rehearsal record, never evidence of a ceremony.

levels: BTreeMap<String, Level>

Every level this transcript uses, by name. Holds the built-in levels at their fixed values, and any level the ceremony declares.

Implementations

impl TranscriptHeader

pub fn new(producer: &str, run_id: &str, dry_run: bool) -> Self

A header for the current format and vocabulary.

pub fn declares(&self, level: Level) -> bool

Whether the header declares level.

pub fn level(&self, name_or_value: &str) -> Option<Level>

A declared level, by the name the header gives it or by its number.

Trait Implementations

impl Clone for TranscriptHeader

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 TranscriptHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TranscriptHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TranscriptHeader

impl PartialEq for TranscriptHeader

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TranscriptHeader

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 TranscriptHeader