Struct eventstore::Client

pub struct Client { /* fields omitted */ }

Represents a client to a single node. Client maintains a full duplex communication to EventStoreDB.

Many threads can use an EventStoreDB client at the same time or a single thread can make many asynchronous requests.

Implementations

impl Client

pub async fn create(settings: ClientSettings) -> Result<Self, Box<dyn Error>>

Creates a gRPC client to an EventStoreDB database.

pub fn write_events<S>(&self, stream: S) -> WriteEvents where
    S: AsRef<str>, 

Sends events to a given stream.

pub fn read_stream<S>(&self, stream: S) -> ReadStreamEvents where
    S: AsRef<str>, 

Reads events from a given stream. The reading can be done forward and backward.

pub fn read_all(&self) -> ReadAllEvents

Reads events for the system stream $all. The reading can be done forward and backward.

pub fn delete_stream<S>(&self, stream: S) -> DeleteStream where
    S: AsRef<str>, 

Deletes a given stream. By default, the server performs a soft delete, More information can be found on the [Deleting streams and events] page.

pub fn subscribe_to_stream_from<S>(&self, stream: S) -> RegularCatchupSubscribe where
    S: AsRef<str>, 

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.

pub fn subscribe_to_all_from(&self) -> AllCatchupSubscribe

Like subscribe_to_stream_from but specific to system $all stream.

pub fn create_persistent_subscription<S>(
    &self,
    stream_id: S,
    group_name: S
) -> CreatePersistentSubscription where
    S: AsRef<str>, 

Creates a persistent subscription group on a stream.

Persistent subscriptions are special kind of subscription where the server remembers the state of the subscription. This allows for many different modes of operations compared to a regular or catchup subscription where the client holds the subscription state.

pub fn update_persistent_subscription<S>(
    &self,
    stream_id: S,
    group_name: S
) -> UpdatePersistentSubscription where
    S: AsRef<str>, 

Updates a persistent subscription group on a stream.

pub fn delete_persistent_subscription<S>(
    &self,
    stream_id: S,
    group_name: S
) -> DeletePersistentSubscription where
    S: AsRef<str>, 

Deletes a persistent subscription group on a stream.

pub fn connect_persistent_subscription<S>(
    &self,
    stream_id: S,
    group_name: S
) -> ConnectToPersistentSubscription where
    S: AsRef<str>, 

Connects to a persistent subscription group on a stream.

Trait Implementations

impl Clone for Client

pub fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.