Struct pkcs8::AlgorithmIdentifier

pub struct AlgorithmIdentifier<'a> {
    pub oid: ObjectIdentifier,
    pub parameters: Option<AnyRef<'a>>,
}

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<AnyRef<'a>>

Algorithm parameters.

Implementations

impl<'a> AlgorithmIdentifier<'a>

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

Assert the algorithm OID is an expected value.

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

Assert parameters is an OID and has the expected value.

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

Assert the values of the algorithm and parameters OIDs.

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

Get the parameters field as an AnyRef.

Returns an error if parameters are None.

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

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>), 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.

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

Trait Implementations

impl<'a> Clone for AlgorithmIdentifier<'a>

fn clone(&self) -> AlgorithmIdentifier<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AlgorithmIdentifier<'a>

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

Formats the value using the given formatter.

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

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

where R: Reader<'a>,

Attempt to decode this message using the provided Reader.

impl<'a> Ord for AlgorithmIdentifier<'a>

fn cmp(&self, other: &AlgorithmIdentifier<'a>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for AlgorithmIdentifier<'a>

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

fn partial_cmp(&self, other: &AlgorithmIdentifier<'a>) -> 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> Sequence<'a> for AlgorithmIdentifier<'a>

fn fields<F, T>(&self, f: F) -> Result<T, Error>

where F: FnOnce(&[&dyn Encode]) -> Result<T, Error>,

Call the provided function with a slice of Encode trait objects representing the fields of this SEQUENCE.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValueOrd for AlgorithmIdentifier<'_>

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

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

impl<'a> Copy for AlgorithmIdentifier<'a>

impl<'a> Eq for AlgorithmIdentifier<'a>

impl<'a> StructuralPartialEq for AlgorithmIdentifier<'a>