Struct ProvenanceBuilder 

pub struct ProvenanceBuilder {
    node_type: ProvNodeType,
    node_id: u64,
    relations: Vec<ProvRelation>,
    overflow_ref: Option<u64>,
    prov_timestamp: HlcTimestamp,
    plan_id: Option<u64>,
}

Builder for ProvenanceHeader.

Collects relations in a Vec so callers don’t have to think about inline vs overflow slots. On build, the first INLINE_RELATION_SLOTS relations are packed inline; any remainder is signalled by setting overflow_ref.

Overflow record storage is the caller’s responsibility; the builder just records the pointer.

Fields

node_type: ProvNodeType

node_id: u64

relations: Vec<ProvRelation>

overflow_ref: Option<u64>

prov_timestamp: HlcTimestamp

plan_id: Option<u64>

Implementations

impl ProvenanceBuilder

pub fn new(node_type: ProvNodeType, node_id: u64) -> ProvenanceBuilder

Start a new builder for a given PROV node.

pub fn with_timestamp(self, ts: HlcTimestamp) -> ProvenanceBuilder

Set the HLC timestamp for the PROV event.

pub fn with_plan(self, plan_id: u64) -> ProvenanceBuilder

Set the Plan ID this activity follows (if any).

pub fn with_relation( self, kind: ProvRelationKind, target_id: u64, ) -> ProvenanceBuilder

Add a PROV-O relation edge. None kind is rejected by ProvenanceBuilder::build.

pub fn with_overflow_ref(self, overflow_ref: u64) -> ProvenanceBuilder

Explicitly set the overflow record pointer. Callers typically let build set this automatically when more than 4 relations are added.

pub fn build(self) -> Result<ProvenanceHeader, ProvenanceError>

Finalise the builder and validate the result.

If more than INLINE_RELATION_SLOTS relations were added and Self::with_overflow_ref was not called explicitly, ProvenanceError::OverflowNotSet is returned - callers must make the overflow record accessible through an out-of-band ID.

Trait Implementations

impl Clone for ProvenanceBuilder

fn clone(&self) -> ProvenanceBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProvenanceBuilder

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

Formats the value using the given formatter.