Enum spki::AlgorithmParameters

pub enum AlgorithmParameters<'a> {
    Any(Any<'a>),
    Null,
    Oid(ObjectIdentifier),
}

The parameters field of AlgorithmIdentifier.

This is an algorithm-defined ANY field, but we map it into an enum for now to simplify the ObjectIdentifier use case.

Ideally this type can eventually go away and be replaced by Any with the assistance of OID reference types. See the following tracking issue for more info:

https://github.com/RustCrypto/utils/issues/266

Variants

Any(Any<'a>)

Catch-all ASN.1 ANY type.

Types which don't map to the other variants of this enum will be mapped to this one instead.

Null

ASN.1 NULL value

Oid(ObjectIdentifier)

ObjectIdentifier that names a specific algorithm within a larger algorithm family.

Implementations

impl<'a> AlgorithmParameters<'a>

pub fn any(self) -> Option<Any<'a>>

Get the Any value if applicable.

Note that this will return None in the event the parameter is an OID or NULL.

pub fn oid(self) -> Option<ObjectIdentifier>

Get the OID value if applicable

pub fn is_null(self) -> bool

Is this parameter value NULL?

pub fn is_oid(self) -> bool

Is this parameter value an OID?

Trait Implementations

impl<'a> Clone for AlgorithmParameters<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for AlgorithmParameters<'a>

impl<'a> Debug for AlgorithmParameters<'a>

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

Formats the value using the given formatter.

impl<'a> Encodable for AlgorithmParameters<'a>

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

Compute the length of this value in bytes when encoded as ASN.1 DER.

fn encode(&self, encoder: &mut Encoder<'_>) -> Result<()>

Encode this value as ASN.1 DER using the provided Encoder.

pub fn encode_to_slice(&self, buf: &'a mut [u8]) -> Result<&'a [u8], Error>

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.

impl<'a> Eq for AlgorithmParameters<'a>

impl<'a> From<Null> for AlgorithmParameters<'a>

fn from(_: Null) -> AlgorithmParameters<'a>

Performs the conversion.

impl<'a> From<ObjectIdentifier> for AlgorithmParameters<'a>

fn from(oid: ObjectIdentifier) -> AlgorithmParameters<'a>

Performs the conversion.

impl<'a> PartialEq<AlgorithmParameters<'a>> for AlgorithmParameters<'a>

fn eq(&self, other: &AlgorithmParameters<'a>) -> bool

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

fn ne(&self, other: &AlgorithmParameters<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for AlgorithmParameters<'a>

impl<'a> StructuralPartialEq for AlgorithmParameters<'a>

impl<'a> TryFrom<Any<'a>> for AlgorithmParameters<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: Any<'a>) -> Result<AlgorithmParameters<'a>>

Performs the conversion.