Struct dryoc::dryocstream::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 need to manually rekey if you use this function (i.e., it’s not handled by the library).

Automatic rekeying will occur normally, and you generally shouldn’t need to manually rekey.

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.

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.

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.

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.

Trait Implementations

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

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

Returns a copy 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.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Mode> Zeroize for DryocStream<Mode>where
    PhantomData<Mode>: Zeroize,
    Mode: Zeroize,

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.

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

impl<Mode> StructuralEq for DryocStream<Mode>

impl<Mode> StructuralPartialEq for DryocStream<Mode>