Expand description
An incremental decoder, which reads and verifies the output of
Encoder
.
Decoder
supports both the combined and outboard encoding format,
depending on which constructor you use.
Decoder
supports
std::io::Seek
if the
underlying reader does, but it’s also compatible with non-seekable readers.
Example
use std::io::prelude::*;
// Create both combined and outboard encodings.
let input = b"some input";
let (encoded, hash) = bao::encode::encode(input);
let (outboard, _) = bao::encode::outboard(input);
// Decode the combined mode.
let mut combined_output = Vec::new();
let mut decoder = bao::decode::Decoder::new(&*encoded, &hash);
decoder.read_to_end(&mut combined_output)?;
// Decode the outboard mode.
let mut outboard_output = Vec::new();
let mut decoder = bao::decode::Decoder::new_outboard(&input[..], &*outboard, &hash);
decoder.read_to_end(&mut outboard_output)?;
assert_eq!(input, &*combined_output);
assert_eq!(input, &*outboard_output);
Implementations
Trait Implementations
sourceimpl<T: Read, O: Read> Read for Decoder<T, O>
impl<T: Read, O: Read> Read for Decoder<T, O>
sourcefn read(&mut self, output: &mut [u8]) -> Result<usize>
fn read(&mut self, output: &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 more
sourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
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 more
1.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 more
1.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 more
sourcefn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
read_buf
)Pull some bytes from this source into the specified buffer. Read more
sourcefn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
read_buf
)Read the exact number of bytes required to fill buf
. Read more
1.0.0 · sourcefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Creates a “by reference” adaptor for this instance of Read
. Read more
sourceimpl<T: Read + Seek, O: Read + Seek> Seek for Decoder<T, O>
impl<T: Read + Seek, O: Read + Seek> Seek for Decoder<T, O>
sourcefn seek(&mut self, pos: SeekFrom) -> Result<u64>
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
Seek to an offset, in bytes, in a stream. Read more
1.55.0 · sourcefn rewind(&mut self) -> Result<(), Error>
fn rewind(&mut self) -> Result<(), Error>
Rewind to the beginning of a stream. Read more
Auto Trait Implementations
impl<T, O> RefUnwindSafe for Decoder<T, O> where
O: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, O> Send for Decoder<T, O> where
O: Send,
T: Send,
impl<T, O> Sync for Decoder<T, O> where
O: Sync,
T: Sync,
impl<T, O> Unpin for Decoder<T, O> where
O: Unpin,
T: Unpin,
impl<T, O> UnwindSafe for Decoder<T, O> where
O: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
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