Skip to main content

SegmentCursor

Struct SegmentCursor 

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

Segment-aware pagination cursor.

Two forms exist, with different stability properties:

  • Archive cursor (archive:<seq>:<off>): identifies a position in a numbered archive. The sequence number is written into the archive name at rotation time, and a best-effort sidecar preserves the high-water mark across normal restarts. If that sidecar cannot be written, retention removes every numbered archive, and the daemon then restarts, a sequence can be reused and an outstanding cursor can bind to newer history. If the segment has been deleted without sequence reuse, the reader returns an empty page with at_end = true rather than silently jumping elsewhere.

  • Active cursor (active:<off>:<anchor_id>): identifies a position in the current active file. Because the active file’s path is stable but its content is replaced on each rotation, an anchor event id is carried alongside the offset. If the active file no longer contains that event, the reader searches all open segments for the anchor; if found it resumes from that position, if not it returns at_end = true.

A legacy two-field form (<seg_basename>:<off>) from older daemons is also accepted on input. It is ambiguous by construction, naming either a legacy archive or the active file, so it is resolved against the archives first (an archive name is never reassigned) and then the active file.

The token is opaque to clients: round-trip it verbatim as ?until_segment_cursor=. Constructing or modifying it is unsupported.

Implementations§

Source§

impl SegmentCursor

Source

pub fn from_wire(s: &str) -> Option<Self>

Parse from one of four wire forms:

  • active:<off>:<anchor_id> — active cursor with anchor
  • active:<off> — active cursor without anchor (legacy active)
  • archive:<seq>:<off> — numbered archive cursor
  • <basename>:<off> — pre-sequence form, ambiguous by construction: an older daemon issued it for the active file, and it is also how a legacy archive is addressed. Parsing cannot tell them apart, so the ambiguity is carried to resolve_cursor, which tries the archives first and falls back to the active file.

Returns None on any parse error.

Source

pub fn to_wire(&self) -> String

Serialize to wire format.

Trait Implementations§

Source§

impl Clone for SegmentCursor

Source§

fn clone(&self) -> SegmentCursor

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SegmentCursor

Source§

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

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

impl Eq for SegmentCursor

Source§

impl PartialEq for SegmentCursor

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SegmentCursor

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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