Trait CollationKeySink 

pub trait CollationKeySink {
    type Error;
    type State;
    type Output;

    // Required methods
    fn write(
        &mut self,
        state: &mut Self::State,
        buf: &[u8],
    ) -> Result<(), Self::Error>;
    fn finish(
        &mut self,
        state: Self::State,
    ) -> Result<Self::Output, Self::Error>;

    // Provided method
    fn write_byte(
        &mut self,
        state: &mut Self::State,
        b: u8,
    ) -> Result<(), Self::Error> { ... }
}

A std::io::Write-like trait for writing to a buffer-like object.

(This crate does not have access to std.)

🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways, including in SemVer minor releases. Do not implement or call methods on this trait unless you are prepared for things to occasionally break.

Graduation tracking issue: issue #7178.

✨ Enabled with the unstable Cargo feature.

Required Associated Types

type Error

The type of error the sink may return.

type State

An intermediate state object used by the sink, which must implement Default.

type Output

A result value indicating the final state of the sink (e.g. a number of bytes written).

Required Methods

fn write( &mut self, state: &mut Self::State, buf: &[u8], ) -> Result<(), Self::Error>

Writes a buffer into the writer.

fn finish(&mut self, state: Self::State) -> Result<Self::Output, Self::Error>

Finalize any internal sink state (perhaps by flushing a buffer) and return the final output value.

Provided Methods

fn write_byte( &mut self, state: &mut Self::State, b: u8, ) -> Result<(), Self::Error>

Write a single byte into the writer.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl CollationKeySink for Vec<u8>

type Error = Infallible

type State = ()

type Output = ()

fn write(&mut self, _: &mut Self::State, buf: &[u8]) -> Result<(), Self::Error>

fn finish(&mut self, _: Self::State) -> Result<Self::Output, Self::Error>

impl CollationKeySink for VecDeque<u8>

type Error = Infallible

type State = ()

type Output = ()

fn write(&mut self, _: &mut Self::State, buf: &[u8]) -> Result<(), Self::Error>

fn finish(&mut self, _: Self::State) -> Result<Self::Output, Self::Error>

impl CollationKeySink for [u8]

type Error = TooSmall

type State = usize

type Output = usize

fn write( &mut self, offset: &mut Self::State, buf: &[u8], ) -> Result<(), Self::Error>

fn finish(&mut self, offset: Self::State) -> Result<Self::Output, Self::Error>

impl<const N: usize> CollationKeySink for SmallVec<[u8; N]>

type Error = Infallible

type State = ()

type Output = ()

fn write(&mut self, _: &mut Self::State, buf: &[u8]) -> Result<(), Self::Error>

fn finish(&mut self, _: Self::State) -> Result<Self::Output, Self::Error>

Implementors