Struct Envelope 

pub struct Envelope<D = GenericValue> {
    pub sink: Option<SinkName>,
    pub version: u8,
    pub ts: DateTime<Utc>,
    pub position: Option<Position>,
    pub index: IndexName,
    pub op: Op,
    pub id: String,
    pub meta: Option<EnvelopeMeta>,
    pub document: Option<D>,
}

One document operation as a lane carries it and a sink receives it.

Generic over the document so one shape serves the pipeline (Envelope<GenericValue>, the default) and a consumer of an emitting sink’s output (Envelope<MyDocument> deserialized from the same JSON). On the wire the position is seq, an opaque string; sink and meta are set by the sink side and absent inside the pipeline.

Fields

sink: Option<SinkName>

The emitting sink’s name, filled by that sink as it writes the envelope out; absent inside the pipeline, where one batch is shared by every sink.

version: u8

ENVELOPE_VERSION at the time of writing.

ts: DateTime<Utc>

When the ingest engine built this document.

position: Option<Position>

The position of the change that produced it; None for a snapshot row. Serialized as seq, the position rendered as an opaque string.

index: IndexName

The logical index the document belongs to.

op: Op

Upsert or delete.

id: String

The document id within the index: the root primary key as a string.

meta: Option<EnvelopeMeta>

A summary of the serialized document, filled by an emitting sink (it knows the wire format); absent inside the pipeline and on a delete.

document: Option<D>

The built document; absent on a delete.

Implementations

impl<D> Envelope<D>

pub fn map_document<E>(self, f: impl FnOnce(D) -> E) -> Envelope<E>

The same envelope over a document of another type: how an emitting sink translates the pipeline’s value into its wire format.

impl Envelope

pub fn upsert( index: IndexName, id: impl Into<String>, document: GenericValue, position: Option<Position>, ts: DateTime<Utc>, ) -> Self

An upsert of document under id in index.

pub fn delete( index: IndexName, id: impl Into<String>, position: Option<Position>, ts: DateTime<Utc>, ) -> Self

A delete of id from index.

Trait Implementations

impl<D: Clone> Clone for Envelope<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for Envelope<D>

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

Formats the value using the given formatter.

impl<'de, D> Deserialize<'de> for Envelope<D>

where D: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: PartialEq> PartialEq for Envelope<D>

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

Equality operator ==.

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

Inequality operator !=.

impl<D> Serialize for Envelope<D>

where D: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<D: PartialEq> StructuralPartialEq for Envelope<D>