Struct ReadOptions 

pub struct ReadOptions {
    pub follow: FollowOption,
    pub new: bool,
    pub after: Option<Scru128Id>,
    pub from: Option<Scru128Id>,
    pub limit: Option<usize>,
    pub last: Option<usize>,
    pub topic: Option<String>,
}

Options controlling a Store::read or Store::read_sync call.

Defaults replay every stored frame once, oldest first, then stop. Build a query with the bon builder:

use xs::{ReadOptions, FollowOption};

// Replay history for one topic, then keep streaming new appends.
let opts = ReadOptions::builder()
    .topic("clip.*".to_string())
    .follow(FollowOption::On)
    .build();

Fields

follow: FollowOption

Whether to keep streaming live appends after history is replayed. Defaults to FollowOption::Off.

new: bool

Skip historical frames and emit only appends made after the read starts.

after: Option<Scru128Id>

Start after this ID (exclusive).

from: Option<Scru128Id>

Start from this ID (inclusive).

limit: Option<usize>

Stop after emitting this many historical frames.

last: Option<usize>

Return the last N frames (most recent), in chronological order.

topic: Option<String>

Restrict to one or more topic patterns, comma-separated. Each pattern is an exact name, a prefix.* wildcard, or * for all, e.g. clip.add or game.move.*,game.create. Commas are a safe separator because validate_topic forbids them in topic names.

Implementations

impl ReadOptions

pub fn builder() -> ReadOptionsBuilder

Create an instance of ReadOptions using the builder syntax

impl ReadOptions

pub fn from_query(query: Option<&str>) -> Result<Self, Error>

Parse options from a URL query string (the form used by the HTTP API), for example follow=true&topic=clip.*&last=10. None yields the defaults.

pub fn to_query_string(&self) -> String

Render these options back into a URL query string, the inverse of from_query. Returns an empty string when no options are set.

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> ReadOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadOptions

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

Formats the value using the given formatter.

impl Default for ReadOptions

fn default() -> ReadOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReadOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReadOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReadOptions