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>
impl<R: Read> FrameEncoder<R>
sourcepub fn new(rdr: R) -> FrameEncoder<R> ⓘ
pub fn new(rdr: R) -> FrameEncoder<R> ⓘ
Create a new reader for streaming Snappy compression.
Trait Implementations§
source§impl<R: Read> Read for FrameEncoder<R>
impl<R: Read> Read for FrameEncoder<R>
source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
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>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
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 more1.0.0 · source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
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 more1.6.0 · source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Reads the exact number of bytes required to fill
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
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>
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 more1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moreAuto 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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more