Struct blstrs::G1Affine

pub struct G1Affine(_);

This is an element of $\mathbb{G}_1$ represented in the affine coordinate space. It is ideal to keep elements in this representation to reduce memory usage and improve performance through the use of mixed curve model arithmetic.

Implementations

impl G1Affine

pub fn to_compressed(&self) -> [u8; 48]

Serializes this element into compressed form.

pub fn to_uncompressed(&self) -> [u8; 96]

Serializes this element into uncompressed form.

pub fn from_uncompressed(bytes: &[u8; 96]) -> Option<Self>

Attempts to deserialize an uncompressed element.

pub fn from_uncompressed_unchecked(bytes: &[u8; 96]) -> Option<Self>

Attempts to deserialize an uncompressed element, not checking if the element is on the curve and not checking if it is in the correct subgroup.

This is dangerous to call unless you trust the bytes you are reading; otherwise, API invariants may be broken. Please consider using from_uncompressed() instead.

pub fn from_compressed(bytes: &[u8; 48]) -> Option<Self>

Attempts to deserialize a compressed element.

pub fn from_compressed_unchecked(bytes: &[u8; 48]) -> Option<Self>

Attempts to deserialize an uncompressed element, not checking if the element is in the correct subgroup.

This is dangerous to call unless you trust the bytes you are reading; otherwise, API invariants may be broken. Please consider using from_compressed() instead.

pub fn is_torsion_free(&self) -> bool

Returns true if this point is free of an $h$-torsion component, and so it exists within the $q$-order subgroup $\mathbb{G}_1$. This should always return true unless an "unchecked" API was used.

pub fn is_on_curve(&self) -> bool

Returns true if this point is on the curve. This should always return true unless an "unchecked" API was used.

pub fn from_raw_unchecked(x: Fp, y: Fp, _infinity: bool) -> Self

pub fn x(&self) -> Fp

Returns the x coordinate.

pub fn y(&self) -> Fp

Returns the y coordinate.

pub const fn uncompressed_size() -> usize

pub const fn compressed_size() -> usize

pub fn raw_fmt_size() -> usize

pub fn write_raw<W: Write>(&self, writer: W) -> Result<usize, Error>

pub fn read_raw<R: Read>(reader: R) -> Result<Self, Error>

pub fn read_raw_checked<R: Read>(reader: R) -> Result<Self, Error>

Trait Implementations

impl<'a, 'b> Add<&'b G1Affine> for &'a G1Projective

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: &'b G1Affine) -> G1Projective

Performs the + operation.

impl<'b> Add<&'b G1Affine> for G1Projective

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: &'b G1Affine) -> G1Projective

Performs the + operation.

impl<'a, 'b> Add<&'b G1Projective> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: &'b G1Projective) -> G1Projective

Performs the + operation.

impl<'b> Add<&'b G1Projective> for G1Affine

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: &'b G1Projective) -> G1Projective

Performs the + operation.

impl<'a> Add<G1Affine> for &'a G1Projective

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: G1Affine) -> G1Projective

Performs the + operation.

impl Add<G1Affine> for G1Projective

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: G1Affine) -> G1Projective

Performs the + operation.

impl<'a> Add<G1Projective> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: G1Projective) -> G1Projective

Performs the + operation.

impl Add<G1Projective> for G1Affine

type Output = G1Projective

The resulting type after applying the + operator.

fn add(self, rhs: G1Projective) -> G1Projective

Performs the + operation.

impl<'b> AddAssign<&'b G1Affine> for G1Projective

fn add_assign(&mut self, rhs: &'b G1Affine)

Performs the += operation.

impl AddAssign<G1Affine> for G1Projective

fn add_assign(&mut self, rhs: G1Affine)

Performs the += operation.

impl Clone for G1Affine

fn clone(&self) -> G1Affine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for G1Affine

impl CurveAffine for G1Affine

type Engine = Bls12

type Scalar = Scalar

type Base = Fp

type Projective = G1Projective

type Uncompressed = G1Uncompressed

type Compressed = G1Compressed

fn zero() -> Self

Returns the additive identity.

fn one() -> Self

Returns a fixed generator of unknown exponent.

fn is_zero(&self) -> bool

Determines if this point represents the point at infinity; the additive identity.

fn mul<S: Into<<Self::Scalar as PrimeField>::Repr>>(
    &self,
    by: S
) -> Self::Projective

Performs scalar multiplication of this element with mixed addition.

fn negate(&mut self)

Negates this element.

fn into_projective(&self) -> Self::Projective

Converts this element into its affine representation.

fn into_compressed(&self) -> Self::Compressed

Converts this element into its compressed encoding, so long as it's not the point at infinity.

fn into_uncompressed(&self) -> Self::Uncompressed

Converts this element into its uncompressed encoding, so long as it's not the point at infinity.

impl Debug for G1Affine

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

Formats the value using the given formatter.

impl Default for G1Affine

fn default() -> G1Affine

Returns the "default value" for a type.

impl Display for G1Affine

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

Formats the value using the given formatter.

impl Eq for G1Affine

impl<'_> From<&'_ G1Affine> for G1Projective

fn from(p: &G1Affine) -> G1Projective

Performs the conversion.

impl<'_> From<&'_ G1Projective> for G1Affine

fn from(p: &G1Projective) -> G1Affine

Performs the conversion.

impl From<G1Affine> for G1Projective

fn from(p: G1Affine) -> G1Projective

Performs the conversion.

impl From<G1Projective> for G1Affine

fn from(p: G1Projective) -> G1Affine

Performs the conversion.

impl<'a, 'b> Mul<&'b Scalar> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

impl<'b> Mul<&'b Scalar> for G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Scalar) -> G1Projective

Performs the * operation.

impl<'a> Mul<Scalar> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G1Projective

Performs the * operation.

impl Mul<Scalar> for G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G1Projective

Performs the * operation.

impl<'_> Neg for &'_ G1Affine

type Output = G1Affine

The resulting type after applying the - operator.

fn neg(self) -> G1Affine

Performs the unary - operation.

impl Neg for G1Affine

type Output = G1Affine

The resulting type after applying the - operator.

fn neg(self) -> G1Affine

Performs the unary - operation.

impl PairingCurveAffine for G1Affine

type Prepared = G1Affine

type Pair = G2Affine

type PairingResult = Fp12

fn prepare(&self) -> Self::Prepared

Prepares this element for pairing purposes.

fn pairing_with(&self, other: &Self::Pair) -> Self::PairingResult

Perform a pairing

impl PartialEq<G1Affine> for G1Affine

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> Sub<&'b G1Affine> for &'a G1Projective

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: &'b G1Affine) -> G1Projective

Performs the - operation.

impl<'b> Sub<&'b G1Affine> for G1Projective

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: &'b G1Affine) -> G1Projective

Performs the - operation.

impl<'a, 'b> Sub<&'b G1Projective> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: &'b G1Projective) -> G1Projective

Performs the - operation.

impl<'b> Sub<&'b G1Projective> for G1Affine

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: &'b G1Projective) -> G1Projective

Performs the - operation.

impl<'a> Sub<G1Affine> for &'a G1Projective

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G1Affine) -> G1Projective

Performs the - operation.

impl Sub<G1Affine> for G1Projective

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G1Affine) -> G1Projective

Performs the - operation.

impl<'a> Sub<G1Projective> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G1Projective) -> G1Projective

Performs the - operation.

impl Sub<G1Projective> for G1Affine

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G1Projective) -> G1Projective

Performs the - operation.

impl<'b> SubAssign<&'b G1Affine> for G1Projective

fn sub_assign(&mut self, rhs: &'b G1Affine)

Performs the -= operation.

impl SubAssign<G1Affine> for G1Projective

fn sub_assign(&mut self, rhs: G1Affine)

Performs the -= operation.