Enum kuska_sodiumoxide::crypto::secretstream::xchacha20poly1305::Tag

pub enum Tag {
    Message,
    Push,
    Rekey,
    Final,
}

A tag is encrypted and attached to each message before the authentication code is generated over all data. A typical encrypted stream simply attaches 0 as a tag to all messages, except the last one which is tagged as Tag::Final. When decrypting the tag is retrieved and may be used.

Variants

Message

Message, the most common tag, that doesn't add any information about the nature of the message.

Push

Push: indicates that the message marks the end of a set of messages, but not the end of the stream. For example, a huge JSON string sent as multiple chunks can use this tag to indicate to the application that the string is complete and that it can be decoded. But the stream itself is not closed, and more data may follow.

Rekey

Rekey: "forget" the key used to encrypt this message and the previous ones, and derive a new secret key.

Final

Final: indicates that the message marks the end of the stream and erases the secret key used to encrypt the previous sequence.

Trait Implementations

impl Clone for Tag

pub fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Tag

impl Debug for Tag

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Tag> for Tag

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for Tag