Struct subspace_core_primitives::crypto::Scalar

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

Representation of a single BLS12-381 scalar value.

Implementations

impl Scalar

pub const SAFE_BYTES: usize = 31usize

How many full bytes can be stored in BLS12-381 scalar (for instance before encoding). It is actually 254 bits, but bits are mut harder to work with and likely not worth it.

NOTE: After encoding more bytes can be used, so don’t rely on this as the max number of bytes stored within at all times!

pub const FULL_BYTES: usize = 32usize

How many bytes Scalar contains physically, use Self::SAFE_BYTES for the amount of data that you can put into it safely (for instance before encoding).

pub fn to_bytes(&self) -> [u8; 32]

Convert scalar into bytes

pub fn try_to_safe_bytes(&self) -> Option<[u8; 31]>

Convert scalar into safe bytes, returns None if not possible to convert due to larger internal value

pub fn slice_to_repr(value: &[Self]) -> &[FsFr]

Convenient conversion from slice of scalar to underlying representation for efficiency purposes.

pub fn slice_from_repr(value: &[FsFr]) -> &[Self]

Convenient conversion from slice of underlying representation to scalar for efficiency purposes.

pub fn slice_option_to_repr(value: &[Option<Self>]) -> &[Option<FsFr>]

Convenient conversion from slice of optional scalar to underlying representation for efficiency purposes.

pub fn slice_option_from_repr(value: &[Option<FsFr>]) -> &[Option<Self>]

Convenient conversion from slice of optional underlying representation to scalar for efficiency purposes.

pub fn slice_mut_to_repr(value: &mut [Self]) -> &mut [FsFr]

Convenient conversion from mutable slice of scalar to underlying representation for efficiency purposes.

pub fn slice_mut_from_repr(value: &mut [FsFr]) -> &mut [Self]

Convenient conversion from mutable slice of underlying representation to scalar for efficiency purposes.

pub fn slice_option_mut_to_repr( value: &mut [Option<Self>], ) -> &mut [Option<FsFr>]

Convenient conversion from optional mutable slice of scalar to underlying representation for efficiency purposes.

pub fn slice_option_mut_from_repr( value: &mut [Option<FsFr>], ) -> &mut [Option<Self>]

Convenient conversion from optional mutable slice of underlying representation to scalar for efficiency purposes.

pub fn vec_to_repr(value: Vec<Self>) -> Vec<FsFr>

Convenient conversion from vector of scalar to underlying representation for efficiency purposes.

pub fn vec_from_repr(value: Vec<FsFr>) -> Vec<Self>

Convenient conversion from vector of underlying representation to scalar for efficiency purposes.

pub fn vec_option_to_repr(value: Vec<Option<Self>>) -> Vec<Option<FsFr>>

Convenient conversion from vector of optional scalar to underlying representation for efficiency purposes.

pub fn vec_option_from_repr(value: Vec<Option<FsFr>>) -> Vec<Option<Self>>

Convenient conversion from vector of optional underlying representation to scalar for efficiency purposes.

Trait Implementations

impl AsMut<FsFr> for Scalar

fn as_mut(&mut self) -> &mut FsFr

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

impl AsRef<FsFr> for Scalar

fn as_ref(&self) -> &FsFr

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

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl Decode for Scalar

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

impl Default for Scalar

fn default() -> Scalar

Returns the “default value” for a type.

impl Deref for Scalar

type Target = FsFr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Scalar

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Scalar

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for Scalar

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

fn encode_to<T>(&self, dest: &mut T)

where T: Output + ?Sized,

Convert self to a slice and append it to the destination.

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

Convert self to an owned vector.

impl From<&[u8; 31]> for Scalar

fn from(value: &[u8; 31]) -> Self

Converts to this type from the input type.

impl From<&Scalar> for [u8; 32]

fn from(value: &Scalar) -> Self

Converts to this type from the input type.

impl From<[u8; 31]> for Scalar

fn from(value: [u8; 31]) -> Self

Converts to this type from the input type.

impl From<FsFr> for Scalar

fn from(value: FsFr) -> Self

Converts to this type from the input type.

impl From<Scalar> for [u8; 32]

fn from(value: Scalar) -> Self

Converts to this type from the input type.

impl From<Scalar> for FsFr

fn from(value: Scalar) -> Self

Converts to this type from the input type.

impl Hash for Scalar

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 MaxEncodedLen for Scalar

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl Ord for Scalar

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Scalar

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

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 Serialize for Scalar

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; 32]> for Scalar

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 32]> for Scalar

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TypeInfo for Scalar

type Identity = Scalar

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for Scalar

impl EncodeLike for Scalar

impl Eq for Scalar

impl StructuralPartialEq for Scalar