Skip to main content

StreamCursor

Struct StreamCursor 

Source
pub struct StreamCursor(pub Bytes);
Expand description

Opaque, backend-versioned cursor. Consumers persist the bytes, hand them back on resume. The first byte MUST encode a backend-family + version prefix so cursors stay stable across backend upgrades (Valkey: 0x01, Postgres: 0x02, …). The remainder is backend- specific.

StreamCursor::empty is the “start from tail / now” sentinel every backend accepts. Cursor byte order is owner-adjudicated opaque — consumers MUST NOT parse the bytes.

Tuple Fields§

§0: Bytes

Implementations§

Source§

impl StreamCursor

Source

pub fn new(raw: impl Into<Bytes>) -> Self

Wrap arbitrary cursor bytes — typically only called by backend impls that just encoded a fresh cursor from a backend-native position (Valkey stream id, Postgres event_id).

Source

pub fn as_bytes(&self) -> &[u8]

Borrow the raw cursor bytes for persistence. Consumers treat the slice as opaque.

Source

pub fn empty() -> Self

Sentinel “start from tail” cursor. Backends interpret an empty cursor as “subscribe from now” (Valkey: XREAD $; Postgres: LISTEN from the current max(event_id)).

Trait Implementations§

Source§

impl Clone for StreamCursor

Source§

fn clone(&self) -> StreamCursor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamCursor

Source§

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

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

impl PartialEq for StreamCursor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for StreamCursor

Source§

impl StructuralPartialEq for StreamCursor

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