Skip to main content

ExportEnvelopeV1

Struct ExportEnvelopeV1 

Source
pub struct ExportEnvelopeV1 {
    pub envelope_id: EnvelopeId,
    pub schema_version: String,
    pub content_digest: ContentDigest,
    pub source_authority: String,
    pub scope_key: ScopeKey,
    pub trace_ctx: Option<TraceCtx>,
    pub exported_at: String,
    pub records: Vec<ExportRecord>,
}
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

Expand description

Forge-owned export envelope containing projection data.

The content digest covers: source_authority, scope_key, and all records (serialized with canonical JSON). The envelope_id, exported_at, and trace_ctx are excluded from the digest because they are metadata about the export, not the projection content.

Phase status: migration-only Removal condition: remove when all consumers have migrated to ExportEnvelopeV3

Fields§

§envelope_id: EnvelopeId
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

Unique envelope identity, assigned by Forge.

§schema_version: String
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

Always "export_envelope_v1" for this version.

§content_digest: ContentDigest
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

BLAKE3 content digest for idempotent deduplication.

§source_authority: String
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

Forge or other producing authority.

§scope_key: ScopeKey
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

Target scope for all records in this envelope.

§trace_ctx: Option<TraceCtx>
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

Cross-crate trace context.

§exported_at: String
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

ISO 8601 timestamp of when this envelope was exported.

§records: Vec<ExportRecord>
👎Deprecated since 0.2.0:

ExportEnvelopeV1 is compatibility-only. Use ExportEnvelopeV3 as the canonical export contract.

The export records.

Implementations§

Source§

impl ExportEnvelopeV1

Source

pub fn validate(&self) -> Result<(), ExportEnvelopeError>

Validate envelope structure.

Source

pub fn compute_digest( source_authority: &str, scope_key: &ScopeKey, records: &[ExportRecord], ) -> Result<ContentDigest, ExportEnvelopeError>

Compute the canonical content digest for this envelope’s content.

Trait Implementations§

Source§

impl Clone for ExportEnvelopeV1

Source§

fn clone(&self) -> ExportEnvelopeV1

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExportEnvelopeV1

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ExportEnvelopeV1

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<ExportEnvelopeV1> for ExportEnvelopeV2

Source§

fn from(value: ExportEnvelopeV1) -> Self

Converts to this type from the input type.
Source§

impl JsonSchema for ExportEnvelopeV1

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for ExportEnvelopeV1

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<ExportEnvelopeV2> for ExportEnvelopeV1

Source§

type Error = ExportEnvelopeError

The type returned in the event of a conversion error.
Source§

fn try_from(value: ExportEnvelopeV2) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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