Skip to main content

Cursor

Struct Cursor 

Source
pub struct Cursor<A, L> { /* private fields */ }
Expand description

Cursor to track log heights (state vector).

It offers methods to “advance” a log and compute the difference to another state vector. A cursor can be used to manage a state vector over a topic (“log heights” of logs scoped by a topic).

Implementations§

Source§

impl<A, L> Cursor<A, L>
where A: Author, L: LogId,

Source

pub fn new(name: impl AsRef<str>, state: LogHeights<A, L>) -> Self

Source

pub fn name(&self) -> &str

Source

pub fn state(&self) -> &LogHeights<A, L>

Returns state vector.

Source

pub fn log_height(&self, author: &A, log_id: &L) -> Option<&SeqNum>

Returns state vector for a specific log.

Source

pub fn compare(&self, other: &LogHeights<A, L>) -> LogRanges<A, L>

Calculates the difference between two state vectors.

Source

pub fn advance(&mut self, author: A, log_id: L, log_height: SeqNum)

Advances the state of a specific log.

Trait Implementations§

Source§

impl<A: Clone, L: Clone> Clone for Cursor<A, L>

Source§

fn clone(&self) -> Cursor<A, L>

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<A: Debug, L: Debug> Debug for Cursor<A, L>

Source§

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

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

impl<'de, A, L> Deserialize<'de> for Cursor<A, L>
where A: Author, L: LogId,

Source§

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

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

impl<A: Hash, L: Hash> Hash for Cursor<A, L>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<A: Ord, L: Ord> Ord for Cursor<A, L>

Source§

fn cmp(&self, other: &Cursor<A, L>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<A: PartialEq, L: PartialEq> PartialEq for Cursor<A, L>

Source§

fn eq(&self, other: &Cursor<A, L>) -> 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<A: PartialOrd, L: PartialOrd> PartialOrd for Cursor<A, L>

Source§

fn partial_cmp(&self, other: &Cursor<A, L>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<A, L> Serialize for Cursor<A, L>
where A: Author, L: LogId,

Source§

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

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

impl<A: Eq, L: Eq> Eq for Cursor<A, L>

Source§

impl<A, L> StructuralPartialEq for Cursor<A, L>

Auto Trait Implementations§

§

impl<A, L> Freeze for Cursor<A, L>

§

impl<A, L> RefUnwindSafe for Cursor<A, L>

§

impl<A, L> Send for Cursor<A, L>
where A: Send, L: Send,

§

impl<A, L> Sync for Cursor<A, L>
where A: Sync, L: Sync,

§

impl<A, L> Unpin for Cursor<A, L>

§

impl<A, L> UnsafeUnpin for Cursor<A, L>

§

impl<A, L> UnwindSafe for Cursor<A, L>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Extensions for T
where T: Clone + Debug + for<'de> Deserialize<'de> + Serialize,

Source§

impl<T> LogId for T
where T: Clone + Eq + Ord + Hash + Serialize + for<'de> Deserialize<'de>,