Skip to main content

Watermark

Struct Watermark 

pub struct Watermark { /* private fields */ }
Expand description

A per-store high-water mark: the last position this side has seen from each origin store it knows about.

A version vector rather than a scalar, and that is a constraint the port imposes rather than a convenience. A hub sees many logs and a spoke sees one; a scalar watermark can express the spoke and cannot express the hub, so a scalar would make hub-and-spoke a special case of peer-to-peer when the specification requires both to be first-class (SY-10).

Kept sorted by StoreId so that two watermarks compare and serialise canonically.

Implementations§

§

impl Watermark

pub const fn new() -> Self

An empty watermark: nothing seen from anybody.

pub fn get(&self, store: StoreId) -> Option<SequencePosition>

The last position seen from store, if any.

pub fn advance(&mut self, store: StoreId, position: SequencePosition)

Raises the mark for store to position, if that is an advance.

Monotonic on purpose: a watermark that can go backwards turns a re-delivered batch into a replay of everything after it.

pub fn iter(&self) -> impl Iterator<Item = (StoreId, SequencePosition)> + '_

Every mark, ascending by StoreId.

pub fn len(&self) -> usize

How many stores this watermark knows about.

pub fn is_empty(&self) -> bool

Whether nothing has been seen from anybody.

Trait Implementations§

§

impl Clone for Watermark

§

fn clone(&self) -> Self

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
§

impl Debug for Watermark

§

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

Formats the value using the given formatter. Read more
§

impl Default for Watermark

§

fn default() -> Self

Returns the “default value” for a type. Read more
§

impl<'de> Deserialize<'de> for Watermark

Re-canonicalises on the way in (WF-10): an unsorted sequence decodes sorted, and two marks for one store keep the higher — the watermark Watermark::advance would build from the same pairs.

Sorted once and folded in one pass, not advanced pair by pair: advance inserts into a sorted vector, so a peer’s descending sequence would shift every mark on every insert, quadratic in the length of input it chose.

A derive straight onto marks is the wrong implementation this replaces. It would hand a peer’s unsorted vector to Watermark::get, whose binary search then misses marks that are there, and the runner re-sends what the far side already holds.

§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
§

impl Eq for Watermark

§

impl PartialEq for Watermark

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl Serialize for Watermark

On the wire, a sequence of (store, position) pairs in ascending store order. Hand-written rather than derived, and only for decoding’s sake.

§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
§

impl StructuralPartialEq for Watermark

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<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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.