Struct librsync::Signature

pub struct Signature<R> { /* private fields */ }

A struct to generate a signature.

This type takes a Read stream for the input from which compute the signatures, and implements another Read stream from which get the result.

Implementations

impl<R: Read> Signature<BufReader<R>>

pub fn new(input: R) -> Result<Self>

Creates a new signature stream with default parameters.

This constructor takes an input stream for the file from which compute the signatures. Default options are used for the signature format: BLAKE2 for the hashing, 2048 bytes for the block length and full length for the strong signature size.

pub fn with_options( input: R, block_len: usize, strong_len: usize, sig_magic: SignatureType ) -> Result<Self>

Creates a new signature stream by specifying custom parameters.

This constructor takes the input stream for the file from which compute the signatures, the size of checksum blocks as block_len parameter (larger values make the signature shorter and the delta longer), and the size of strong signatures in bytes as strong_len parameter. If it is non-zero the signature will be truncated to that amount of bytes. The last parameter specifies which version of the signature format to be used.

impl<R: BufRead> Signature<R>

pub fn with_buf_read( input: R, block_len: usize, strong_len: usize, sig_magic: SignatureType ) -> Result<Self>

Creates a new signature stream by using a BufRead.

This constructor takes an already built BufRead instance. Prefer this constructor if you already have a BufRead as input stream, since it avoids wrapping the input stream into another BufRead instance. See with_options constructor for details on the other parameters.

pub fn into_inner(self) -> R

Unwraps this stream, returning the underlying input stream.

Trait Implementations

impl<R: BufRead> Read for Signature<R>

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.

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

Like read, except that it reads into a slice of buffers.

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.

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.

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

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

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.

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.

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

Creates a “by reference” adaptor for this instance of Read.

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

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adapter which will chain this stream with another.

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

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