Struct Identifier

pub struct Identifier<C: Ciphersuite>(/* private fields */);

A FROST participant identifier.

The identifier is a field element in the scalar field that the secret polynomial is defined over, corresponding to some x-coordinate for a polynomial f(x) = y. MUST NOT be zero in the field, as f(0) = the shared secret.

Implementations

impl<C> Identifier<C>

where C: Ciphersuite,

pub fn derive(s: &[u8]) -> Result<Self, Error<C>>

Derive an Identifier from an arbitrary byte string.

This feature is not part of the specification and is just a convenient way of creating identifiers.

Each possible byte string will map to an uniformly random identifier. Returns an error if the ciphersuite does not support identifier derivation, or if the mapped identifier is zero (which is unpredictable, but should happen with negligible probability).

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

Serialize the identifier using the ciphersuite encoding.

pub fn deserialize(bytes: &[u8]) -> Result<Self, Error<C>>

Deserialize an Identifier from a serialized buffer. Returns an error if it attempts to deserialize zero.

Trait Implementations

impl<C: Clone + Ciphersuite> Clone for Identifier<C>

fn clone(&self) -> Identifier<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Identifier<C>

where C: Ciphersuite,

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for Identifier<C>

where C: Ciphersuite,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Hash for Identifier<C>

where C: Ciphersuite,

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<C> Ord for Identifier<C>

where C: Ciphersuite,

fn cmp(&self, other: &Self) -> 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<C: PartialEq + Ciphersuite> PartialEq for Identifier<C>

fn eq(&self, other: &Identifier<C>) -> 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<C> PartialOrd for Identifier<C>

where C: Ciphersuite,

fn partial_cmp(&self, other: &Self) -> 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<C> Serialize for Identifier<C>

where C: Ciphersuite,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> TryFrom<u16> for Identifier<C>

where C: Ciphersuite,

type Error = Error<C>

The type returned in the event of a conversion error.

fn try_from(n: u16) -> Result<Identifier<C>, Self::Error>

Performs the conversion.

impl<C: Copy + Ciphersuite> Copy for Identifier<C>

impl<C> Eq for Identifier<C>

where C: Ciphersuite,

impl<C: Ciphersuite> StructuralPartialEq for Identifier<C>