Struct Oid 

pub struct Oid<'a> { /* private fields */ }

Available on crate feature crypto only.

Object ID (OID) representation which can be relative or non-relative.

An example for an OID in string representation is "1.2.840.113549.1.1.5".

For non-relative OIDs restrictions apply to the first two components.

This library contains a procedural macro oid which can be used to create oids. For example oid!(1.2.44.233) or oid!(rel 44.233) for relative oids. See the module documentation for more information.

Implementations

impl<'a> Oid<'a>

pub const fn new(asn1: Cow<'a, [u8]>) -> Oid<'a>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Create an OID from the ASN.1 DER encoded form. See the module documentation for other ways to create oids.

pub const fn new_relative(asn1: Cow<'a, [u8]>) -> Oid<'a>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Create a relative OID from the ASN.1 DER encoded form. See the module documentation for other ways to create relative oids.

pub fn from(s: &[u64]) -> Result<Oid<'static>, OidParseError>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Build an OID from an array of object identifier components. This method allocates memory on the heap.

pub fn from_relative(s: &[u64]) -> Result<Oid<'static>, OidParseError>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Build a relative OID from an array of object identifier components.

pub fn to_owned(&self) -> Oid<'static>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Create a deep copy of the oid.

This method allocates data on the heap. The returned oid can be used without keeping the ASN.1 representation around.

Cloning the returned oid does again allocate data.

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

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Get the encoded oid without the header.

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

👎Deprecated since 0.2.0: Use as_bytes instead

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Get the encoded oid without the header.

pub fn into_cow(self) -> Cow<'a, [u8]>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Get the bytes representation of the encoded oid

pub fn to_id_string(&self) -> String

Available on (crate features rustls or boring or acme) and crate feature rustls and non-crate feature bigint only.

Convert the OID to a string representation.

If every arc fits into a u64 a string like “1.2.840.113549.1.1.5” is returned, otherwise a hex representation.

See also the “bigint” feature of this crate.

pub fn iter(&self) -> Option<impl FusedIterator + ExactSizeIterator>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Return an iterator over the sub-identifiers (arcs). Returns None if at least one arc does not fit into u64.

pub fn from_ber_relative( bytes: &'a [u8], ) -> Result<(&'a [u8], Oid<'a>), Err<Error>>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

pub fn from_der_relative( bytes: &'a [u8], ) -> Result<(&'a [u8], Oid<'a>), Err<Error>>

Available on (crate features rustls or boring or acme) and crate feature rustls only.

pub fn starts_with(&self, needle: &Oid<'_>) -> bool

Available on (crate features rustls or boring or acme) and crate feature rustls only.

Returns true if needle is a prefix of the OID.

Trait Implementations

impl CheckDerConstraints for Oid<'_>

fn check_constraints(any: &Any<'_>) -> Result<(), Error>

impl<'a> Clone for Oid<'a>

fn clone(&self) -> Oid<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Oid<'_>

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

Formats the value using the given formatter.

impl Display for Oid<'_>

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

Formats the value using the given formatter.

impl<'a> From<Oid<'a>> for BerObject<'a>

Build a DER object from an OID.

fn from(oid: Oid<'a>) -> BerObject<'a>

Converts to this type from the input type.

impl FromStr for Oid<'_>

type Err = OidParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Oid<'_>, <Oid<'_> as FromStr>::Err>

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

impl<'a> Hash for Oid<'a>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Oid<'a>

fn eq(&self, other: &Oid<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Tagged for Oid<'_>

const TAG: Tag = Tag::Oid

impl ToDer for Oid<'_>

Available on crate feature std only.

fn to_der_len(&self) -> Result<usize, Error>

Get the length of the object (including the header), when encoded

fn write_der_header( &self, writer: &mut dyn Write, ) -> Result<usize, SerializeError>

Attempt to write the DER header to this writer.

fn write_der_content( &self, writer: &mut dyn Write, ) -> Result<usize, SerializeError>

Attempt to write the DER content (all except header) to this writer.

fn to_der_vec(&self) -> Result<Vec<u8>, SerializeError>

Write the DER encoded representation to a newly allocated Vec<u8>.

fn to_der_vec_raw(&self) -> Result<Vec<u8>, SerializeError>

Similar to using to_vec, but uses provided values without changes. This can generate an invalid encoding for a DER object.

fn write_der(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Attempt to write the DER encoded representation (header and content) into this writer.

fn write_der_raw(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Similar to using to_der, but uses provided values without changes. This can generate an invalid encoding for a DER object.

impl<'a, 'b> TryFrom<&'b Any<'a>> for Oid<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: &'b Any<'a>) -> Result<Oid<'a>, Error>

Performs the conversion.

impl<'a> TryFrom<Any<'a>> for Oid<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: Any<'a>) -> Result<Oid<'a>, Error>

Performs the conversion.

impl DerAutoDerive for Oid<'_>

impl<'a> Eq for Oid<'a>

impl<'a> StructuralPartialEq for Oid<'a>