Skip to main content

TailLog

Struct TailLog 

Source
pub struct TailLog<T> { /* private fields */ }
Expand description

An append-only event log with terminal state and parked tail reads.

Implementations§

Source§

impl<T: Clone> TailLog<T>

Source

pub fn new() -> Self

Create an empty, open log.

Source

pub fn push(&self, event: T) -> bool

Append an event and wake parked readers.

Returns false (dropping the event) if the log is already finished.

Source

pub fn finish(&self)

Mark the log finished and wake parked readers. Idempotent.

Source

pub fn is_done(&self) -> bool

Whether the log is finished.

Source

pub fn len(&self) -> u64

Number of events appended so far.

Source

pub fn is_empty(&self) -> bool

Whether no events have been appended.

Source

pub fn snapshot_from(&self, seq: u64) -> TailPage<T>

Non-blocking snapshot of the tail from seq.

Source

pub async fn read_from(&self, seq: u64) -> TailPage<T>

Atomic tail read: park until there are events past seq or the log is finished, then return them together with the terminal status.

Source

pub async fn read_from_cancellable( &self, seq: u64, token: &CancelToken, ) -> Result<TailPage<T>, Cancelled>

TailLog::read_from, cancellable.

Trait Implementations§

Source§

impl<T: Clone> Default for TailLog<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for TailLog<T>

§

impl<T> RefUnwindSafe for TailLog<T>
where Mutex<TailState<T>>: RefUnwindSafe,

§

impl<T> Send for TailLog<T>
where Mutex<TailState<T>>: Send,

§

impl<T> Sync for TailLog<T>
where Mutex<TailState<T>>: Sync,

§

impl<T> Unpin for TailLog<T>
where Mutex<TailState<T>>: Unpin,

§

impl<T> UnsafeUnpin for TailLog<T>
where Mutex<TailState<T>>: UnsafeUnpin,

§

impl<T> UnwindSafe for TailLog<T>
where Mutex<TailState<T>>: 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> 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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.