Struct grenad::Writer

source ·
pub struct Writer<W> { /* private fields */ }
Expand description

A struct you can use to write entries into any io::Write type, entries must be inserted in key-order.

Implementations§

source§

impl Writer<Vec<u8>>

source

pub fn memory() -> Writer<Vec<u8>>

Creates a Writer that will write into a Vec of bytes.

source§

impl Writer<()>

source

pub fn builder() -> WriterBuilder

Creates a WriterBuilder, it can be used to configure your Writer.

source§

impl<W: Write> Writer<W>

source

pub fn as_ref(&self) -> &W

Gets a reference to the underlying writer.

source§

impl<W: Write> Writer<W>

source

pub fn new(writer: W) -> Writer<W>

Creates a Writer that will write into the provided io::Write type.

source

pub fn insert<A, B>(&mut self, key: A, val: B) -> Result<()>where A: AsRef<[u8]>, B: AsRef<[u8]>,

Writes the provided entry into the underlying io::Write type, key-values must be given in key-order.

source

pub fn finish(self) -> Result<()>

Consumes this Writer and write the latest block currently being built.

You must call this method before using the underlying io::Write type.

source

pub fn into_inner(self) -> Result<W>

Consumes this Writer and write the latest block currenty being built.

Returns the underlying io::Write provided type.

Auto Trait Implementations§

§

impl<W> RefUnwindSafe for Writer<W>where W: RefUnwindSafe,

§

impl<W> Send for Writer<W>where W: Send,

§

impl<W> Sync for Writer<W>where W: Sync,

§

impl<W> Unpin for Writer<W>where W: Unpin,

§

impl<W> UnwindSafe for Writer<W>where W: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.