Struct DryocStream 

pub struct DryocStream<Mode> { /* private fields */ }

Secret-key authenticated encrypted streams

Implementations

impl<M> DryocStream<M>

pub fn rekey(&mut self)

Manually rekeys the stream. Both the push and pull sides of the stream must rekey at the same position.

Automatic rekeying normally makes manual rekeying unnecessary.

Refer to the libsodium docs for details.

impl DryocStream<Push>

pub fn init_push<Key: ByteArray<CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES>, Header: NewByteArray<CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES>>( key: &Key, ) -> (Self, Header)

Returns a new push stream, initialized from key.

pub fn push<Input: Bytes, Output: NewBytes + ResizableBytes>( &mut self, message: &Input, associated_data: Option<&Input>, tag: Tag, ) -> Result<Output, Error>

Encrypts message for this stream with associated_data and tag, returning the ciphertext.

Errors

Returns an error if tag contains unknown bits, the message exceeds the stream’s maximum message length, or the output storage does not resize to exactly the required ciphertext length.

pub fn push_to_vec<Input: Bytes>( &mut self, message: &Input, associated_data: Option<&Input>, tag: Tag, ) -> Result<Vec<u8>, Error>

Encrypts message for this stream with associated_data and tag, returning the ciphertext.

Errors

Returns an error if tag contains unknown bits or the message exceeds the stream’s maximum message length.

impl DryocStream<Pull>

pub fn init_pull<Key: ByteArray<CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES>, Header: ByteArray<CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES>>( key: &Key, header: &Header, ) -> Self

Returns a new pull stream, initialized from key and header.

pub fn pull<Input: Bytes, Output: MutBytes + Default + ResizableBytes>( &mut self, ciphertext: &Input, associated_data: Option<&Input>, ) -> Result<(Output, Tag), Error>

Decrypts ciphertext for this stream with associated_data, returning the decrypted message and tag.

Errors

Returns an error if the ciphertext is too short or too long, the output storage cannot hold the plaintext, or authentication fails. Authentication fails for a wrong key or header, mismatched associated data, modified ciphertext, or messages processed out of order. Authenticated tag values containing unknown bits are also rejected without advancing the stream.

pub fn pull_to_vec<Input: Bytes>( &mut self, ciphertext: &Input, associated_data: Option<&Input>, ) -> Result<(Vec<u8>, Tag), Error>

Decrypts ciphertext for this stream with associated_data, returning the decrypted message and tag into a Vec.

Errors

Returns an error if the ciphertext is too short or too long, or authentication fails because the key, header, associated data, stream position, or ciphertext does not match. Authenticated tag values containing unknown bits are also rejected without advancing the stream.

Trait Implementations

impl<Mode: Clone> Clone for DryocStream<Mode>

fn clone(&self) -> DryocStream<Mode>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Mode> Drop for DryocStream<Mode>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<Mode: Eq> Eq for DryocStream<Mode>

impl<Mode: PartialEq> PartialEq for DryocStream<Mode>

fn eq(&self, other: &DryocStream<Mode>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<Mode: PartialEq> StructuralPartialEq for DryocStream<Mode>

impl<Mode> Zeroize for DryocStream<Mode>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.