Struct spki::AlgorithmIdentifier

pub struct AlgorithmIdentifier<Params> {
    pub oid: ObjectIdentifier,
    pub parameters: Option<Params>,
}

X.509 AlgorithmIdentifier as defined in RFC 5280 Section 4.1.1.2.

AlgorithmIdentifier  ::=  SEQUENCE  {
     algorithm               OBJECT IDENTIFIER,
     parameters              ANY DEFINED BY algorithm OPTIONAL  }

Fields

oid: ObjectIdentifier

Algorithm OID, i.e. the algorithm field in the AlgorithmIdentifier ASN.1 schema.

parameters: Option<Params>

Algorithm parameters.

Implementations

impl<Params> AlgorithmIdentifier<Params>

pub fn assert_algorithm_oid( &self, expected_oid: ObjectIdentifier ) -> Result<ObjectIdentifier>

Assert the algorithm OID is an expected value.

impl<'a> AlgorithmIdentifier<AnyRef<'a>>

pub fn assert_parameters_oid( &self, expected_oid: ObjectIdentifier ) -> Result<ObjectIdentifier>

Assert parameters is an OID and has the expected value.

pub fn assert_oids( &self, algorithm: ObjectIdentifier, parameters: ObjectIdentifier ) -> Result<()>

Assert the values of the algorithm and parameters OIDs.

pub fn parameters_any(&self) -> Result<AnyRef<'a>>

Get the parameters field as an AnyRef.

Returns an error if parameters are None.

pub fn parameters_oid(&self) -> Result<ObjectIdentifier>

Get the parameters field as an ObjectIdentifier.

Returns an error if it is absent or not an OID.

pub fn oids(&self) -> Result<(ObjectIdentifier, Option<ObjectIdentifier>)>

Convert to a pair of ObjectIdentifiers.

This method is helpful for decomposing in match statements. Note in particular that NULL parameters are treated the same as missing parameters.

Returns an error if parameters are present but not an OID.

Trait Implementations

impl<'arbitrary, Params: Arbitrary<'arbitrary>> Arbitrary<'arbitrary> for AlgorithmIdentifier<Params>

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<Params: Clone> Clone for AlgorithmIdentifier<Params>

fn clone(&self) -> AlgorithmIdentifier<Params>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Params: Debug> Debug for AlgorithmIdentifier<Params>

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

Formats the value using the given formatter.

impl<'a, Params> DecodeValue<'a> for AlgorithmIdentifier<Params>where Params: Choice<'a>,

fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self>

Attempt to decode this message using the provided Reader.

impl<Params> EncodeValue for AlgorithmIdentifier<Params>where Params: Encode,

fn value_len(&self) -> Result<Length>

Compute the length of this value (sans [Tag]+Length header) when encoded as ASN.1 DER.

fn encode_value(&self, writer: &mut impl Writer) -> Result<()>

Encode value (sans [Tag]+Length header) as ASN.1 DER using the provided Writer.

impl<Params: Ord> Ord for AlgorithmIdentifier<Params>

fn cmp(&self, other: &AlgorithmIdentifier<Params>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<Params: PartialEq> PartialEq<AlgorithmIdentifier<Params>> for AlgorithmIdentifier<Params>

fn eq(&self, other: &AlgorithmIdentifier<Params>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Params: PartialOrd> PartialOrd<AlgorithmIdentifier<Params>> for AlgorithmIdentifier<Params>

fn partial_cmp(&self, other: &AlgorithmIdentifier<Params>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<'a, Params> TryFrom<&'a [u8]> for AlgorithmIdentifier<Params>where Params: Choice<'a> + Encode,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<Self>

Performs the conversion.

impl<Params> ValueOrd for AlgorithmIdentifier<Params>where Params: DerOrd,

fn value_cmp(&self, other: &Self) -> Result<Ordering>

Return an Ordering between value portion of TLV-encoded self and other when serialized as ASN.1 DER.

impl<Params: Copy> Copy for AlgorithmIdentifier<Params>

impl<Params: Eq> Eq for AlgorithmIdentifier<Params>

impl<'a, Params> Sequence<'a> for AlgorithmIdentifier<Params>where Params: Choice<'a> + Encode,

impl<Params> StructuralEq for AlgorithmIdentifier<Params>

impl<Params> StructuralPartialEq for AlgorithmIdentifier<Params>