Struct persist::client::RuntimeClient[][src]

pub struct RuntimeClient {
    sender: RuntimeCmdSender,
    stopper: Arc<StopRuntimeOnDrop>,
}
Expand description

A clone-able handle to the persistence runtime.

The runtime is stopped when any client calls RuntimeClient::stop or when all clients have been dropped, whichever comes first.

NB: The methods below are executed concurrently. For a some call X to be guaranteed as “previous” to another call Y, X’s future must have been received before Y’s call started (though X’s future doesn’t need to have resolved).

Fields

sender: RuntimeCmdSenderstopper: Arc<StopRuntimeOnDrop>

Implementations

Synchronously registers a new stream for writes and reads.

This method is idempotent. Returns read and write handles used to construct a persisted stream operator.

TODO: This description seems outdated? Or at least only half true. If data was written by a previous RuntimeClient for this id, it’s loaded and replayed into the stream once constructed.

Returns a Description of the stream identified by id_str.

Synchronously closes the runtime, releasing exclusive-writer locks and causing all future commands to error.

This method is idempotent.

Synchronously remove the persisted stream.

This method is idempotent and returns true if the stream was actually destroyed, false if the stream had already been destroyed previously.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Compare self to key and return true if they are equal.

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Upcasts this ProgressEventTimestamp to Any. Read more

Returns the name of the concrete type of this object. Read more

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more