Struct LockId 

pub struct LockId { /* private fields */ }

An identifier for a corresponding LockKey that can be used to encrypt data for that key.

This contains a cryptographic public encryption key.

Example

// We've been given a LockId that we're sending encrypted data to.
println!("LockId(Base58): {}", key.id());

// Encrypt some data for that LockId
let data = b"I am sensitive information, about to be encrypted";
let lockbox = id.encrypt_data(data.as_ref());

// The lockbox can be encoded onto a vec or used as raw bytes.
let mut to_send = Vec::new();
to_send.extend_from_slice(lockbox.as_bytes());

Implementations

impl LockId

pub fn encrypt_data(&self, content: &[u8]) -> DataLockbox

Encrypt a byte slice into a DataLockbox.

pub fn encrypt_data_with_rng<R>( &self, csprng: &mut R, content: &[u8], ) -> DataLockbox

where R: CryptoRng + RngCore,

Encrypt a byte slice into a DataLockbox. Requires a cryptographic RNG to generate the needed nonce.

pub fn version(&self) -> u8

Get the cryptographic algorithm version used for this ID.

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

Get the raw public encryption key contained within.

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

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

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

Attempt to parse a base58-encoded LockId.

pub fn to_base58(&self) -> String

Convert into a base58-encoded LockId.

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

Encode onto an existing byte vector. Writes out the version followed by the public signing key. It does not include any length information in the encoding.

pub fn size(&self) -> usize

Get the length of this Identity once encoded as bytes.

Trait Implementations

impl Clone for LockId

fn clone(&self) -> LockId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LockId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LockId

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

Display as a base58-encoded string.

impl From<LockId> for Value

fn from(v: LockId) -> Self

Converts to this type from the input type.

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

fn from(v: LockId) -> Self

Converts to this type from the input type.

impl Hash for LockId

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

where __H: Hasher,

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 LockId

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

Formats the value using the given formatter.

impl PartialEq for LockId

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

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 TryFrom<&[u8]> for LockId

type Error = CryptoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for LockId

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 LockId

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 LockId

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

Formats the value using the given formatter.

impl Eq for LockId

impl StructuralPartialEq for LockId