Skip to main content

FeedPosition

Struct FeedPosition 

Source
#[non_exhaustive]
pub struct FeedPosition { pub generation: u64, pub offset: u64, }
Expand description

A point in a feed: an offset within one generation’s offset history.

The pair is the whole identity — an offset means nothing outside its generation, so the two travel together: a feed cursor, the tail a consumer resumes at, the position a replica claims at handshake, the cursor a snapshot records. FeedPosition::default() is generation 0, offset 0: the “no continuity claim” a fresh replica presents (no real feed ever runs at generation 0).

use kevy_replicate::feed::FeedPosition;

let at = FeedPosition::new(7, 42);
assert_eq!((at.generation, at.offset), (7, 42));
assert_eq!(FeedPosition::default(), FeedPosition::new(0, 0));

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§generation: u64

The offset history this position belongs to: an opaque identity, see fresh_generation. 0 = unknown.

use kevy_replicate::feed::FeedSource;
use kevy_replicate::source::ReplicationSource;

let feed = FeedSource::new(9, ReplicationSource::new(1 << 20));
assert_eq!(feed.tail().generation, 9);
§offset: u64

The offset within that history.

use kevy_replicate::feed::FeedSource;
use kevy_replicate::source::ReplicationSource;

let mut feed = FeedSource::new(1, ReplicationSource::new(1 << 20));
let set = kevy_resp::Argv::from(vec![b"SET".to_vec(), b"k".to_vec(), b"v".to_vec()]);
feed.source_mut().push_mutation(&set);
assert_eq!(feed.tail().offset, 1); // the next write lands at offset 1

Implementations§

Source§

impl FeedPosition

Source

pub const fn new(generation: u64, offset: u64) -> FeedPosition

The position at offset in generation.

let at = kevy_replicate::feed::FeedPosition::new(3, 0);
assert_eq!(at.generation, 3);

Trait Implementations§

Source§

impl Clone for FeedPosition

Source§

fn clone(&self) -> FeedPosition

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 Copy for FeedPosition

Source§

impl Debug for FeedPosition

Source§

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

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

impl Default for FeedPosition

Source§

fn default() -> FeedPosition

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

impl Eq for FeedPosition

Source§

impl Hash for FeedPosition

Source§

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

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 PartialEq for FeedPosition

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FeedPosition

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> 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.