Struct librsync::Signature
[−]
[src]
pub struct Signature<R> { // some fields omitted }
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.
Methods
impl<R: Read> Signature<R>
[src]
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.
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.
fn into_inner(self) -> R
Unwraps this stream, returning the underlying input stream.
Trait Implementations
impl<R: Read> Read for Signature<R>
[src]
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
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
fn chars(self) -> Chars<Self>
io
): the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an Iterator
over char
s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read
1.0.0
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more