Struct const_oid::ObjectIdentifier

pub struct ObjectIdentifier<B: AsRef<[u8]> = Buffer<MAX_SIZE>> { /* 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<'a> ObjectIdentifier<&'a [u8]>

pub const fn from_bytes_unchecked(buffer: &'a [u8]) -> Self

Initialize OID from a byte slice without validating that it contains a well-formed BER-encoded OID.

Use with care, e.g. to define compact constants.

impl ObjectIdentifier

Buffer-backed ObjectIdentifier methods.

pub const MAX_SIZE: usize = 39usize

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

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

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

Parse an ObjectIdentifier from the dot-delimited string form.

pub fn from_arcs(arcs: impl IntoIterator<Item = Arc>) -> Result<Self>

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

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

Parse an OID from from its BER/DER encoding.

pub fn parent(&self) -> Option<Self>

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

pub const fn push_arc(self, arc: Arc) -> Result<Self>

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

impl<B> ObjectIdentifier<B>where B: AsRef<[u8]>,

Generic ObjectIdentifier methods that work for any buffer.

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

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

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

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

Returns Arcs, an iterator over Arc values.

pub fn len(&self) -> usize

Get the length of this ObjectIdentifier in arcs.

pub fn starts_with<A>(&self, other: ObjectIdentifier<A>) -> boolwhere A: AsRef<[u8]>,

Does this OID start with the other OID?

pub fn to_ref(&self) -> ObjectIdentifierRef<'_>

Get an ObjectIdentifierRef which borrows from self.

Trait Implementations

impl<'a> Arbitrary<'a> for ObjectIdentifier

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

impl<B> AsRef<[u8]> for ObjectIdentifier<B>where B: AsRef<[u8]>,

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

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

impl<B: Clone + AsRef<[u8]>> Clone for ObjectIdentifier<B>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for ObjectIdentifier<B>where B: AsRef<[u8]>,

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

Formats the value using the given formatter.

impl<B> Display for ObjectIdentifier<B>where B: AsRef<[u8]>,

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

Formats the value using the given formatter.

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<B: Ord + AsRef<[u8]>> Ord for ObjectIdentifier<B>

fn cmp(&self, other: &ObjectIdentifier<B>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<A, B> PartialEq<ObjectIdentifier<A>> for ObjectIdentifier<B>where A: AsRef<[u8]>, B: AsRef<[u8]>,

fn eq(&self, other: &ObjectIdentifier<A>) -> 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<B: PartialOrd + AsRef<[u8]>> PartialOrd for ObjectIdentifier<B>

fn partial_cmp(&self, other: &ObjectIdentifier<B>) -> 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<Self>

Performs the conversion.

impl<B: Copy + AsRef<[u8]>> Copy for ObjectIdentifier<B>

impl<B: AsRef<[u8]>> Eq for ObjectIdentifier<B>