Struct snap::read::FrameDecoder
source · pub struct FrameDecoder<R: Read> { /* private fields */ }
Expand description
A reader for decompressing a Snappy stream.
This FrameDecoder
wraps any other reader that implements std::io::Read
.
Bytes read from this reader are decompressed using the
Snappy frame format
(file extension sz
, MIME type application/x-snappy-framed
).
This reader can potentially make many small reads from the underlying stream depending on its format, therefore, passing in a buffered reader may be beneficial.
Implementations
sourceimpl<R: Read> FrameDecoder<R>
impl<R: Read> FrameDecoder<R>
sourcepub fn new(rdr: R) -> FrameDecoder<R> ⓘ
pub fn new(rdr: R) -> FrameDecoder<R> ⓘ
Create a new reader for streaming Snappy decompression.
sourcepub fn get_mut(&mut self) -> &mut R
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 decoder is continued to be used.
sourcepub fn into_inner(self) -> R
pub fn into_inner(self) -> R
Gets the underlying reader of this decoder.
Trait Implementations
sourceimpl<R: Debug + Read> Debug for FrameDecoder<R>
impl<R: Debug + Read> Debug for FrameDecoder<R>
sourceimpl<R: Read> Read for FrameDecoder<R>
impl<R: Read> Read for FrameDecoder<R>
sourcefn 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 · sourcefn 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 moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
Read all bytes until EOF in this source, placing them into
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill
buf
. Read moresourcefn 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
sourcefn 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
)Read the exact number of bytes required to fill
cursor
. Read more1.0.0 · sourcefn 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> RefUnwindSafe for FrameDecoder<R>where
R: RefUnwindSafe,
impl<R> Send for FrameDecoder<R>where
R: Send,
impl<R> Sync for FrameDecoder<R>where
R: Sync,
impl<R> Unpin for FrameDecoder<R>where
R: Unpin,
impl<R> UnwindSafe for FrameDecoder<R>where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more