Struct CurveName

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

A guard type asserting that deserialized value belongs to curve E

It implements serde::Serialize and serde::Deserialize traits if serde feature is enabled. When serialized, CurveName is converted into string containing curve name. When deserialized, it parses a string and requires it to match curve name, otherwise deserialization error is returned.

This structure is present even if serde feature is disabled.

Example

use generic_ec::{serde::CurveName, curves::{Secp256k1, Secp256r1}};
use serde_json::Value;

let curve_name = CurveName::<Secp256k1>::new();
let value = serde_json::to_value(&curve_name)?;
assert_eq!(value, Value::String("secp256k1".into()));

// `value` can be deserialized back to `CurveName<Secp256k1>`
let _curve_name: CurveName<Secp256k1> = serde_json::from_value(value.clone())?;

// but it can't be deserialized to `CurveName<Secp256r1>`
let serialization_fails = serde_json::from_value::<CurveName<Secp256r1>>(value);
assert!(serialization_fails.is_err());

Implementations

impl<E: Curve> CurveName<E>

pub fn new() -> Self

Construct a CurveName guard

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Curve> Debug for CurveName<E>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'de, E: Curve> Deserialize<'de> for CurveName<E>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: Hash + Curve> Hash for CurveName<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: Ord + Curve> Ord for CurveName<E>

fn cmp(&self, other: &CurveName<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 CurveName<E>

fn eq(&self, other: &CurveName<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 CurveName<E>

fn partial_cmp(&self, other: &CurveName<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> Serialize for CurveName<E>

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

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

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

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