Skip to main content

AckTicket

Struct AckTicket 

Source
pub struct AckTicket { /* private fields */ }
Expand description

Durability handle associated with the write operation

§Epoch

Every ticket is assigned a monotonically increasing epoch to moniter durability

§Durability Guarantee

If wanted, the ticket could be awaited to poll till the epoch becomes durable.

Once a await on ticket is completed successfully, all writes assigned to earlier epochs are also guaranteed to be durable.

NOTE: Using await is optional. Callers that only require fire-and-forget semantics may simply discard the returned ticket.

Implementations§

Source§

impl AckTicket

Source

pub const fn new(epoch: TEpoch, completion: Arc<Completion>) -> Self

Construct a new AckTicket for a write operation

§Example
use frozen_core::ack::{AckTicket, Completion};
use std::sync::Arc;

let completion = Arc::new(Completion::default());
let ticket = AckTicket::new(1, completion);

assert_eq!(ticket.epoch(), 1);
Source

pub const fn epoch(&self) -> TEpoch

Read assigned durability epoch for the AckTicket

§Example
use frozen_core::ack::{AckTicket, Completion};
use std::sync::Arc;

let completion = Arc::new(Completion::default());
let ticket = AckTicket::new(0x4C, completion);

assert_eq!(ticket.epoch(), 0x4C);

Trait Implementations§

Source§

impl Debug for AckTicket

Source§

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

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

impl Future for AckTicket

Source§

type Output = Result<u64, FrozenError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. 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.