Struct BareRecordKey 

pub struct BareRecordKey { /* private fields */ }

Untyped DHT record key: an opaque record key with an optional record encryption secret.

Implementations

impl BareRecordKey

pub fn new( key: BareOpaqueRecordKey, encryption_key: Option<BareSharedSecret>, ) -> Self

Builds a record key from an opaque record key and an optional encryption secret.

pub fn ref_key(&self) -> &BareOpaqueRecordKey

Returns a reference to the opaque record key.

pub fn ref_encryption_key(&self) -> Option<&BareSharedSecret>

Returns a reference to the encryption secret, if present.

pub fn split(&self) -> (BareOpaqueRecordKey, Option<BareSharedSecret>)

Clones out the opaque record key and optional encryption secret.

pub fn into_split(self) -> (BareOpaqueRecordKey, Option<BareSharedSecret>)

Consumes the key, returning the opaque record key and optional encryption secret.

impl BareRecordKey

pub fn key(&self) -> BareOpaqueRecordKey

Returns a clone of the opaque record key.

pub fn encryption_key(&self) -> Option<BareSharedSecret>

Returns a clone of the encryption secret, if present.

pub fn encode(&self) -> String

Encodes as <key> or <key>:<encryption_key>, each part base64url-nopad.

pub fn encoded_len(&self) -> usize

Returns the length of the encode string.

pub fn try_decode(input: &str) -> VeilidAPIResult<Self>

Decodes from a <key> or <key>:<encryption_key> string.

Errors with VeilidAPIError::ParseError if input has more than two colon-separated parts, or VeilidAPIError::Generic if any part is not valid base64url-nopad.

pub fn try_decode_bytes(b: &[u8]) -> VeilidAPIResult<Self>

Decodes from <key> or <key>:<encryption_key> bytes.

Errors with VeilidAPIError::ParseError if b has more than two colon-separated parts, or VeilidAPIError::Generic if any part is not valid base64url-nopad.

Trait Implementations

impl Clone for BareRecordKey

fn clone(&self) -> BareRecordKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BareRecordKey

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

Formats the value using the given formatter.

impl Default for BareRecordKey

fn default() -> BareRecordKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BareRecordKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BareRecordKey

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

Formats the value using the given formatter.

impl Eq for BareRecordKey

impl From<&BareRecordKey> for String

fn from(value: &BareRecordKey) -> Self

Converts to this type from the input type.

impl FromStr for BareRecordKey

fn from_str(s: &str) -> Result<Self, Self::Err>

Errors with VeilidAPIError::ParseError if s has more than two colon-separated parts, or VeilidAPIError::Generic if any part is not valid base64url-nopad.

type Err = VeilidAPIError

The associated error which can be returned from parsing.

impl GetSize for BareRecordKey

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl Hash for BareRecordKey

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 Ord for BareRecordKey

fn cmp(&self, other: &BareRecordKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BareRecordKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BareRecordKey

fn partial_cmp(&self, other: &BareRecordKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BareRecordKey

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BareRecordKey

impl ToVeilidAPIErrorArgument for BareRecordKey

fn to_veilid_api_error_argument(&self) -> String

Render this value as a string for inclusion in a VeilidAPIError message field.

impl TryFrom<&str> for BareRecordKey

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for BareRecordKey

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.