Struct der_parser::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: &'b [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: &'b [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 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get the encoded oid without the header.

source

pub fn bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [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 Iterator<Item = u64> + 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>>

Trait Implementations

source

pub 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

pub 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

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

Formats the value using the given formatter. Read more

source

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

Build a DER object from an OID.

source

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

Performs the conversion.

source

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

type Err = OidParseError

The associated error which can be returned from parsing.

source

pub 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

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

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

source

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

source

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

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

source

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

This method tests for !=.

source

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

source

pub const TAG: Tag

source

impl<'_> ToDer for Oid<'_>

source

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

Get the length of the object, when encoded Read more

source

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

Attempt to write the DER header to this writer.

source

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

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

source

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

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

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

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

source

impl<'a> StructuralEq for Oid<'a>

source

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

Auto Trait Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

source

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

source

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

source

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

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

pub 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

pub fn can_decode(tag: Tag) -> bool

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

source

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

source

pub fn tag(&self) -> Tag

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

source

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

Attempt to parse input bytes into a BER object

source

impl<'a, T> FromDer<'a> for T where
T: TryFrom<Any<'a>, Error = Error> + CheckDerConstraints,

source

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

Attempt to parse input bytes into a DER object (enforcing constraints)

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct der_parser::Oid

Implementations

impl<'a> Oid<'a>

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

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

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

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

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

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn bytes(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

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

pub fn to_id_string(&self) -> String

pub fn iter( &self) -> Option<impl Iterator<Item = u64> + FusedIterator + ExactSizeIterator>

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

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

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

type Err = OidParseError

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

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

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

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

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

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

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

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

pub const TAG: Tag

impl<'_> ToDer for Oid<'_>

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

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

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

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

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

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

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

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

type Error = Error

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

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

impl<'a> StructuralEq for Oid<'a>

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

Auto Trait Implementations

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

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

pub fn type_id(&self) -> TypeId

impl<'a, T> AsTaggedExplicit<'a> for T where T: 'a,

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

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

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

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

pub fn borrow(&self) -> &T

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

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

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

pub fn can_decode(tag: Tag) -> bool

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

pub fn tag(&self) -> Tag

impl<T> From<T> for T

pub fn from(t: T) -> T

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

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

impl<'a, T> FromDer<'a> for T where T: TryFrom<Any<'a>, Error = Error> + CheckDerConstraints,

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

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

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

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

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

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

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

pub fn iter(
&self
) -> Option<impl Iterator<Item = u64> + FusedIterator + ExactSizeIterator>

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

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

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

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

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

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

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

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

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

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

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

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

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

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

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

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

impl<'a, T> FromDer<'a> for T where
T: TryFrom<Any<'a>, Error = Error> + CheckDerConstraints,

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

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

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

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

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

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