Struct bc_components::Salt

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

Random salt used to decorrelate other information.

Implementations

impl Salt

pub fn from_data(data: impl Into<Bytes>) -> Self

Create a new salt from data.

pub fn data(&self) -> &Bytes

Return the data of the salt.

pub fn new_with_len(count: usize) -> Result<Self>

Create a specific number of bytes of salt.

If the number of bytes is less than 8, this will return None.

pub fn new_with_len_using( count: usize, rng: &mut impl RandomNumberGenerator ) -> Result<Self>

Create a specific number of bytes of salt.

If the number of bytes is less than 8, this will return None.

pub fn new_in_range(range: RangeInclusive<usize>) -> Result<Self>

Create a number of bytes of salt chosen randomly from the given range.

If the minimum number of bytes is less than 8, this will return None.

pub fn new_in_range_using( range: &RangeInclusive<usize>, rng: &mut impl RandomNumberGenerator ) -> Result<Self>

Create a number of bytes of salt chosen randomly from the given range.

If the minimum number of bytes is less than 8, this will return None.

pub fn new_for_size(size: usize) -> Self

Create a number of bytes of salt generally proportionate to the size of the object being salted.

pub fn new_for_size_using( size: usize, rng: &mut impl RandomNumberGenerator ) -> Self

Create a number of bytes of salt generally proportionate to the size of the object being salted.

pub fn from_hex(hex: impl AsRef<str>) -> Self

Create a new salt from the given hexadecimal string.

pub fn hex(&self) -> String

The data as a hexadecimal string.

Trait Implementations

impl AsRef<[u8]> for Salt

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Salt> for Salt

fn as_ref(&self) -> &Salt

Converts this type into a shared reference of the (usually inferred) input type.

impl CBORDecodable for Salt

fn from_cbor(cbor: &CBOR) -> Result<Self>

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for Salt

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8>

Returns the value in CBOR binary representation.

impl CBORTagged for Salt

const CBOR_TAG: Tag = tags::SALT

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for Salt

fn from_untagged_cbor(untagged_cbor: &CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: &CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: &[u8]) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for Salt

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for Salt

fn clone(&self) -> Salt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Salt

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

Formats the value using the given formatter.

impl<'a> From<&'a Salt> for &'a [u8]

fn from(value: &'a Salt) -> Self

Converts to this type from the input type.

impl From<&Salt> for Salt

fn from(salt: &Salt) -> Self

Converts to this type from the input type.

impl From<&Salt> for Vec<u8>

fn from(salt: &Salt) -> Self

Converts to this type from the input type.

impl From<Salt> for CBOR

fn from(value: Salt) -> Self

Converts to this type from the input type.

impl From<Salt> for Vec<u8>

fn from(salt: Salt) -> Self

Converts to this type from the input type.

impl PartialEq for Salt

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

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

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

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

impl TryFrom<&CBOR> for Salt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: &CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CBOR> for Salt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl URDecodable for Salt

fn from_ur(ur: &UR) -> Result<Self, Error>

where Self: Sized,

fn from_ur_string<T>(ur_string: T) -> Result<Self, Error>

where T: Into<String>, Self: Sized,

impl UREncodable for Salt

fn ur(&self) -> UR

Returns the UR representation of the object.

fn ur_string(&self) -> String

Returns the UR string representation of the object.

impl Eq for Salt

impl StructuralEq for Salt

impl StructuralPartialEq for Salt

impl URCodable for Salt