Struct pkcs5::ObjectIdentifier

pub struct ObjectIdentifier { /* fields omitted */ }

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

Implementations

impl ObjectIdentifier

pub const MAX_LENGTH: usize

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

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

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

use const_oid::ObjectIdentifier;

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

Panics

This method panics in the event the OID is malformed according to the “Validity” rules given in the toplevel documentation for this type.

For that reason this method is ONLY recommended for use in constants (where it will generate a compiler error instead).

To parse an OID from a &str slice fallibly and without panicking, use the FromStr impl instead (or via str’s parse method).

pub fn from_arcs(arcs: &[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 representing the value of each arc/node.

Trait Implementations

impl AsRef<[u8]> for ObjectIdentifier

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

Performs the conversion.

impl Clone for ObjectIdentifier

pub fn clone(&self) -> ObjectIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectIdentifier

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

Formats the value using the given formatter.

impl Display for ObjectIdentifier

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

Formats the value using the given formatter.

impl Encodable for ObjectIdentifier

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

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

pub fn encode(&self, encoder: &mut Encoder<'_>) -> Result<(), Error>

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

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

impl<'_> From<&'_ ObjectIdentifier> for ObjectIdentifier

pub fn from(oid: &ObjectIdentifier) -> ObjectIdentifier

Performs the conversion.

impl FromStr for ObjectIdentifier

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for ObjectIdentifier

pub 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, 

Feeds a slice of this type into the given Hasher.

impl Ord for ObjectIdentifier

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ObjectIdentifier> for ObjectIdentifier

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

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

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

This method tests for !=.

impl PartialOrd<ObjectIdentifier> for ObjectIdentifier

pub fn partial_cmp(&self, other: &ObjectIdentifier) -> 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<'a> Tagged for ObjectIdentifier

pub const TAG: Tag

ASN.1 tag

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'_> TryFrom<Any<'_>> for ObjectIdentifier

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ObjectIdentifier> for EncryptionScheme

type Error = Error

The type returned in the event of a conversion error.

fn try_from(oid: ObjectIdentifier) -> Result<Self>

Performs the conversion.

impl Copy for ObjectIdentifier

impl Eq for ObjectIdentifier

impl StructuralEq for ObjectIdentifier

impl StructuralPartialEq for ObjectIdentifier