Struct BatchItem 

pub struct BatchItem {
    pub key: String,
    pub input: Value,
    pub label: Option<Label>,
}

One unit of work in a batch.

Fields

key: String

Stable, unique within the batch, and ordered.

Ordering is what lets the cursor be a single value rather than a set of seen keys, which for 10⁵ items is the difference between a resume that reads one row and one that reads the whole batch. A meter number, a document id, or a zero-padded sequence all work; a random uuid does not, because “everything after this key” then means nothing.

input: Value

What the plan receives as run input for this item.

label: Option<Label>

The input’s label, when the source vouches for one.

None — the default — admits the item untrusted, from the source batch:<batch id>. A source reading a paged API, a file or somebody else’s database is the normal case, and an item it produced is data from outside the plane: trusted input would reach every mutating sink and every protected field with no release on the record.

Implementations

impl BatchItem

pub fn new(key: impl Into<String>, input: Value) -> Self

An item admitted untrusted, from the source batch:<batch id>.

pub fn labelled(self, label: Label) -> Self

Admit this item under label instead.

The operator’s statement about where the source’s data came from, journaled as the run’s input label. Label::trusted() is the one to think about: it says the plane’s own operator produced this input, and every taint gate downstream takes that at its word.

pub fn admission_label(&self, batch: BatchId) -> Label

The label this item’s run is admitted under, in batch batch.

Trait Implementations

impl Clone for BatchItem

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 BatchItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchItem

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BatchItem

impl PartialEq for BatchItem

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BatchItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BatchItem