Struct DryocStream 

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

Secret-key authenticated encrypted streams

Implementations

impl<M> DryocStream<M>

pub fn rekey(&mut self)

Rekeys the stream immediately. The sender and receiver must rekey at the same position.

Manual rekeying is unnecessary when the sender uses Tag::Rekey or Tag::Final, because those tags rekey after the message. The stream also rekeys if its internal counter wraps. See the libsodium documentation for details.

impl DryocStream<Push>

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

Returns a new push stream, initialized from key.

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

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

Errors

Returns an error if 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 + ?Sized>( &mut self, message: &Input, associated_data: Option<&[u8]>, tag: Tag, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

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

Errors

Returns an error if 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<Output: NewBytes + ResizableBytes, Input: Bytes + ?Sized>( &mut self, ciphertext: &Input, associated_data: Option<&[u8]>, ) -> 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. An authenticated tag byte that is not one of the four Tag values is also rejected without advancing the stream.

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

Available on crate feature alloc only.

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. An authenticated tag byte that is not one of the four Tag values is also rejected without advancing the stream.

Trait Implementations

impl<M: Clone> Clone for DryocStream<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Drop for DryocStream<M>

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<M: Eq> Eq for DryocStream<M>

impl<M: PartialEq> PartialEq for DryocStream<M>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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

impl<M> Zeroize for DryocStream<M>

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.