[−][src]Struct eventstore::commands::ReadStreamEvents
A command that reads several events from a stream. It can read events forward or backward.
Methods
impl<'a> ReadStreamEvents<'a>
[src]
pub fn forward(self) -> ReadStreamEvents<'a>
[src]
Asks the command to read forward (toward the end of the stream). That's the default behavior.
pub fn backward(self) -> ReadStreamEvents<'a>
[src]
Asks the command to read backward (toward the begining of the stream).
pub fn credentials(self, value: Credentials) -> ReadStreamEvents<'a>
[src]
Performs the command with the given credentials.
pub fn max_count(self, max_count: i32) -> ReadStreamEvents<'a>
[src]
Max batch size.
pub fn start_from(self, start: i64) -> ReadStreamEvents<'a>
[src]
Starts the read at the given event number. By default, it starts at 0.
pub fn start_from_beginning(self) -> ReadStreamEvents<'a>
[src]
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) -> ReadStreamEvents<'a>
[src]
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) -> ReadStreamEvents<'a>
[src]
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) -> ReadStreamEvents<'a>
[src]
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 fn execute(
self
) -> impl Future<Item = ReadStreamStatus<StreamSlice>, Error = OperationError>
[src]
self
) -> impl Future<Item = ReadStreamStatus<StreamSlice>, Error = OperationError>
Sends asynchronously the read command to the server.
pub fn iterate_over_batch(
self
) -> impl Stream<Item = Vec<ResolvedEvent>, Error = OperationError> + 'a
[src]
self
) -> impl Stream<Item = Vec<ResolvedEvent>, Error = OperationError> + 'a
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). Each
element corresponds to a page with a length <= max_count
.
pub fn iterate_over(
self
) -> impl Stream<Item = ResolvedEvent, Error = OperationError> + 'a
[src]
self
) -> impl Stream<Item = ResolvedEvent, Error = OperationError> + 'a
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).
Auto Trait Implementations
impl<'a> !RefUnwindSafe for ReadStreamEvents<'a>
impl<'a> Send for ReadStreamEvents<'a>
impl<'a> Sync for ReadStreamEvents<'a>
impl<'a> Unpin for ReadStreamEvents<'a>
impl<'a> !UnwindSafe for ReadStreamEvents<'a>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,