Struct spki::ObjectIdentifier

source · [−]

pub struct ObjectIdentifier { /* private fields */ }

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

source

impl ObjectIdentifier

source

pub const MAX_SIZE: usize = 39usize

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

source

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.

source

pub const fn new(s: &str) -> Result<ObjectIdentifier, Error>

Parse an ObjectIdentifier from the dot-delimited string form.

source

pub fn from_arcs(
arcs: impl IntoIterator<Item = u32>
) -> Result<ObjectIdentifier, Error>

Parse an OID from a slice of Arc values (i.e. integers).

source

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

Parse an OID from from its BER/DER encoding.

source

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

source

pub fn arc(&self, index: usize) -> Option<u32>

Return the arc with the given index, if it exists.

source

pub fn arcs(&self) -> Arcs<'_>

Iterate over the arcs (a.k.a. nodes) of an ObjectIdentifier.

Returns Arcs, an iterator over Arc values.

source

pub fn len(&self) -> usize

Get the length of this ObjectIdentifier in arcs.

source

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

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

source

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

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

Trait Implementations

source

impl AsRef<[u8 ]> for ObjectIdentifier

source

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

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

source

impl Clone for ObjectIdentifier

source

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

source

impl Debug for ObjectIdentifier

source

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

Formats the value using the given formatter. Read more

source

impl<'a> DecodeValue<'a> for ObjectIdentifier

source

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.

source

impl Display for ObjectIdentifier

source

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

Formats the value using the given formatter. Read more

source

impl EncodeValue for ObjectIdentifier

source

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

Compute the length of this value (sans [Tag]+Length header) when encoded as ASN.1 DER. Read more

source

fn encode_value(&self, writer: &mut dyn Writer) -> Result<(), Error>

Encode value (sans [Tag]+Length header) as ASN.1 DER using the provided Writer. Read more

Get the Header used to encode this value.

source

impl FixedTag for ObjectIdentifier

source

const TAG: Tag = Tag::ObjectIdentifier

ASN.1 tag

source

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

source

fn from(oid: &ObjectIdentifier) -> ObjectIdentifier

Converts to this type from the input type.

source

impl FromStr for ObjectIdentifier

type Err = Error

The associated error which can be returned from parsing.

source

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

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

source

impl Hash for ObjectIdentifier

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,

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

source

impl Ord for ObjectIdentifier

source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<ObjectIdentifier> for ObjectIdentifier

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<ObjectIdentifier> for ObjectIdentifier

source

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

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl StructuralPartialEq for ObjectIdentifier

Auto Trait Implementations

impl RefUnwindSafe for ObjectIdentifier

impl Send for ObjectIdentifier

impl Sync for ObjectIdentifier

impl Unpin for ObjectIdentifier

impl UnwindSafe for ObjectIdentifier

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,

const: unstable · source

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

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

Mutably borrows from an owned value. Read more

source

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

source

fn can_decode(tag: Tag) -> bool

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

source

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

source

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

Attempt to decode this message using the provided decoder.

source

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

Parse Self from the provided DER-encoded byte slice.

source

impl<T> DerOrd for T where
T: EncodeValue + ValueOrd + Tagged,

source

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

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

source

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

source

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

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

source

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

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

source

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

source

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

Encode this message as ASN.1 DER, appending it to the provided byte vector. Read more

source

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

Serialize this message as a byte vector.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

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

source

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)

🔬 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

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

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

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

Performs the conversion.

source

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

source

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

source

Struct spki::ObjectIdentifier

Implementations

impl ObjectIdentifier

pub const MAX_SIZE: usize = 39usize

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

pub const fn new(s: &str) -> Result<ObjectIdentifier, Error>

pub fn from_arcs( arcs: impl IntoIterator<Item = u32>) -> Result<ObjectIdentifier, Error>

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

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

pub fn arc(&self, index: usize) -> Option<u32>

pub fn arcs(&self) -> Arcs<'_>

pub fn len(&self) -> usize

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

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

Trait Implementations

impl AsRef<[u8]> for ObjectIdentifier

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

impl Clone for ObjectIdentifier

fn clone(&self) -> ObjectIdentifier

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

impl Debug for ObjectIdentifier

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

impl<'a> DecodeValue<'a> for ObjectIdentifier

fn decode_value<R>( reader: &mut R, header: Header) -> Result<ObjectIdentifier, Error> where R: Reader<'a>,

impl Display for ObjectIdentifier

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

impl EncodeValue for ObjectIdentifier

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

fn encode_value(&self, writer: &mut dyn Writer) -> Result<(), Error>

fn header(&self) -> Result<Header, Error> where Self: Tagged,

impl FixedTag for ObjectIdentifier

const TAG: Tag = Tag::ObjectIdentifier

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

fn from(oid: &ObjectIdentifier) -> ObjectIdentifier

impl FromStr for ObjectIdentifier

type Err = Error

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

impl Hash for ObjectIdentifier

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

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

impl Ord for ObjectIdentifier

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

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

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

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

impl PartialEq<ObjectIdentifier> for ObjectIdentifier

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

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

impl PartialOrd<ObjectIdentifier> for ObjectIdentifier

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

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

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

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

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

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

type Error = Error

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

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

type Error = Error

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

impl Copy for ObjectIdentifier

impl Eq for ObjectIdentifier

impl StructuralEq for ObjectIdentifier

impl StructuralPartialEq for ObjectIdentifier

Auto Trait Implementations

impl RefUnwindSafe for ObjectIdentifier

impl Send for ObjectIdentifier

impl Sync for ObjectIdentifier

impl Unpin for ObjectIdentifier

impl UnwindSafe for ObjectIdentifier

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

fn can_decode(tag: Tag) -> bool

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

pub fn from_arcs(
arcs: impl IntoIterator<Item = u32>
) -> Result<ObjectIdentifier, Error>

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

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

impl AsRef<[u8 ]> for ObjectIdentifier

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

fn decode_value<R>(
reader: &mut R,
header: Header
) -> Result<ObjectIdentifier, Error> where
R: Reader<'a>,

fn header(&self) -> Result<Header, Error> where
Self: Tagged,

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

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

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

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

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

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

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

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

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

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

impl<T> DerOrd for T where
T: EncodeValue + ValueOrd + Tagged,

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

fn encode_to_slice(&self, buf: &'a mut [u8 ]) -> Result<&'a [u8 ], Error>

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

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

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

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

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