Struct pkcs8::ObjectIdentifier

pub struct ObjectIdentifier<const MAX_SIZE: usize = const_oid::::ObjectIdentifier::{constant#0}> { /* private fields */ }

Object identifier (OID).

OIDs are hierarchical structures consisting of “arcs”, i.e. integer identifiers.

Validity

In order for an OID to be considered valid by this library, it must meet the following criteria:

• The OID MUST have at least 3 arcs
• The first arc MUST be within the range 0-2
• The second arc MUST be within the range 0-39
• The BER/DER encoding of the OID MUST be shorter than ObjectIdentifier::MAX_SIZE

Implementations

impl ObjectIdentifier

pub const MAX_SIZE: usize = 39usize

Maximum size of a BER/DER-encoded OID in bytes.

pub const fn new_unwrap(s: &str) -> ObjectIdentifier

Parse an ObjectIdentifier from the dot-delimited string form, panicking on parse errors.

This function exists as a workaround for unwrap not yet being stable in const fn contexts, and is intended to allow the result to be bound to a constant value:

use const_oid::ObjectIdentifier;

pub const MY_OID: ObjectIdentifier = ObjectIdentifier::new_unwrap("1.2.840.113549.1.1.1");

In future versions of Rust it should be possible to replace this with ObjectIdentifier::new(...).unwrap().

Use ObjectIdentifier::new for fallible parsing.

pub const fn new(s: &str) -> Result<ObjectIdentifier, Error>

Parse an ObjectIdentifier from the dot-delimited string form.

pub fn from_arcs( arcs: impl IntoIterator<Item = u32> ) -> Result<ObjectIdentifier, Error>

Parse an OID from a slice of [Arc] values (i.e. integers).

pub fn from_bytes(ber_bytes: &[u8]) -> Result<ObjectIdentifier, Error>

Parse an OID from from its BER/DER encoding.

impl<const MAX_SIZE: usize> ObjectIdentifier<MAX_SIZE>

pub const fn as_bytes(&self) -> &[u8]

Get the BER/DER serialization of this OID as bytes.

Note that this encoding omits the ASN.1 tag/length, and only contains the value portion of the encoded OID.

pub const fn as_oid_ref(&self) -> &ObjectIdentifierRef

Borrow an [ObjectIdentifierRef] which corresponds to this ObjectIdentifier.

pub fn parent(&self) -> Option<ObjectIdentifier<MAX_SIZE>>

Get the parent OID of this one (if applicable).

pub const fn push_arc( self, arc: u32 ) -> Result<ObjectIdentifier<MAX_SIZE>, Error>

Push an additional arc onto this OID, returning the child OID.

pub const fn starts_with<const SIZE: usize>( &self, other: ObjectIdentifier<SIZE> ) -> bool

Does this OID start with the other OID?

Methods from Deref<Target = ObjectIdentifierRef>

pub fn as_bytes(&self) -> &[u8]

Get the BER/DER serialization of this OID as bytes.

Note that this encoding omits the ASN.1 tag/length, and only contains the value portion of the encoded OID.

pub fn arc(&self, index: usize) -> Option<u32>

Return the arc with the given index, if it exists.

pub fn arcs(&self) -> Arcs<'_>

Iterate over the arcs (a.k.a. nodes) of an ObjectIdentifier.

Returns [Arcs], an iterator over [Arc] values.

pub fn len(&self) -> usize

Get the length of this ObjectIdentifier in arcs.

Trait Implementations

impl<const MAX_SIZE: usize> AsRef<[u8]> for ObjectIdentifier<MAX_SIZE>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const MAX_SIZE: usize> AsRef<ObjectIdentifierRef> for ObjectIdentifier<MAX_SIZE>

fn as_ref(&self) -> &ObjectIdentifierRef

Converts this type into a shared reference of the (usually inferred) input type.

impl<const MAX_SIZE: usize> Borrow<ObjectIdentifierRef> for ObjectIdentifier<MAX_SIZE>

fn borrow(&self) -> &ObjectIdentifierRef

Immutably borrows from an owned value.

impl<const MAX_SIZE: usize> Clone for ObjectIdentifier<MAX_SIZE>

fn clone(&self) -> ObjectIdentifier<MAX_SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const MAX_SIZE: usize> Debug for ObjectIdentifier<MAX_SIZE>

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

Formats the value using the given formatter.

impl<'a> DecodeValue<'a> for ObjectIdentifier

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

where R: Reader<'a>,

Attempt to decode this message using the provided Reader.

impl<const MAX_SIZE: usize> Deref for ObjectIdentifier<MAX_SIZE>

type Target = ObjectIdentifierRef

The resulting type after dereferencing.

fn deref(&self) -> &ObjectIdentifierRef

Dereferences the value.

impl<const MAX_SIZE: usize> Display for ObjectIdentifier<MAX_SIZE>

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

Formats the value using the given formatter.

impl EncodeValue for ObjectIdentifier

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 FixedTag for ObjectIdentifier

const TAG: Tag = Tag::ObjectIdentifier

ASN.1 tag

impl<'a, const MAX_SIZE: usize> From<&'a ObjectIdentifier<MAX_SIZE>> for &'a ObjectIdentifierRef

fn from(oid: &'a ObjectIdentifier<MAX_SIZE>) -> &'a ObjectIdentifierRef

Converts to this type from the input type.

impl FromStr for ObjectIdentifier

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<ObjectIdentifier, Error>

Parses a string s to return a value of this type.

impl<const MAX_SIZE: usize> Hash for ObjectIdentifier<MAX_SIZE>

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<const MAX_SIZE: usize> Ord for ObjectIdentifier<MAX_SIZE>

fn cmp(&self, other: &ObjectIdentifier<MAX_SIZE>) -> 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<const MAX_SIZE: usize> PartialEq<ObjectIdentifier<MAX_SIZE>> for ObjectIdentifierRef

fn eq(&self, other: &ObjectIdentifier<MAX_SIZE>) -> 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<const MAX_SIZE: usize> PartialEq for ObjectIdentifier<MAX_SIZE>

fn eq(&self, other: &ObjectIdentifier<MAX_SIZE>) -> 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<const MAX_SIZE: usize> PartialOrd for ObjectIdentifier<MAX_SIZE>

fn partial_cmp(&self, other: &ObjectIdentifier<MAX_SIZE>) -> 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 TryFrom<&[u8]> for ObjectIdentifier

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ber_bytes: &[u8]) -> Result<ObjectIdentifier, Error>

Performs the conversion.

impl<const MAX_SIZE: usize> TryFrom<&ObjectIdentifierRef> for ObjectIdentifier<MAX_SIZE>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( oid_ref: &ObjectIdentifierRef ) -> Result<ObjectIdentifier<MAX_SIZE>, Error>

Performs the conversion.

impl TryFrom<AnyRef<'_>> for ObjectIdentifier

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: AnyRef<'_>) -> Result<ObjectIdentifier, Error>

Performs the conversion.

impl<const MAX_SIZE: usize> Copy for ObjectIdentifier<MAX_SIZE>

impl<const MAX_SIZE: usize> Eq for ObjectIdentifier<MAX_SIZE>

impl<const MAX_SIZE: usize> StructuralEq for ObjectIdentifier<MAX_SIZE>

impl<const MAX_SIZE: usize> StructuralPartialEq for ObjectIdentifier<MAX_SIZE>