Struct const_oid::ObjectIdentifier

pub struct ObjectIdentifier { /* fields omitted */ }

Object identifier (OID).

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

Implementations

impl ObjectIdentifier

pub const fn new(arcs: &[u32]) -> Self

Create an ObjectIdentifier from a slice of integers, where each integer represents an "arc" (a.k.a. node) in the OID.

Panics

To enable const fn usage and work around current limitations thereof, this method panics in the event the OID is malformed.

For that reason this method is not recommended except for use in constants (where it will generate a compiler error instead). To parse an OID from a &[u32] slice without panicking on error, use TryFrom<&[u32]> instead.

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

• The OID MUST have at least 3 arcs
• The OID MUST NOT have more arcs than the MAX_ARCS constant
• The first arc MUST be within the range 0-2
• The second arc MUST be within the range 0-39

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) in an ObjectIdentifier.

Returns Arcs, an iterator over u32 values representing the value of each arc/node.

pub fn len(&self) -> usize

Number of arcs in this ObjectIdentifier.

pub fn from_ber(bytes: &[u8]) -> Result<Self>

Parse an OID from from its BER/DER encoding.

pub fn ber_len(&self) -> usize

Get the length of this OID when serialized as ASN.1 BER.

pub fn write_ber<'a>(&self, bytes: &'a mut [u8]) -> Result<&'a [u8]>

Write the BER encoding of this OID into the given slice, returning a new slice containing the written data.

pub fn to_ber(&self) -> Vec<u8>

This is supported on crate feature alloc only.

Serialize this OID as ASN.1 BER.

Trait Implementations

impl Clone for ObjectIdentifier

fn clone(&self) -> ObjectIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ObjectIdentifier

impl Debug for ObjectIdentifier

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

Formats the value using the given formatter.

impl Display for ObjectIdentifier

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

Formats the value using the given formatter.

impl Eq for ObjectIdentifier

impl From<&'_ ObjectIdentifier> for ObjectIdentifier

fn from(oid: &ObjectIdentifier) -> ObjectIdentifier

Performs the conversion.

impl FromStr for ObjectIdentifier

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl PartialEq<ObjectIdentifier> for ObjectIdentifier

fn eq(&self, other: &ObjectIdentifier) -> bool

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

fn ne(&self, other: &ObjectIdentifier) -> bool

This method tests for !=.

impl StructuralEq for ObjectIdentifier

impl StructuralPartialEq for ObjectIdentifier

impl TryFrom<&'_ [u32]> for ObjectIdentifier

type Error = Error

The type returned in the event of a conversion error.

fn try_from(arcs: &[u32]) -> Result<Self>

Performs the conversion.