Struct eventstore::RegularCatchupSubscribe

pub struct RegularCatchupSubscribe { /* fields omitted */ }

Subscribes to a given stream. This kind of subscription specifies a starting point (by default, the beginning of a stream). For a regular stream, that starting point will be an event number. For the system stream $all, it will be a position in the transaction file (see subscribe_to_all_from). This subscription will fetch every event until the end of the stream, then will dispatch subsequently written events.

For example, if a starting point of 50 is specified when a stream has 100 events in it, the subscriber can expect to see events 51 through 100, and then any events subsequenttly written events until such time as the subscription is dropped or closed.

• Notes Catchup subscription are resilient to connection drops. Basically, if the connection drops. The command will restart its catching up phase from the begining and then emit a new volatile subscription request.

All this process happens without the user has to do anything.

Implementations

impl RegularCatchupSubscribe

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 fn start_position(self, start_pos: u64) -> Self

For example, if a starting point of 50 is specified when a stream has 100 events in it, the subscriber can expect to see events 51 through 100, and then any events subsequently written events until such time as the subscription is dropped or closed.

By default, it will start from the event number 0.

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

Performs the command with the given credentials.

pub async fn execute(
    self
) -> Result<Box<dyn Stream<Item = Result<SubEvent>> + Send + Unpin>>

Runs the subscription command.

pub async fn execute_event_appeared_only(
    self
) -> Result<Box<dyn Stream<Item = Result<ResolvedEvent>> + Send + Unpin>>

Runs the subscription command. Filter out all subscription events that are not SubEvent::EventAppeared.