Skip to main content

AppendRequest

Struct AppendRequest

pub struct AppendRequest<B> {
    pub branch: BranchId,
    pub stream: StreamName,
    pub expected: ExpectedRevision,
    pub idempotency_key: Option<IdempotencyKey>,
    pub events: Vec<NewEvent<B>>,
    pub durability: Durability,
}

Expand description

One append command: a batch of events for a single stream, appended atomically (all-or-nothing) under an optimistic-concurrency expectation and a durability level.

Fields§

§branch: BranchId

Branch to append to.

§stream: StreamName

Target stream within the branch.

§expected: ExpectedRevision

Optimistic-concurrency expectation validated before any write.

§idempotency_key: Option<IdempotencyKey>

Optional key making a retry of this command idempotent.

§events: Vec<NewEvent<B>>

The events, in order; must be non-empty and at most AppendRequest::MAX_EVENTS.

§durability: Durability

Durability level to satisfy before returning the receipt.

Implementations§

impl<B> AppendRequest<B>

pub const MAX_EVENTS: usize = 4096

Maximum number of events in a single batch.

pub fn validate(&self) -> Result<()>

Checks the batch is non-empty and within Self::MAX_EVENTS.

Trait Implementations§

impl<B: Clone> Clone for AppendRequest<B>

fn clone(&self) -> AppendRequest<B>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<B: Debug> Debug for AppendRequest<B>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<B> Freeze for AppendRequest<B>

impl<B> RefUnwindSafe for AppendRequest<B>
where B: RefUnwindSafe,

impl<B> Send for AppendRequest<B>
where B: Send,

impl<B> Sync for AppendRequest<B>
where B: Sync,

impl<B> Unpin for AppendRequest<B>
where B: Unpin,

impl<B> UnsafeUnpin for AppendRequest<B>

impl<B> UnwindSafe for AppendRequest<B>
where B: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.