Struct eventstore::commands::ReadAllEvents

pub struct ReadAllEvents { /* fields omitted */ }

Like ReadStreamEvents but specialized to system stream '$all'.

Methods

impl ReadAllEvents

pub fn forward(self) -> Self

Asks the command to read forward (toward the end of the stream). That's the default behavior.

pub fn backward(self) -> Self

Asks the command to read backward (toward the begining of the stream).

pub fn credentials(self, value: Credentials) -> Self

Performs the command with the given credentials.

pub fn max_count(self, max_count: i32) -> Self

Max batch size.

pub fn start_from(self, start: Position) -> Self

Starts the read ot the given event number. By default, it starts at types::Position::start.

pub fn start_from_beginning(self) -> Self

Starts the read from the beginning of the stream. It also set the read direction to Forward.

pub fn start_from_end_of_stream(self) -> Self

Starts the read from the end of the stream. It also set the read direction to Backward.

pub fn require_master(self, require_master: bool) -> Self

Asks the server receiving the command to be the master of the cluster in order to perform the write. Default: false.

pub fn resolve_link_tos(self, tos: LinkTos) -> Self

When using projections, you can have links placed into another stream. If you set true, the server will resolve those links and will return the event that the link points to. Default: NoResolution.

pub async fn execute(self) -> Result<ReadStreamStatus<AllSlice>, OperationError>

Sends asynchronously the read command to the server.

pub fn iterate_over_batch(
    self
) -> Pin<Box<dyn Stream<Item = Result<Vec<ResolvedEvent>, OperationError>> + Send>>

Returns a Stream that consumes $all stream entirely. For example, if the direction is Forward, it ends when the last stream event is reached. However, if the direction is Backward, the iterator ends when the first event is reached. All the configuration is pass to the iterator (link resolution, require master, starting point, batch size, …etc). Each element corresponds to a page with a length <= max_count.

pub fn iterate_over(
    self
) -> impl Stream<Item = Result<ResolvedEvent, OperationError>> + Send + Unpin

Returns a Stream that consumes a stream entirely. For example, if the direction is Forward, it ends when the last stream event is reached. However, if the direction is Backward, the iterator ends when the first event is reached. All the configuration is pass to the iterator (link resolution, require master, starting point, batch size, …etc).