Struct RangeOwnership 

pub struct RangeOwnership { /* private fields */ }

One owned shard/range: the catalog’s unit of routing and fencing.

An entry is self-describing — it carries its collection, range id, mode, bounds, owner, replicas, epoch, version, and placement — so a data member that receives it by replication can route and fence without consulting any other state. New ownership states are produced as transitions off an existing entry (transfer_to, update_replicas, update_placement), each of which advances the version — and, for an owner change, the fencing epoch.

Implementations

impl RangeOwnership

pub fn establish( collection: CollectionId, range_id: RangeId, shard_key_mode: ShardKeyMode, bounds: RangeBounds, owner: NodeIdentity, replicas: impl IntoIterator<Item = NodeIdentity>, placement: PlacementMetadata, ) -> RangeOwnership

The initial ownership state for a freshly created range: version and epoch both at their initial values.

pub fn collection(&self) -> &CollectionId

pub fn range_id(&self) -> RangeId

pub fn shard_key_mode(&self) -> ShardKeyMode

pub fn bounds(&self) -> &RangeBounds

pub fn owner(&self) -> &NodeIdentity

pub fn replicas(&self) -> &[NodeIdentity]

pub fn epoch(&self) -> OwnershipEpoch

pub fn version(&self) -> CatalogVersion

pub fn placement(&self) -> &PlacementMetadata

pub fn transfer_to( &self, new_owner: NodeIdentity, new_replicas: impl IntoIterator<Item = NodeIdentity>, ) -> RangeOwnership

A transition that moves write authority to new_owner with new_replicas. Advances both the version (it is a catalog write) and the ownership epoch (write authority moved, so any old owner is fenced).

pub fn update_replicas( &self, new_replicas: impl IntoIterator<Item = NodeIdentity>, ) -> RangeOwnership

A transition that changes only the replica set. Advances the version but not the epoch: write authority did not move, so no owner is fenced.

pub fn update_placement(&self, placement: PlacementMetadata) -> RangeOwnership

A transition that changes only placement metadata. Advances the version but not the epoch.

pub fn with_bounds(&self, bounds: RangeBounds) -> RangeOwnership

A transition that re-bounds the range without moving write authority — the retained-child step of a range split, which narrows this entry to the keys its owner keeps while a sibling entry takes the carved-off subrange. Advances the version but not the epoch: the same owner keeps writing the retained keys, so no one is fenced.

pub fn role_of(&self, node: &NodeIdentity) -> RangeRole

This node’s RangeRole for this range (issue #990).

A data member is the single writer (Owner) of a range, holds a read/catch-up copy (Replica), or holds no copy at all (NoCopy). The role is per-range, not a global node role: the same node can be owner of one range, replica of another, and uninvolved in a third — which is why this is the input to the ownership-aware public-write gate rather than the instance-wide WriteGate.

Trait Implementations

impl Clone for RangeOwnership

fn clone(&self) -> RangeOwnership

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RangeOwnership

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

Formats the value using the given formatter.

impl Eq for RangeOwnership

impl PartialEq for RangeOwnership

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RangeOwnership