Struct StreamId 

pub struct StreamId { /* private fields */ }

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 key = StreamKey::new();
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();

// ...
// 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>

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<Self, CryptoError>

Attempt to parse a base58-encoded StreamId.

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

pub fn size(&self) -> usize

Trait Implementations

impl Clone for StreamId

fn clone(&self) -> StreamId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamId

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamId

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

Display as a base58-encoded string.

impl Hash for StreamId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for StreamId

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

Formats the value using the given formatter.

impl PartialEq for StreamId

fn eq(&self, other: &StreamId) -> 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 StreamId

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for StreamId

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

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

type Error = CryptoError

The type returned in the event of a conversion error.

impl UpperHex for StreamId

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

Formats the value using the given formatter.

impl Eq for StreamId

impl StructuralPartialEq for StreamId