Struct ReadOptions 

pub struct ReadOptions {
    pub lower_bound: LowerBound,
    pub upper_bound: UpperBound,
    pub order: Order,
}

Narrows down which events Store::read hands out, or turns around the order it hands them out in. A read has one lower bound, one upper bound, and one order, so options that contradict each other can not be written.

The options are those of a read of EventSourcingDB, which they cover in full, so they are closed on purpose: a new option of the database comes with a new major version of the client SDK, and so of the kit:

use architecturekit::{LowerBound, Order, ReadOptions, Revision};

let next_page = ReadOptions {
    lower_bound: LowerBound::AfterEvent(Revision::from(41)),
    ..ReadOptions::default()
};

let newest_first = ReadOptions {
    order: Order::NewestFirst,
    ..ReadOptions::default()
};

An ID of a bound is a Revision, so it is always the ID of an event, and bounds that leave no room for an event make reading fail with EmptyRange (see check_read_options).

Fields

lower_bound: LowerBound

Where the events start, at the first one unless it says otherwise.

upper_bound: UpperBound

Where the events end, at the last one unless it says otherwise.

order: Order

The order of the events, oldest first unless it says otherwise.

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> Self

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() -> Self

Returns the “default value” for a type.

impl Eq for ReadOptions

impl PartialEq for ReadOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadOptions