Struct PushState 

pub struct PushState { /* private fields */ }

Encrypting half of a crypto_secretstream session - produced by PushState::init, driven one chunk at a time by PushState::push.

Implementations

impl PushState

pub fn init(key: &Key) -> Result<(Self, [u8; 32]), SecretstreamError>

Starts a new stream under key, drawing a fresh random header from the OS CSPRNG. The returned header must be transmitted/stored alongside the chunks - PullState::init needs it to re-derive the same initial subkey.

Errors

Returns SecretstreamError::Random if the OS CSPRNG fails.

pub fn is_finalized(&self) -> bool

pub fn push( &mut self, tag: Tag, plaintext: &[u8], ciphertext_out: &mut [u8], ) -> Result<[u8; 16], SecretstreamError>

Encrypts plaintext into ciphertext_out (same length) and returns the 16-byte authentication tag for this chunk. tag becomes part of this chunk’s AAD (see the module doc) - the caller must transmit both the ciphertext, the returned tag, and tag.to_byte() for PullState::pull to recover the plaintext.

Errors

Returns SecretstreamError::InvalidLength if ciphertext_out.len() != plaintext.len(), or SecretstreamError::StreamFinalized if a previous chunk already used Tag::Final.

Trait Implementations

impl Drop for PushState

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.