Skip to main content

SectionWriter

Struct SectionWriter 

pub struct SectionWriter { /* private fields */ }
Expand description

One shard’s side of a shared log: assigns the shard’s LSNs and encodes its records, once, into the section its next batch carries. Pure.

Implementations§

§

impl SectionWriter

pub fn new(next_lsn: Lsn) -> Self

The shard’s next record will be next_lsn.

pub fn next_lsn(&self) -> Lsn

pub fn last_lsn(&self) -> Lsn

pub fn has_pending(&self) -> bool

pub fn append<S: AsRef<str>, B: AsRef<[u8]>>( &mut self, rec: &Record<S, B>, ) -> Result<Lsn, TooLarge>

Appends one record and returns its LSN.

pub fn last_encoded(&self) -> &[u8] ⓘ

The canonical encoding of the record most recently appended (empty once its section was taken).

pub fn discard(&mut self) -> Option<(u32, u64, Lsn)>

Forgets the records appended since the last call, keeping the buffer, for storage that holds nothing (memory mode): their count, bytes and last LSN.

pub fn take(&mut self) -> Option<Batch>

Takes every record not taken yet as one section.

pub fn take_up_to(&mut self, max: usize) -> Option<Batch>

Takes the oldest records not taken yet as one section of at most max bytes (one record at least); the rest stay for the next call. When everything fits, which is every call of a shard that keeps up, the section is the writer’s buffer itself: nothing is copied.

Trait Implementations§

§

impl Clone for SectionWriter

§

fn clone(&self) -> SectionWriter

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
§

impl Debug for SectionWriter

§

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

Formats the value using the given formatter. 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> 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, 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> 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.