Struct Generator

pub struct Generator<E: Curve>(/* private fields */);

Generator of curve E

Curve generator is a point on curve defined in curve specs. For some curves, generator multiplication may be optimized, so Scalar<E> * Generator<E> would more efficient than Scalar<E> * Point<E>. That’s the only purpose of Generator<E> structure: to distinguish generator multiplication and potentially use more efficient algorithm.

Curve generator Generator<E> should be obtained by calling Point::generator(). You may convert Generator<E> to Point<E> or NonZero<Point<E>> by calling .to_point() or .to_nonzero_point(), but then multiplication may be less efficient.

Implementations

impl<E: Curve> Generator<E>

pub fn to_point(&self) -> Point<E>

Returns a point corresponding to curve generator

pub fn to_nonzero_point(&self) -> NonZero<Point<E>>

Returns a non-zero point corresponding to curve generator

Trait Implementations

impl<E: Curve> Add<&Generator<E>> for &Point<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: &Generator<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<&Generator<E>> for Point<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: &Generator<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<&Point<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: &Point<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<&Point<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: &Point<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<Generator<E>> for &Point<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: Generator<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<Generator<E>> for Point<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: Generator<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<Point<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: Point<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> Add<Point<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the + operator.

fn add(self, rhs: Point<E>) -> Self::Output

Performs the + operation.

impl<E: Curve> AddAssign<&Generator<E>> for Point<E>

fn add_assign(&mut self, rhs: &Generator<E>)

Performs the += operation.

impl<E: Curve> AddAssign<Generator<E>> for Point<E>

fn add_assign(&mut self, rhs: Generator<E>)

Performs the += operation.

impl<E: Clone + Curve> Clone for Generator<E>

fn clone(&self) -> Generator<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Curve> Default for Generator<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Curve> From<Generator<E>> for NonZero<Point<E>>

fn from(g: Generator<E>) -> Self

Converts to this type from the input type.

impl<E: Curve> From<Generator<E>> for Point<E>

fn from(_: Generator<E>) -> Self

Converts to this type from the input type.

impl<E: Hash + Curve> Hash for Generator<E>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: Curve> Mul<&Generator<E>> for &NonZero<Scalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for &NonZero<SecretScalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for &Scalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for &SecretScalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for NonZero<Scalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for NonZero<SecretScalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for Scalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Generator<E>> for SecretScalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&NonZero<Scalar<E>>> for &Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonZero<Scalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&NonZero<Scalar<E>>> for Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonZero<Scalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&NonZero<SecretScalar<E>>> for &Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonZero<SecretScalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&NonZero<SecretScalar<E>>> for Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonZero<SecretScalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Scalar<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&Scalar<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&SecretScalar<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &SecretScalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<&SecretScalar<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: &SecretScalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for &NonZero<Scalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for &NonZero<SecretScalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for &Scalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for &SecretScalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for NonZero<Scalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for NonZero<SecretScalar<E>>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for Scalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Generator<E>> for SecretScalar<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: Generator<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<NonZero<Scalar<E>>> for &Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: NonZero<Scalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<NonZero<Scalar<E>>> for Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: NonZero<Scalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<NonZero<SecretScalar<E>>> for &Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: NonZero<SecretScalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<NonZero<SecretScalar<E>>> for Generator<E>

type Output = NonZero<Point<E>>

The resulting type after applying the * operator.

fn mul(self, rhs: NonZero<SecretScalar<E>>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Scalar<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<Scalar<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<SecretScalar<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: SecretScalar<E>) -> Self::Output

Performs the * operation.

impl<E: Curve> Mul<SecretScalar<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the * operator.

fn mul(self, rhs: SecretScalar<E>) -> Self::Output

Performs the * operation.

impl<E: Ord + Curve> Ord for Generator<E>

fn cmp(&self, other: &Generator<E>) -> 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<E: PartialEq + Curve> PartialEq for Generator<E>

fn eq(&self, other: &Generator<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<E: PartialOrd + Curve> PartialOrd for Generator<E>

fn partial_cmp(&self, other: &Generator<E>) -> 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<E: Curve> Sub<&Generator<E>> for &Point<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: &Generator<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<&Generator<E>> for Point<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: &Generator<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<&Point<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: &Point<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<&Point<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: &Point<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<Generator<E>> for &Point<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: Generator<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<Generator<E>> for Point<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: Generator<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<Point<E>> for &Generator<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: Point<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> Sub<Point<E>> for Generator<E>

type Output = Point<E>

The resulting type after applying the - operator.

fn sub(self, rhs: Point<E>) -> Self::Output

Performs the - operation.

impl<E: Curve> SubAssign<&Generator<E>> for Point<E>

fn sub_assign(&mut self, rhs: &Generator<E>)

Performs the -= operation.

impl<E: Curve> SubAssign<Generator<E>> for Point<E>

fn sub_assign(&mut self, rhs: Generator<E>)

Performs the -= operation.

impl<E: Copy + Curve> Copy for Generator<E>

impl<E: Eq + Curve> Eq for Generator<E>

impl<E: Curve> StructuralPartialEq for Generator<E>