Struct fog_pack::types::StreamId

pub struct StreamId { /* fields omitted */ }

An identifier for a corresponding StreamKey. It is primarily used to indicate lockboxes are meant for that particular key.

This is derived through a hash of the key, given a set of specific hash parameters (see crate::stream).

Examples

A StreamId can be made publically visible:

let mut csprng = rand::rngs::OsRng {};
let key = StreamKey::new_temp(&mut csprng);
let id = key.id();

println!("StreamId(Base58): {}", id);

It can also be used to identify a recipient of a lockbox:

// We start with a known StreamKey
let key = StreamKey::new_temp(&mut csprng);

// ...
// We get the byte vector `encoded`, which might be a lockbox
// ...

let dec_lockbox = DataLockboxRef::from_bytes(encoded.as_ref())?;
let recipient = dec_lockbox.recipient();
if let LockboxRecipient::StreamId(ref id) = dec_lockbox.recipient() {
    // Check to see if this matches the key's StreamId
    if id == key.id() {
        let dec_data: Vec<u8> = key.decrypt_data(&dec_lockbox)?;
    }
    else {
        panic!("We were hoping this lockbox was for us!");
    }
}

Implementations

impl StreamId

pub fn version(&self) -> u8

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

pub fn as_vec(&self) -> Vec<u8, Global>

Convert into a byte vector. For extending an existing byte vector, see encode_vec.

pub fn to_base58(&self) -> String

Convert into a base58-encoded StreamId.

pub fn from_base58(s: &str) -> Result<StreamId, CryptoError>

Attempt to parse a base58-encoded StreamId.

pub fn encode_vec(&self, buf: &mut Vec<u8, Global>)

pub fn size(&self) -> usize

Trait Implementations

impl Clone for StreamId

pub fn clone(&self) -> StreamId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamId

pub fn deserialize<D>(
    deserializer: D
) -> Result<StreamId, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for StreamId

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

Display as a base58-encoded string.

impl Eq for StreamId

impl From<StreamId> for Value

fn from(v: StreamId) -> Self

Performs the conversion.

impl<'a> From<StreamId> for ValueRef<'a>

fn from(v: StreamId) -> Self

Performs the conversion.

impl Hash for StreamId

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for StreamId

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

Formats the value using the given formatter.

impl PartialEq<StreamId> for StreamId

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

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

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

This method tests for !=.

impl Serialize for StreamId

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

Serialize this value into the given Serde serializer.

impl StructuralEq for StreamId

impl StructuralPartialEq for StreamId

impl<'_> TryFrom<&'_ [u8]> for StreamId

type Error = CryptoError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &[u8]
) -> Result<StreamId, <StreamId as TryFrom<&'_ [u8]>>::Error>

Value must be the same length as the StreamId was when it was encoded (no trailing bytes allowed).

impl TryFrom<Value> for StreamId

type Error = Value

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ValueRef<'a>> for StreamId

type Error = ValueRef<'a>

The type returned in the event of a conversion error.

fn try_from(v: ValueRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for StreamId

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

Formats the value using the given formatter.