Struct SplitDescriptor 

pub struct SplitDescriptor {
    pub objects: Vec<DescriptorObject>,
    /* private fields */
}

The opaque payload carried in a SplitSpec::descriptor: the split’s member objects, in listing order.

The encoding is versioned JSON (DESCRIPTOR_VERSION); member order is meaningful (composite offsets index into it). Out-of-process producers — an event-notification planner, a single-shot invocation minting one split from an S3 event — construct via SplitDescriptor::new (which stamps the version; encode refuses anything else) and mint ids with split_id_for, which together are the whole cross-process contract. Fields are freely readable.

Fields

objects: Vec<DescriptorObject>

Member objects, in listing (and therefore read) order.

Implementations

impl SplitDescriptor

pub fn new(objects: Vec<DescriptorObject>) -> SplitDescriptor

Build a descriptor over objects (listing order — ordinals index into it), stamped with the current DESCRIPTOR_VERSION. The only way to construct one; encode refuses any other version.

pub fn version(&self) -> u32

The encoding version this descriptor was constructed (or decoded) under.

pub fn encode(&self) -> Result<Vec<u8>, CoordinationError>

Encode to the versioned wire form.

Errors

Fatal when the descriptor’s version is not DESCRIPTOR_VERSION — a descriptor written under a wrong version fails pipeline-fatal on every worker that leases it.

pub fn decode(bytes: &[u8]) -> Result<SplitDescriptor, CoordinationError>

Decode a descriptor, probing the version first.

Errors

Fatal when the bytes do not parse or were written under a different DESCRIPTOR_VERSION — a worker must never guess at an incompatible descriptor.

Trait Implementations

impl Clone for SplitDescriptor

fn clone(&self) -> SplitDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SplitDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SplitDescriptor

impl PartialEq for SplitDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SplitDescriptor

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 SplitDescriptor