Struct FieldElement

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

secp256k1 field element representing values in F_p

Implementations

impl FieldElement

pub fn zero() -> Self

The additive identity element: 0

pub fn one() -> Self

The multiplicative identity element: 1

pub fn from_bytes(bytes: &[u8; 32]) -> Result<Self>

Create a field element from its canonical byte representation.

Returns an error if the value is greater than or equal to the field modulus.

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

Convert this field element to its canonical byte representation.

pub fn is_valid(&self) -> bool

Check if this field element is less than the field modulus.

pub fn is_zero(&self) -> bool

Check if this field element is zero.

pub fn is_odd(&self) -> bool

Check if this field element is odd (least significant bit is 1).

pub fn add(&self, other: &Self) -> Self

Add two field elements modulo p.

pub fn sub(&self, other: &Self) -> Self

Subtract two field elements modulo p.

pub fn negate(&self) -> Self

Negate a field element modulo p.

pub fn mul(&self, other: &Self) -> Self

Multiply two field elements modulo p.

pub fn square(&self) -> Self

Square a field element modulo p.

pub fn double(&self) -> Self

Double a field element (multiply by 2) modulo p.

pub fn invert(&self) -> Result<Self>

Compute the multiplicative inverse of a field element.

Returns an error if the element is zero.

pub fn sqrt(&self) -> Option<Self>

Compute the square root of a field element.

Returns None if the element is not a quadratic residue.

Trait Implementations

impl Clone for FieldElement

fn clone(&self) -> FieldElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldElement

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

Formats the value using the given formatter.

impl PartialEq for FieldElement

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

impl StructuralPartialEq for FieldElement