Struct AlgorithmIdentifier 

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

Available on crate feature pkcs8 only.

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, Error>

Assert the algorithm OID is an expected value.

Errors

Returns Error::OidUnknown if self does not match expected_oid.

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

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

Assert parameters is an OID and has the expected value.

Errors

Returns Error::OidUnknown if self.parameters_oid() doesn’t match expected_oid.

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

Assert the values of the algorithm and parameters OIDs.

Errors

Returns Error::OidUnknown if algorithm and/or parameters aren’t the expected values.

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

Get the parameters field as an AnyRef.

Errors

Returns Error::AlgorithmParametersMissing error if self.parameters are None.

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

Get the parameters field as an ObjectIdentifier.

Errors

• Returns Error::AlgorithmParametersMissing error if self.parameters are None.
• Returns Error::Asn1 if self.parameters is not an OID.

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

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.

Errors

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

Trait Implementations

impl<Params> Clone for AlgorithmIdentifier<Params>

where Params: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Params> Debug for AlgorithmIdentifier<Params>

where Params: Debug,

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

Formats the value using the given formatter.

impl<'a, Params> DecodeValue<'a> for AlgorithmIdentifier<Params>

where Params: Choice<'a, Error = Error>,

type Error = Error

Type returned in the event of a decoding error.

fn decode_value<R>( reader: &mut R, _header: Header, ) -> Result<AlgorithmIdentifier<Params>, Error>

where R: Reader<'a>,

Attempt to decode this value using the provided Reader.

impl<Params> EncodeValue for AlgorithmIdentifier<Params>

where Params: Encode,

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

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<(), Error>

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

fn header(&self) -> Result<Header, Error>

where Self: Tagged,

Get the Header used to encode this value.

impl<Params> Hash for AlgorithmIdentifier<Params>

where Params: Hash,

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

where __H: Hasher,

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<Params> Ord for AlgorithmIdentifier<Params>

where Params: Ord,

fn cmp(&self, other: &AlgorithmIdentifier<Params>) -> 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 OwnedToRef for AlgorithmIdentifier<Any>

type Borrowed<'a> = AlgorithmIdentifier<AnyRef<'a>>

The resulting type referencing back to Self

fn owned_to_ref(&self) -> <AlgorithmIdentifier<Any> as OwnedToRef>::Borrowed<'_>

Creates a new object referencing back to the self for storage

impl<Params> PartialEq for AlgorithmIdentifier<Params>

where Params: PartialEq,

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

where Params: PartialOrd,

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

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<'a> RefToOwned<'a> for AlgorithmIdentifier<AnyRef<'a>>

type Owned = AlgorithmIdentifier<Any>

The resulting type after obtaining ownership.

fn ref_to_owned( &self, ) -> <AlgorithmIdentifier<AnyRef<'a>> as RefToOwned<'a>>::Owned

Creates a new object taking ownership of the data

impl<'a, Params> TryFrom<&'a [u8]> for AlgorithmIdentifier<Params>

where Params: Choice<'a, Error = Error> + Encode,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<AlgorithmIdentifier<Params>, Error>

Performs the conversion.

impl<Params> ValueOrd for AlgorithmIdentifier<Params>

where Params: DerOrd,

fn value_cmp( &self, other: &AlgorithmIdentifier<Params>, ) -> Result<Ordering, Error>

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

impl<Params> Copy for AlgorithmIdentifier<Params>

where Params: Copy,

impl<Params> Eq for AlgorithmIdentifier<Params>

where Params: Eq,

impl<'a, Params> Sequence<'a> for AlgorithmIdentifier<Params>

where Params: Choice<'a, Error = Error> + Encode,

impl<Params> StructuralPartialEq for AlgorithmIdentifier<Params>