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: &[Arc]) -> Self

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

NOTE: this method is soft-deprecated and will be removed in a future release. We recommend using ObjectIdentifier::parse going forward (which will be renamed to ObjectIdentifier::new in a future release).

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 &[Arc] slice without panicking on error, use TryFrom<&[Arc]> instead.

In order for an OID to be valid, 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 the MAX_LEN constant

pub const fn parse(s: &str) -> Self

Parse an ObjectIdentifier from the dot-delimited string form, e.g.:

use const_oid::ObjectIdentifier;

const MY_OID: ObjectIdentifier = ObjectIdentifier::parse("1.2.840.113549.1.1.1");

Like ObjectIdentifier::new, this version is intended for use in const contexts. where it will generate compile errors in the event the OID is malformed.

This method is NOT intended for use outside of const contexts, as it will panic with a bad error message. However, this type also has a FromStr impl that can be used for fallible parsing.

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

Get the BER/DER serialization of this OID as bytes

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

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 Arc values representing the value of each arc/node.

pub fn len(&self) -> usize

Number of arcs in this ObjectIdentifier.

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

Parse an OID from from its BER/DER encoding.

pub fn ber_len(&self) -> usize

👎 Deprecated since 0.4.4:

Please use the as_bytes() function instead

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]>

👎 Deprecated since 0.4.4:

Please use the as_bytes() function instead

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>

👎 Deprecated since 0.4.4:

Please use the as_bytes() function instead

This is supported on crate feature alloc only.

Serialize this OID as ASN.1 BER.

Trait Implementations

impl AsRef<[u8]> for ObjectIdentifier

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

Performs the conversion.

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(string: &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: &[Arc]) -> Result<Self>

Performs the conversion.