Struct elliptic_curve::sec1::EncodedPoint

pub struct EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,  { /* fields omitted */ }

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: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

pub fn from_bytes(input: impl AsRef<[u8]>) -> Result<Self, 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, UntaggedPointSize<C>>
) -> Self

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: &FieldBytes<C>,
    y: &FieldBytes<C>,
    compress: bool
) -> Self

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) -> Self where
    C: Curve + ProjectiveArithmetic,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    AffinePoint<C>: ToEncodedPoint<C>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>> + Zeroize, 

This is supported on crate features arithmetic and zeroize only.

Compute EncodedPoint representing the public key for the provided SecretKey.

The compress flag requests point compression.

pub fn identity() -> Self

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]>

This is supported on crate feature alloc only.

Get boxed byte slice containing the serialized EncodedPoint

pub fn to_untagged_bytes(
    &self
) -> Option<GenericArray<u8, UntaggedPointSize<C>>> where
    C: Curve + ProjectiveArithmetic,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>>,
    AffinePoint<C>: ConditionallySelectable + Default + Decompress<C> + ToEncodedPoint<C>, 

This is supported on crate feature arithmetic only.

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

pub fn is_identity(&self) -> bool

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

pub fn is_compressed(&self) -> bool

Is this EncodedPoint compressed?

pub fn compress(&self) -> Self

Compress this EncodedPoint, returning a new EncodedPoint.

pub fn decompress(&self) -> Option<Self> where
    C: Curve + ProjectiveArithmetic,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>>,
    AffinePoint<C>: ConditionallySelectable + Default + Decompress<C> + ToEncodedPoint<C>, 

This is supported on crate feature arithmetic only.

Decompress this EncodedPoint, returning a new EncodedPoint.

pub fn encode<T>(encodable: T, compress: bool) -> Self 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<&FieldBytes<C>>

Get the x-coordinate for this EncodedPoint.

Returns None if this point is the identity point.

pub fn y(&self) -> Option<&FieldBytes<C>>

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: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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

Performs the conversion.

impl<C: Clone> Clone for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> ConditionallySelectable for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,
    <UncompressedPointSize<C> as ArrayLength<u8>>::ArrayType: Copy, 

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

Select a or b according to choice.

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

Conditionally assign other to self, according to choice.

pub 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> Copy for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,
    <UncompressedPointSize<C> as ArrayLength<u8>>::ArrayType: Copy, 

impl<C> Debug for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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

Formats the value using the given formatter.

impl<C: Eq> Eq for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

impl<C, '_> From<&'_ PublicKey<C>> for EncodedPoint<C> where
    C: Curve + ProjectiveArithmetic + Compression,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>>,
    AffinePoint<C>: Copy + Clone + Debug + Default + FromEncodedPoint<C> + ToEncodedPoint<C>,
    ProjectivePoint<C>: From<AffinePoint<C>>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

This is supported on crate feature arithmetic only.

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

Performs the conversion.

impl<C> From<PublicKey<C>> for EncodedPoint<C> where
    C: Curve + ProjectiveArithmetic + Compression,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>>,
    AffinePoint<C>: Copy + Clone + Debug + Default + FromEncodedPoint<C> + ToEncodedPoint<C>,
    ProjectivePoint<C>: From<AffinePoint<C>>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

This is supported on crate feature arithmetic only.

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

Performs the conversion.

impl<C: Ord> Ord for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

pub fn cmp(&self, other: &EncodedPoint<C>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<C: PartialEq> PartialEq<EncodedPoint<C>> for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

pub fn eq(&self, other: &EncodedPoint<C>) -> bool

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

pub fn ne(&self, other: &EncodedPoint<C>) -> bool

This method tests for !=.

impl<C: PartialOrd> PartialOrd<EncodedPoint<C>> for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

pub fn partial_cmp(&self, other: &EncodedPoint<C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &EncodedPoint<C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &EncodedPoint<C>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &EncodedPoint<C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &EncodedPoint<C>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C> StructuralEq for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

impl<C> StructuralPartialEq for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

impl<C, '_> TryFrom<&'_ EncodedPoint<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>>,
    AffinePoint<C>: Copy + Clone + Debug + Default + FromEncodedPoint<C> + ToEncodedPoint<C>,
    ProjectivePoint<C>: From<AffinePoint<C>>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

This is supported on crate feature arithmetic only.

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(encoded_point: &EncodedPoint<C>) -> Result<Self, Error>

Performs the conversion.

impl<C> TryFrom<EncodedPoint<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    FieldBytes<C>: From<Scalar<C>> + for<'r> From<&'r Scalar<C>>,
    Scalar<C>: PrimeField<Repr = FieldBytes<C>>,
    AffinePoint<C>: Copy + Clone + Debug + Default + FromEncodedPoint<C> + ToEncodedPoint<C>,
    ProjectivePoint<C>: From<AffinePoint<C>>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

This is supported on crate feature arithmetic only.

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(encoded_point: EncodedPoint<C>) -> Result<Self, Error>

Performs the conversion.

impl<C> Zeroize for EncodedPoint<C> where
    C: Curve,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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