Struct StreamLockboxRef

pub struct StreamLockboxRef(/* private fields */);

An encrypted StreamKey.

This must be decrypted by the matching recipient, which will return the StreamKey on success. It can either be decrypted on its own, returning a temporary StreamKey, or through a Vault, which will store the StreamKey.

This is only a reference to an encrypted payload. The owned version is StreamLockbox.

See: StreamKey::decrypt_stream_key, LockKey::decrypt_stream_key, and Vault::decrypt_stream_key.

Example

Using a StreamKey for decryption (different from the one contained in the lockbox!):

// We have `enc`, a byte vector containing a lockbox
let dec_lockbox: &StreamLockboxRef = StreamLockboxRef::from_bytes(&enc[..])?;
let recipient: LockboxRecipient = dec_lockbox.recipient();
// ...
// Retrieve the key by looking up recipient
// ...
let dec_key: StreamKey = key.decrypt_stream_key(&dec_lockbox)?;

Implementations

impl StreamLockboxRef

pub fn as_parts(&self) -> LockboxParts<'_>

Decompose the lockbox into its component parts.

pub fn version(&self) -> u8

Get the stream encryption version.

pub fn recipient(&self) -> LockboxRecipient

Get the target recipient who can decrypt this.

pub fn as_bytes(&self) -> &[u8]

The raw bytestream, suitable for serialization.

pub fn from_bytes(buf: &[u8]) -> Result<&Self, CryptoError>

Trait Implementations

impl Borrow<StreamLockboxRef> for StreamLockbox

fn borrow(&self) -> &StreamLockboxRef

Immutably borrows from an owned value.

impl Debug for StreamLockboxRef

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a StreamLockboxRef

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for StreamLockboxRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl PartialEq for StreamLockboxRef

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for StreamLockboxRef

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToOwned for StreamLockboxRef

type Owned = StreamLockbox

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for StreamLockboxRef

impl StructuralPartialEq for StreamLockboxRef