Skip to main content

MoveRange

Struct MoveRange 

Source
pub struct MoveRange { /* private fields */ }
Expand description

One in-flight move-range: the bookkeeping that carries authority for one range from its current owner to a target without losing a write or letting the target serve early.

Built with begin, which enlists the target as a replica and captures the catalog CAS (owner / epoch / version) the cutover will use. The snapshot point and the target’s catch-up progress are filled in as the move runs. Until cut_over succeeds the catalog is unchanged, so the old owner keeps serving and the target — a mere replica — cannot.

Implementations§

Source§

impl MoveRange

Source

pub fn begin( catalog: &mut ShardOwnershipCatalog, collection: CollectionId, range_id: RangeId, target: NodeIdentity, ) -> Result<MoveRange, MoveError>

Start moving (collection, range_id) to target. Enlists target as a replica of the range if it is not one already (so the cutover has a valid promotion candidate), then captures the catalog CAS for the eventual fenced handoff. The move begins in CopyingSnapshot; the catalog’s owner is unchanged, so the old owner keeps serving writes.

Fails if the range is unknown or target is already its owner (a move to the incumbent is a no-op).

Source

pub fn phase(&self) -> MovePhase

Source

pub fn source(&self) -> &NodeIdentity

Source

pub fn target(&self) -> &NodeIdentity

Source

pub fn snapshot_watermark(&self) -> Option<CommitWatermark>

The consistent point the physical snapshot was taken at, once installed.

Source

pub fn position(&self) -> Option<RangeStreamPosition>

The target’s catch-up position over the range-indexed WAL, once catch-up has begun.

Source

pub fn complete_snapshot( &mut self, at: CommitWatermark, ) -> Result<(), MoveError>

Record that the target has installed a consistent physical snapshot taken at at. Moves the move into CatchingUp and seeds the catch-up position from the snapshot point: the target has applied everything up to at and will accept range records ahead of it, fencing any stamped below the range’s current ownership epoch.

Only valid while copying the snapshot.

Source

pub fn record_catch_up( &mut self, records: &[ChangeRecord], ) -> Result<RangeCatchupPlan, MoveError>

Replay a slice of the shared logical stream into the target’s range-indexed catch-up, advancing its applied position past every record stamped for this range (issue #992). Returns the RangeCatchupPlan so the caller can see which records applied and which were fenced. Only valid while catching up.

Source

pub fn catch_up_evidence(&self) -> Option<CatchUpEvidence>

The catch-up evidence the cutover will present for the target: the highest (term, lsn) it has applied for the range. None before a snapshot is installed.

Source

pub fn has_caught_up(&self, live: CommitWatermark) -> bool

Whether the target’s applied log covers live — the live range commit watermark, which has advanced past the snapshot point as the old owner kept writing. The cutover may only proceed once this holds.

Source

pub fn cut_over( &mut self, catalog: &mut ShardOwnershipCatalog, live: CommitWatermark, ) -> Result<TransitionOutcome, MoveError>

Cut over: move the catalog epoch to the target through the fenced Handoff transition, demoting the old owner to a replica. The move must be CatchingUp and the target must cover live — otherwise this returns TargetBehindWatermark without touching the catalog, so a target that has not caught up is never promoted and the old owner keeps serving.

On success the catalog names the target at a new epoch (fencing the old owner’s stale-epoch writes) and the move is Completed.

Source

pub fn abort(&mut self)

Abandon the move. The catalog is untouched (the old owner remains owner); the target keeps whatever copy it has but is never promoted.

Trait Implementations§

Source§

impl Clone for MoveRange

Source§

fn clone(&self) -> MoveRange

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MoveRange

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MoveRange

Source§

impl PartialEq for MoveRange

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for MoveRange

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more