Struct fullcodec_bls12_381::G2Affine

pub struct G2Affine { /* fields omitted */ }

This is an element of $\mathbb{G}_2$ 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.

Values of G2Affine are guaranteed to be in the $q$-order subgroup unless an “unchecked” API was misused.

Implementations

impl G2Affine

pub const RAW_SIZE: usize

Bytes size of the raw representation

pub fn identity() -> G2Affine

Returns the identity of the group: the point at infinity.

pub fn generator() -> G2Affine

Returns a fixed generator of the group. See notes::design for how this generator is chosen.

pub fn to_raw_bytes(&self) -> [u8; 193]

Raw bytes representation

The intended usage of this function is for trusted sets of data where performance is critical.

For secure serialization, check to_bytes

pub unsafe fn from_slice_unchecked(bytes: &[u8]) -> Self

Create a G2Affine from a set of bytes created by G2Affine::to_raw_bytes.

No check is performed and no constant time is granted. The expected usage of this function is for trusted bytes where performance is critical.

For secure serialization, check from_bytes

After generating the point, you can check is_on_curve and is_torsion_free to grant its security

pub fn is_identity(&self) -> Choice

Returns true if this element is the identity (the point at infinity).

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}_2$. 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.

Trait Implementations

impl<'a, 'b> Add<&'b G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> Add<&'b G2Affine> for G2Projective

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, 'b> Add<&'b G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> Add<&'b G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the + operator.

fn add(self, rhs: G2Affine) -> G2Projective

Performs the + operation.

impl Add<G2Affine> for G2Projective

type Output = G2Projective

The resulting type after applying the + operator.

fn add(self, rhs: G2Affine) -> G2Projective

Performs the + operation.

impl<'a> Add<G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> AddAssign<&'b G2Affine> for G2Projective

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

Performs the += operation.

impl AddAssign<G2Affine> for G2Projective

fn add_assign(&mut self, rhs: G2Affine)

Performs the += operation.

impl Clone for G2Affine

fn clone(&self) -> G2Affine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for G2Affine

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 ConstantTimeEq for G2Affine

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

impl Debug for G2Affine

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

Formats the value using the given formatter.

impl Decode for G2Affine

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for G2Affine

fn default() -> G2Affine

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for G2Affine

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Encode for G2Affine

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

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

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<'a> From<&'a G2Affine> for G2Projective

fn from(p: &'a G2Affine) -> G2Projective

Performs the conversion.

impl<'a> From<&'a G2Projective> for G2Affine

fn from(p: &'a G2Projective) -> G2Affine

Performs the conversion.

impl From<G2Affine> for G2Projective

fn from(p: G2Affine) -> G2Projective

Performs the conversion.

impl From<G2Affine> for G2Prepared

fn from(q: G2Affine) -> G2Prepared

Performs the conversion.

impl From<G2Projective> for G2Affine

fn from(p: G2Projective) -> G2Affine

Performs the conversion.

impl LowerHex for G2Affine

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

Formats the value using the given formatter.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &'b BlsScalar) -> G2Projective

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: BlsScalar) -> G2Projective

Performs the * operation.

impl Mul<Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: BlsScalar) -> G2Projective

Performs the * operation.

impl<'a> Neg for &'a G2Affine

type Output = G2Affine

The resulting type after applying the - operator.

fn neg(self) -> G2Affine

Performs the unary - operation.

impl Neg for G2Affine

type Output = G2Affine

The resulting type after applying the - operator.

fn neg(self) -> G2Affine

Performs the unary - operation.

impl PartialEq<G2Affine> for G2Affine

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

impl Serializable<96_usize> for G2Affine

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

Serializes this element into compressed form. See notes::serialization for details about how group elements are serialized.

fn from_bytes(buf: &[u8; 96]) -> Result<Self, Self::Error>

Attempts to deserialize a compressed element. See notes::serialization for details about how group elements are serialized.

type Error = BytesError

The type returned in the event of a conversion error.

const SIZE: usize

The size of

impl Serialize for G2Affine

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a, 'b> Sub<&'b G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> Sub<&'b G2Affine> for G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, 'b> Sub<&'b G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> Sub<&'b G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<G2Affine> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G2Affine) -> G2Projective

Performs the - operation.

impl Sub<G2Affine> for G2Projective

type Output = G2Projective

The resulting type after applying the - operator.

fn sub(self, rhs: G2Affine) -> G2Projective

Performs the - operation.

impl<'a> Sub<G2Projective> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<G2Projective> for G2Affine

type Output = G2Projective

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> SubAssign<&'b G2Affine> for G2Projective

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

Performs the -= operation.

impl SubAssign<G2Affine> for G2Projective

fn sub_assign(&mut self, rhs: G2Affine)

Performs the -= operation.

impl UpperHex for G2Affine

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

Formats the value using the given formatter.

impl Copy for G2Affine

impl EncodeLike<G2Affine> for G2Affine

impl Eq for G2Affine