Struct eventstore::commands::DeleteStream

pub struct DeleteStream<'a> { /* fields omitted */ }

Command that deletes a stream. More information on Deleting stream and events.

Methods

impl<'a> DeleteStream<'a>

pub fn require_master(self, require_master: bool) -> DeleteStream<'a>

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

pub fn expected_version(self, version: ExpectedVersion) -> DeleteStream<'a>

Asks the server to check that the stream receiving the event is at the given expected version. Default: types::ExpectedVersion::Any.

pub fn credentials(self, value: Credentials) -> DeleteStream<'a>

Performs the command with the given credentials.

pub fn soft_delete(self) -> DeleteStream<'a>

Makes use of Truncate before. When a stream is deleted, its Truncate before is set to the streams current last event number. When a soft deleted stream is read, the read will return a StreamNotFound. After deleting the stream, you are able to write to it again, continuing from where it left off.

That is the default behavior.

pub fn hard_delete(self) -> DeleteStream<'a>

A hard delete writes a tombstone event to the stream, permanently deleting it. The stream cannot be recreated or written to again. Tombstone events are written with the event type '$streamDeleted'. When a hard deleted stream is read, the read will return a StreamDeleted.

pub fn execute(     self ) -> impl Future<Item = Position, Error = OperationError>

Sends asynchronously the delete command to the server.