Struct Field

pub struct Field { /* private fields */ }

Field element for secp256k1.

Implementations

impl Field

pub const fn new_raw( d9: u32, d8: u32, d7: u32, d6: u32, d5: u32, d4: u32, d3: u32, d2: u32, d1: u32, d0: u32, ) -> Self

pub const fn new( d7: u32, d6: u32, d5: u32, d4: u32, d3: u32, d2: u32, d1: u32, d0: u32, ) -> Self

pub fn from_int(a: u32) -> Field

pub fn normalize(&mut self)

Normalize a field element.

pub fn normalize_weak(&mut self)

Weakly normalize a field element: reduce it magnitude to 1, but don’t fully normalize.

pub fn normalize_var(&mut self)

Normalize a field element, without constant-time guarantee.

pub fn normalizes_to_zero(&self) -> bool

Verify whether a field element represents zero i.e. would normalize to a zero value. The field implementation may optionally normalize the input, but this should not be relied upon.

pub fn normalizes_to_zero_var(&self) -> bool

Verify whether a field element represents zero i.e. would normalize to a zero value. The field implementation may optionally normalize the input, but this should not be relied upon.

pub fn set_int(&mut self, a: u32)

Set a field element equal to a small integer. Resulting field element is normalized.

pub fn is_zero(&self) -> bool

Verify whether a field element is zero. Requires the input to be normalized.

pub fn is_odd(&self) -> bool

Check the “oddness” of a field element. Requires the input to be normalized.

pub fn clear(&mut self)

Sets a field element equal to zero, initializing all fields.

pub fn set_b32(&mut self, a: &[u8; 32]) -> bool

Set a field element equal to 32-byte big endian value. If successful, the resulting field element is normalized.

pub fn fill_b32(&self, r: &mut [u8; 32])

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

Convert a field element to a 32-byte big endian value. Requires the input to be normalized.

pub fn neg_in_place(&mut self, other: &Field, m: u32)

Set a field element equal to the additive inverse of another. Takes a maximum magnitude of the input as an argument. The magnitude of the output is one higher.

pub fn neg(&self, m: u32) -> Field

Compute the additive inverse of this element. Takes the maximum expected magnitude of this element as an argument.

pub fn mul_int(&mut self, a: u32)

Multiplies the passed field element with a small integer constant. Multiplies the magnitude by that small integer.

pub fn cmp_var(&self, other: &Field) -> Ordering

Compare two field elements. Requires both inputs to be normalized.

pub fn eq_var(&self, other: &Field) -> bool

pub fn mul_in_place(&mut self, a: &Field, b: &Field)

Sets a field element to be the product of two others. Requires the inputs’ magnitudes to be at most 8. The output magnitude is 1 (but not guaranteed to be normalized).

pub fn sqr_in_place(&mut self, a: &Field)

Sets a field element to be the square of another. Requires the input’s magnitude to be at most 8. The output magnitude is 1 (but not guaranteed to be normalized).

pub fn sqr(&self) -> Field

pub fn sqrt(&self) -> (Field, bool)

If a has a square root, it is computed in r and 1 is returned. If a does not have a square root, the root of its negation is computed and 0 is returned. The input’s magnitude can be at most 8. The output magnitude is 1 (but not guaranteed to be normalized). The result in r will always be a square itself.

pub fn inv(&self) -> Field

Sets a field element to be the (modular) inverse of another. Requires the input’s magnitude to be at most 8. The output magnitude is 1 (but not guaranteed to be normalized).

pub fn inv_var(&self) -> Field

Potentially faster version of secp256k1_fe_inv, without constant-time guarantee.

pub fn is_quad_var(&self) -> bool

Checks whether a field element is a quadratic residue.

pub fn cmov(&mut self, other: &Field, flag: bool)

If flag is true, set *r equal to *a; otherwise leave it. Constant-time.

Trait Implementations

impl<'a, 'b> Add<&'a Field> for &'b Field

type Output = Field

The resulting type after applying the + operator.

fn add(self, other: &'a Field) -> Field

Performs the + operation.

impl Add for Field

type Output = Field

The resulting type after applying the + operator.

fn add(self, other: Field) -> Field

Performs the + operation.

impl<'a> AddAssign<&'a Field> for Field

fn add_assign(&mut self, other: &'a Field)

Performs the += operation.

impl AddAssign for Field

fn add_assign(&mut self, other: Field)

Performs the += operation.

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl From<FieldStorage> for Field

fn from(a: FieldStorage) -> Field

Converts to this type from the input type.

impl Into<FieldStorage> for Field

fn into(self) -> FieldStorage

Converts this type into the (usually inferred) input type.

impl<'a, 'b> Mul<&'a Field> for &'b Field

type Output = Field

The resulting type after applying the * operator.

fn mul(self, other: &'a Field) -> Field

Performs the * operation.

impl Mul for Field

type Output = Field

The resulting type after applying the * operator.

fn mul(self, other: Field) -> Field

Performs the * operation.

impl<'a> MulAssign<&'a Field> for Field

fn mul_assign(&mut self, other: &'a Field)

Performs the *= operation.

impl MulAssign for Field

fn mul_assign(&mut self, other: Field)

Performs the *= operation.

impl Ord for Field

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

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

fn partial_cmp(&self, other: &Field) -> 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 Copy for Field

impl Eq for Field