Struct GuaranteeSet 

pub struct GuaranteeSet {
    pub delivery: Delivery,
    pub acknowledgement: Acknowledgement,
    pub durability: Option<Durability>,
    pub replicas: Option<u64>,
    pub ordering: OrderingMode,
    pub deduplication: Deduplication,
    pub dedup_window_ms: Option<u64>,
    pub backpressure: Backpressure,
    pub producer_naming: ProducerNaming,
    pub control_isolated: bool,
}

One level per guarantee dimension, as declared in HELLO keys 5 and 6 (docs/PROTOCOL.md §6.5).

GuaranteeSet::CORE is the default set and is exactly what v0 does, so an absent HELLO key, an empty map and CORE are the same statement (decisions/0006 §4.2). Every field is a small Copy value: a set costs no allocation, which is what lets it ride a header a peer controls.

Fields

delivery: Delivery

Delivery dimension.

acknowledgement: Acknowledgement

Acknowledgement/completion dimension.

durability: Option<Durability>

Persistence axis; legal only with Stored or Replicated.

replicas: Option<u64>

Replica count, leader included; legal only with Replicated, and ≥ 2.

ordering: OrderingMode

Ordering dimension.

deduplication: Deduplication

Deduplication dimension.

dedup_window_ms: Option<u64>

Dedup window; required with Bounded, forbidden otherwise.

backpressure: Backpressure

Backpressure behaviour. Not ordered.

producer_naming: ProducerNaming

How the producer of a sequenced transfer is named. Not ordered.

control_isolated: bool

Whether control traffic is isolated from bulk traffic (decisions/0002 §6.1). Ordered: true is strictly stronger.

Implementations

impl GuaranteeSet

pub const CORE: GuaranteeSet

The default set: what v0 offers and requires.

pub fn is_core(&self) -> bool

Is this the default set? A core declaration is never written: it is what an absent key already means.

pub fn intersect( &self, other: &GuaranteeSet, ) -> Result<GuaranteeSet, &'static str>

The weaker of two offered sets, dimension by dimension (docs/PROTOCOL.md §2.3 step 5).

Ladders take the minimum. Dimensions that are not ordered — backpressure, producer naming, and the two independent axes of a durability level — have no “weaker”, so the two declarations must be equal; the name of the dimension comes back as the error so a peer can be told which one disagreed.

pub fn reaches(&self, required: &GuaranteeSet) -> bool

Does this set reach required on every dimension?

Ladders compare by level, the durability axes compare per axis, and the unordered dimensions must match exactly. A longer dedup window is the stronger promise.

Trait Implementations

impl Clone for GuaranteeSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GuaranteeSet

impl Debug for GuaranteeSet

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

Formats the value using the given formatter.

impl Default for GuaranteeSet

fn default() -> Self

Returns the “default value” for a type.

impl Eq for GuaranteeSet

impl PartialEq for GuaranteeSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GuaranteeSet