Struct oid_registry::Oid

source ·
pub struct Oid<'a> { /* private fields */ }
Expand description

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§

source§

impl<'a> Oid<'a>

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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.

source

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

Get the encoded oid without the header.

source

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

👎Deprecated since 0.2.0: Use as_bytes instead

Get the encoded oid without the header.

source

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

Get the bytes representation of the encoded oid

source

pub fn to_id_string(&self) -> String

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.

source

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

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

source

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

source

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

source

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

Returns true if needle is a prefix of the OID.

Trait Implementations§

source§

impl<'a> CheckDerConstraints for Oid<'a>

source§

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

source§

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

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
source§

impl<'a> Debug for Oid<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Display for Oid<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> FromStr for Oid<'a>

§

type Err = OidParseError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

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

source§

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
source§

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

source§

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

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

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

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

impl<'a> Tagged for Oid<'a>

source§

const TAG: Tag = Tag::Oid

source§

impl ToDer for Oid<'_>

source§

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

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

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

Attempt to write the DER header to this writer.
source§

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

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

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

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

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

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

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

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

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

§

type Error = Error

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

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

Performs the conversion.
source§

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

§

type Error = Error

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

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

Performs the conversion.
source§

impl DerAutoDerive for Oid<'_>

source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for Oid<'a>

§

impl<'a> RefUnwindSafe for Oid<'a>

§

impl<'a> Send for Oid<'a>

§

impl<'a> Sync for Oid<'a>

§

impl<'a> Unpin for Oid<'a>

§

impl<'a> UnwindSafe for Oid<'a>

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
source§

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

source§

fn can_decode(tag: Tag) -> bool

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

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

fn tag(&self) -> Tag

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<'a, T, E> FromBer<'a, E> for T
where T: TryFrom<Any<'a>, Error = E>, E: From<Error>,

source§

fn from_ber(bytes: &'a [u8]) -> Result<(&'a [u8], T), Err<E>>

Attempt to parse input bytes into a BER object
source§

impl<'a, T, E> FromDer<'a, E> for T
where T: TryFrom<Any<'a>, Error = E> + CheckDerConstraints + DerAutoDerive, E: From<Error> + Display + Debug,

source§

fn from_der(bytes: &'a [u8]) -> Result<(&'a [u8], T), Err<E>>

Attempt to parse input bytes into a DER object (enforcing constraints)
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> 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.