pub struct ObjectIdentifier { /* private fields */ }
Available on crate feature pkcs8 only.
Expand description

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.

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

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

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

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

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

Trait Implementations§

§

impl AsRef<[u8]> for ObjectIdentifier

§

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

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

impl Clone for ObjectIdentifier

§

fn clone(&self) -> ObjectIdentifier

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ObjectIdentifier

§

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

Formats the value using the given formatter. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

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> From<&'a ObjectIdentifier> for AnyRef<'a>

§

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

Converts to this type from the input type.
§

impl From<&ObjectIdentifier> for ObjectIdentifier

§

fn from(oid: &ObjectIdentifier) -> ObjectIdentifier

Converts to this type from the input type.
§

impl From<ObjectIdentifier> for Any

Available on crate feature alloc only.
§

fn from(oid: ObjectIdentifier) -> Any

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. Read more
§

impl Hash for ObjectIdentifier

§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl Ord for ObjectIdentifier

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
§

impl PartialEq for ObjectIdentifier

§

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

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

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

§

fn partial_cmp(&self, other: &ObjectIdentifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

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

§

impl Eq for ObjectIdentifier

§

impl StructuralPartialEq for ObjectIdentifier

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<'a, T> Choice<'a> for T
where T: Decode<'a> + FixedTag,

§

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?
§

impl<'a, T> Decode<'a> for T
where T: DecodeValue<'a> + FixedTag,

§

fn decode<R>(reader: &mut R) -> Result<T, Error>
where R: Reader<'a>,

Attempt to decode this message using the provided decoder.
§

fn from_der(bytes: &'a [u8]) -> Result<Self, Error>

Parse Self from the provided DER-encoded byte slice.
§

impl<T> DerOrd for T

§

fn der_cmp(&self, other: &T) -> Result<Ordering, Error>

Return an Ordering between self and other when serialized as ASN.1 DER.
§

impl<T> Encode for T
where T: EncodeValue + Tagged,

§

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

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

§

fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>

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

§

fn encode_to_slice<'a>(&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.
§

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length, Error>

Available on crate feature alloc only.
Encode this message as ASN.1 DER, appending it to the provided byte vector.
§

fn to_der(&self) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.
Encode this type as DER, returning a byte vector.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tagged for T
where T: FixedTag,

§

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> ValueOrd for T
where T: OrdIsValueOrd,

§

fn value_cmp(&self, other: &T) -> Result<Ordering, Error>

Return an Ordering between value portion of TLV-encoded self and other when serialized as ASN.1 DER.
§

impl<T> DecodeOwned for T
where T: for<'a> Decode<'a>,