Struct snap::read::FrameEncoder

source ·
pub struct FrameEncoder<R: Read> { /* private fields */ }
Expand description

A reader for compressing data using snappy as it is read.

This FrameEncoder wraps any other reader that implements std::io::Read. Bytes read from this reader are compressed using the Snappy frame format (file extension sz, MIME type application/x-snappy-framed).

Usually you’ll want read::FrameDecoder (for decompressing while reading) or write::FrameEncoder (for compressing while writing) instead.

Unlike FrameDecoder, this will attempt to make large reads roughly equivalent to the size of a single Snappy block. Therefore, callers may not benefit from using a buffered reader.

Implementations§

source§

impl<R: Read> FrameEncoder<R>

source

pub fn new(rdr: R) -> FrameEncoder<R>

Create a new reader for streaming Snappy compression.

source

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader in this decoder.

source

pub fn get_mut(&mut self) -> &mut R

Gets a mutable reference to the underlying reader in this decoder.

Note that mutation of the stream may result in surprising results if this encoder is continued to be used.

Trait Implementations§

source§

impl<R: Debug + Read> Debug for FrameEncoder<R>

source§

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

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

impl<R: Read> Read for FrameEncoder<R>

source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf. Read more
source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations§

§

impl<R> Freeze for FrameEncoder<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for FrameEncoder<R>
where R: RefUnwindSafe,

§

impl<R> Send for FrameEncoder<R>
where R: Send,

§

impl<R> Sync for FrameEncoder<R>
where R: Sync,

§

impl<R> Unpin for FrameEncoder<R>
where R: Unpin,

§

impl<R> UnwindSafe for FrameEncoder<R>
where R: 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>,

§

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>,

§

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.