Struct blstrs::G1Affine

#[repr(transparent)]
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]) -> CtOption<Self>

Attempts to deserialize an uncompressed element.

pub fn from_uncompressed_unchecked(bytes: &[u8; 96]) -> CtOption<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]) -> CtOption<Self>

Attempts to deserialize a compressed element.

pub fn from_compressed_unchecked(bytes: &[u8; 48]) -> CtOption<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) -> Choice

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) -> Choice

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 Add<&G1Affine> for &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 Add<&G1Projective> for &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 Add<G1Affine> for &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 Add<G1Projective> for &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 AddAssign<&G1Affine> for G1Projective

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

Performs the += operation.

impl AddAssign<G1Affine> for G1Projective

fn add_assign(&mut self, rhs: G1Affine)

Performs the += operation.

impl AsMut<blst_p1_affine> for G1Affine

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

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

impl AsRef<blst_p1_affine> for G1Affine

fn as_ref(&self) -> &blst_p1_affine

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

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 ConditionallySelectable for G1Affine

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

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<'de> Deserialize<'de> for G1Affine

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for G1Affine

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

Formats the value using the given formatter.

impl From<&G1Affine> for G1Projective

fn from(p: &G1Affine) -> G1Projective

Converts to this type from the input type.

impl From<&G1Projective> for G1Affine

fn from(p: &G1Projective) -> G1Affine

Converts to this type from the input type.

impl From<G1Affine> for G1Projective

fn from(p: G1Affine) -> G1Projective

Converts to this type from the input type.

impl From<G1Projective> for G1Affine

fn from(p: G1Projective) -> G1Affine

Converts to this type from the input type.

impl GroupEncoding for G1Affine

type Repr = G1Compressed

The encoding of group elements.

fn from_bytes(bytes: &Self::Repr) -> CtOption<Self>

Attempts to deserialize a group element from its encoding.

fn from_bytes_unchecked(bytes: &Self::Repr) -> CtOption<Self>

Attempts to deserialize a group element, not checking if the element is valid.

fn to_bytes(&self) -> Self::Repr

Converts this element into its byte encoding. This may or may not support encoding the identity.

impl Mul<&Scalar> for &G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, scalar: &Scalar) -> Self::Output

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 Mul<Scalar> for &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 MulAssign<&Scalar> for G1Affine

fn mul_assign(&mut self, rhs: &Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for G1Affine

fn mul_assign(&mut self, rhs: Scalar)

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 Pair = G2Affine

type PairingResult = Gt

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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PrimeCurveAffine for G1Affine

type Scalar = Scalar

type Curve = G1Projective

fn identity() -> Self

Returns the additive identity.

fn generator() -> Self

Returns a fixed generator of unknown exponent.

fn is_identity(&self) -> Choice

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

fn to_curve(&self) -> Self::Curve

Converts this element to its curve representation.

impl Serialize for G1Affine

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

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 Sub<&G1Affine> for G1Projective

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: &G1Affine) -> 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 Sub<&G1Projective> for G1Affine

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: &G1Projective) -> 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 Sub<G1Affine> for G1Projective

type Output = G1Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G1Affine) -> 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 Sub<G1Projective> for G1Affine

type Output = G1Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&G1Affine> for G1Projective

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

Performs the -= operation.

impl SubAssign<G1Affine> for G1Projective

fn sub_assign(&mut self, rhs: G1Affine)

Performs the -= operation.

impl UncompressedEncoding for G1Affine

type Uncompressed = G1Uncompressed

fn from_uncompressed(bytes: &Self::Uncompressed) -> CtOption<Self>

Attempts to deserialize an element from its uncompressed encoding.

fn from_uncompressed_unchecked(bytes: &Self::Uncompressed) -> CtOption<Self>

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

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

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

impl Copy for G1Affine

impl Eq for G1Affine