Skip to main content

StoreCommand

Enum StoreCommand 

Source
pub enum StoreCommand<P, E> {
    Persist(E),
    PersistFullEvent {
        event: E,
        snapshot_every: Option<u64>,
    },
    PersistFull {
        event: E,
        actor: P,
        snapshot_every: Option<u64>,
    },
    PersistLight(E, P),
    Snapshot(P),
    Compact,
    LastEvent,
    LastEventNumber,
    LastEventsFrom(u64),
    GetEvents {
        from: u64,
        to: u64,
    },
    Recover,
    Purge,
}
Expand description

Commands processed by the internal Store actor.

Variants§

§

Persist(E)

Persist an event without forcing a snapshot.

§

PersistFullEvent

Persist an event and report whether the caller should snapshot now.

Fields

§event: E

Event to append to the event log.

§snapshot_every: Option<u64>

Snapshot cadence for FullPersistence.

§

PersistFull

Persist an event and snapshot the supplied actor state if required.

Fields

§event: E

Event to append to the event log.

§actor: P

Current actor state, used when a snapshot is triggered.

§snapshot_every: Option<u64>

Snapshot cadence for FullPersistence.

§

PersistLight(E, P)

Persist an event together with a snapshot of the supplied actor state.

§

Snapshot(P)

Snapshot the supplied actor state immediately.

§

Compact

Remove event log entries already covered by the latest snapshot.

§

LastEvent

Return the most recently persisted event.

§

LastEventNumber

Return the next free event index.

§

LastEventsFrom(u64)

Return all events from the supplied event index to the end of the log.

§

GetEvents

Return all events within the inclusive [from, to] range.

Fields

§from: u64
§to: u64
§

Recover

Recover the current actor state from snapshots and events.

§

Purge

Delete all events, snapshots, and metadata for this actor.

Trait Implementations§

Source§

impl<P, E> Clone for StoreCommand<P, E>
where P: Clone, E: Clone,

Source§

fn clone(&self) -> StoreCommand<P, E>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P, E> Debug for StoreCommand<P, E>
where P: Debug, E: Debug,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl<P, E> Message for StoreCommand<P, E>

Source§

fn is_critical(&self) -> bool

Returns true if this message must be processed before the actor stops; defaults to false.

Auto Trait Implementations§

§

impl<P, E> Freeze for StoreCommand<P, E>
where E: Freeze, P: Freeze,

§

impl<P, E> RefUnwindSafe for StoreCommand<P, E>

§

impl<P, E> Send for StoreCommand<P, E>
where E: Send, P: Send,

§

impl<P, E> Sync for StoreCommand<P, E>
where E: Sync, P: Sync,

§

impl<P, E> Unpin for StoreCommand<P, E>
where E: Unpin, P: Unpin,

§

impl<P, E> UnsafeUnpin for StoreCommand<P, E>
where E: UnsafeUnpin, P: UnsafeUnpin,

§

impl<P, E> UnwindSafe for StoreCommand<P, E>
where E: UnwindSafe, P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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