Struct Provenance 

pub struct Provenance { /* private fields */ }

Who made a commit, and on whose behalf.

Private fields with one construction point, so a commit signed by a run that does not exist cannot be assembled a field at a time.

Implementations

impl Provenance

pub fn new( run: RunId, actor: Address, city: B3Hash, chosen: ModelChoice, ) -> Provenance

The one construction point.

pub fn succeeding(self, predecessor: RunId) -> Provenance

Names the run this one replaced, so a commit can be asked for its lineage. A sixth trailer, present only when there is one.

pub fn predecessor(&self) -> Option<RunId>

The run this one replaced, when it is a successor.

pub fn city_of(ledger_dir: &Path) -> Result<B3Hash, StorageError>

The city’s identity: the chain hash of its genesis line.

Only the first line of the first segment is read. A city’s whole history can be tens of megabytes, and reading it to learn one hash would make every checkpoint pay for the length of the city’s life.

Errors

Propagates a ledger directory that cannot be listed or read, and refuses a directory holding no ledger at all — a city with no genesis line has no identity to sign with.

pub fn actor(&self) -> &Address

Who this commit is signed as.

pub fn run(&self) -> RunId

The run this commit belongs to, which names the reference a wave checkpoint is filed under.

pub fn attribution(&self) -> CommitAttribution

Which session made this commit, in the shape every record that names a commit carries it. Both checkpoint_committed and pr_merged are stamped from here, so the two cannot describe one commit differently.

pub fn trailers(&self) -> String

The trailers block, in this order and this spelling, one per line and newline-terminated. The sixth line appears only for a run that replaced another.

Trait Implementations

impl Clone for Provenance

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 Provenance

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

Formats the value using the given formatter.

impl Eq for Provenance

impl PartialEq for Provenance

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Provenance