Skip to main content

ProvenanceRecord

cdx_core::provenance

Struct ProvenanceRecord

pub struct ProvenanceRecord {
    pub version: String,
    pub document_id: DocumentId,
    pub created: DateTime<Utc>,
    pub creator: Option<CreatorInfo>,
    pub lineage: Option<Lineage>,
    pub merkle: MerkleInfo,
    pub timestamps: Vec<TimestampRecord>,
    pub derived_from: Vec<DerivationRecord>,
}

Expand description

Complete provenance record for a document.

This structure is stored at provenance/record.json and provides:

Document identity and creation information
Full lineage chain
Merkle tree information for content integrity
Timestamp records for temporal anchoring
Derivation records for tracking content sources

Fields§

§version: String

Version of the provenance record format.

§document_id: DocumentId

Document identifier.

§created: DateTime<Utc>

When the document was created.

§creator: Option<CreatorInfo>

Information about the document creator.

§lineage: Option<Lineage>

Lineage information.

§merkle: MerkleInfo

Merkle tree information.

§timestamps: Vec<TimestampRecord>

Timestamp records for temporal anchoring.

§derived_from: Vec<DerivationRecord>

Records of content derived from other sources.

Implementations§

impl ProvenanceRecord

pub const VERSION: &'static str = "0.1"

Current version of the provenance record format.

pub fn new(document_id: DocumentId, merkle: MerkleInfo) -> Self

Create a new provenance record.

pub fn with_creator(self, creator: CreatorInfo) -> Self

Set the creator information.

pub fn with_lineage(self, lineage: Lineage) -> Self

Set the lineage information.

pub fn with_timestamp(self, timestamp: TimestampRecord) -> Self

Add a timestamp record.

pub fn with_derivation(self, derivation: DerivationRecord) -> Self

Add a derivation record.

pub fn to_json(&self) -> Result<String>

Serialize to JSON.

§Errors

Returns an error if serialization fails.

pub fn from_json(json: &str) -> Result<Self>

Deserialize from JSON.

§Errors

Returns an error if deserialization fails.

Trait Implementations§

impl Clone for ProvenanceRecord

fn clone(&self) -> ProvenanceRecord

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ProvenanceRecord

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ProvenanceRecord

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for ProvenanceRecord

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProvenanceRecord

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for ProvenanceRecord

impl StructuralPartialEq for ProvenanceRecord

Auto Trait Implementations§

impl Freeze for ProvenanceRecord

impl RefUnwindSafe for ProvenanceRecord

impl Send for ProvenanceRecord

impl Sync for ProvenanceRecord

impl Unpin for ProvenanceRecord

impl UnsafeUnpin for ProvenanceRecord

impl UnwindSafe for ProvenanceRecord

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,