Struct EncodedPoint

pub struct EncodedPoint<C>
where
    C: PrimeCurve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>,
    <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,
{ /* private fields */ }

SEC1 encoded curve point.

This type is an enum over the compressed and uncompressed encodings, useful for cases where either encoding can be supported, or conversions between the two forms.

Implementations

impl<C> EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

pub fn from_bytes(input: impl AsRef<[u8]>) -> Result<EncodedPoint<C>, Error>

Decode elliptic curve point (compressed or uncompressed) from the Elliptic-Curve-Point-to-Octet-String encoding described in SEC 1: Elliptic Curve Cryptography (Version 2.0) section 2.3.3 (page 10).

http://www.secg.org/sec1-v2.pdf

pub fn from_untagged_bytes( bytes: &GenericArray<u8, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output>, ) -> EncodedPoint<C>

Decode elliptic curve point from raw uncompressed coordinates, i.e. encoded as the concatenated x || y coordinates with no leading SEC1 tag byte (which would otherwise be 0x04 for an uncompressed point).

pub fn from_affine_coordinates( x: &GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>, y: &GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>, compress: bool, ) -> EncodedPoint<C>

Encode an elliptic curve point from big endian serialized coordinates (with optional point compression)

pub fn from_secret_key( secret_key: &SecretKey<C>, compress: bool, ) -> EncodedPoint<C>

where C: PrimeCurve + ProjectiveArithmetic, <C as AffineArithmetic>::AffinePoint: ToEncodedPoint<C>,

Compute EncodedPoint representing the public key for the provided SecretKey.

The compress flag requests point compression.

pub fn identity() -> EncodedPoint<C>

Return EncodedPoint representing the additive identity (a.k.a. point at infinity)

pub fn len(&self) -> usize

Get the length of the encoded point in bytes

pub fn as_bytes(&self) -> &[u8]

Get byte slice containing the serialized EncodedPoint.

pub fn to_bytes(&self) -> Box<[u8]>

Get boxed byte slice containing the serialized EncodedPoint

pub fn to_untagged_bytes( &self, ) -> Option<GenericArray<u8, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output>>

where C: PrimeCurve + ProjectiveArithmetic, <C as AffineArithmetic>::AffinePoint: DecompressPoint<C> + ToEncodedPoint<C>,

Serialize point as raw uncompressed coordinates without tag byte, i.e. encoded as the concatenated x || y coordinates.

pub fn is_compact(&self) -> bool

Is this EncodedPoint compact?

pub fn is_compressed(&self) -> bool

Is this EncodedPoint compressed?

pub fn is_identity(&self) -> bool

Is this EncodedPoint the additive identity? (a.k.a. point at infinity)

pub fn compress(&self) -> EncodedPoint<C>

Compress this EncodedPoint, returning a new EncodedPoint.

pub fn decompress(&self) -> Option<EncodedPoint<C>>

where C: PrimeCurve + ProjectiveArithmetic, <C as AffineArithmetic>::AffinePoint: DecompressPoint<C> + ToEncodedPoint<C>,

Decompress this EncodedPoint, returning a new EncodedPoint.

pub fn encode<T>(encodable: T, compress: bool) -> EncodedPoint<C>

where T: ToEncodedPoint<C>,

Encode an EncodedPoint from the desired type

pub fn decode<T>(&self) -> Result<T, Error>

where T: FromEncodedPoint<C>,

Decode this EncodedPoint into the desired type

pub fn tag(&self) -> Tag

Get the SEC1 tag for this EncodedPoint

pub fn coordinates(&self) -> Coordinates<'_, C>

Get the Coordinates for this EncodedPoint.

pub fn x( &self, ) -> Option<&GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>>

Get the x-coordinate for this EncodedPoint.

Returns None if this point is the identity point.

pub fn y( &self, ) -> Option<&GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>>

Get the y-coordinate for this EncodedPoint.

Returns None if this point is compressed or the identity point.

Trait Implementations

impl<C> AsRef<[u8]> for EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn as_ref(&self) -> &[u8]

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

impl<C> Clone for EncodedPoint<C>

where C: Clone + PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn clone(&self) -> EncodedPoint<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> ConditionallySelectable for EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>, <<<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output as ArrayLength<u8>>::ArrayType: Copy,

fn conditional_select( a: &EncodedPoint<C>, b: &EncodedPoint<C>, choice: Choice, ) -> EncodedPoint<C>

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<C> Debug for EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

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

Formats the value using the given formatter.

impl<C> Default for EncodedPoint<C>

where C: Default + PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn default() -> EncodedPoint<C>

Returns the “default value” for a type.

impl<C> From<&PublicKey<C>> for EncodedPoint<C>

where C: PrimeCurve + ProjectiveArithmetic + PointCompression, <C as AffineArithmetic>::AffinePoint: FromEncodedPoint<C> + ToEncodedPoint<C>, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn from(public_key: &PublicKey<C>) -> EncodedPoint<C>

Converts to this type from the input type.

impl<C> From<&VerifyingKey<C>> for EncodedPoint<C>

where C: PrimeCurve + ProjectiveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>, UncompressedPointSize<C>: ArrayLength<u8>,

fn from(verifying_key: &VerifyingKey<C>) -> EncodedPoint<C>

Converts to this type from the input type.

impl<C> From<PublicKey<C>> for EncodedPoint<C>

where C: PrimeCurve + ProjectiveArithmetic + PointCompression, <C as AffineArithmetic>::AffinePoint: FromEncodedPoint<C> + ToEncodedPoint<C>, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn from(public_key: PublicKey<C>) -> EncodedPoint<C>

Converts to this type from the input type.

impl<C> Ord for EncodedPoint<C>

where C: Ord + PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn cmp(&self, other: &EncodedPoint<C>) -> 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<C> PartialEq for EncodedPoint<C>

where C: PartialEq + PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn eq(&self, other: &EncodedPoint<C>) -> 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<C> PartialOrd for EncodedPoint<C>

where C: PartialOrd + PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn partial_cmp(&self, other: &EncodedPoint<C>) -> 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<C> Zeroize for EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<C> Copy for EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>, <<<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output as ArrayLength<u8>>::ArrayType: Copy,

impl<C> Eq for EncodedPoint<C>

where C: Eq + PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,

impl<C> StructuralPartialEq for EncodedPoint<C>

where C: PrimeCurve, <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output: Add<UInt<UTerm, B1>> + ArrayLength<u8>, <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>,