Struct pkcs1::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
sourceimpl ObjectIdentifier
impl ObjectIdentifier
sourcepub const fn new_unwrap(s: &str) -> ObjectIdentifier
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.
sourcepub const fn new(s: &str) -> Result<ObjectIdentifier, Error>
pub const fn new(s: &str) -> Result<ObjectIdentifier, Error>
Parse an ObjectIdentifier
from the dot-delimited string form.
sourcepub fn from_arcs(
arcs: impl IntoIterator<Item = u32>
) -> Result<ObjectIdentifier, Error>
pub fn from_arcs(
arcs: impl IntoIterator<Item = u32>
) -> Result<ObjectIdentifier, Error>
Parse an OID from a slice of Arc
values (i.e. integers).
sourcepub fn from_bytes(ber_bytes: &[u8]) -> Result<ObjectIdentifier, Error>
pub fn from_bytes(ber_bytes: &[u8]) -> Result<ObjectIdentifier, Error>
Parse an OID from from its BER/DER encoding.
sourcepub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]
pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [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.
sourcepub fn arc(&self, index: usize) -> Option<u32>
pub fn arc(&self, index: usize) -> Option<u32>
Return the arc with the given index, if it exists.
sourcepub fn arcs(&self) -> Arcs<'_>
pub fn arcs(&self) -> Arcs<'_>
Iterate over the arcs (a.k.a. nodes) of an ObjectIdentifier
.
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Get the length of this ObjectIdentifier
in arcs.
sourcepub fn parent(&self) -> Option<ObjectIdentifier>
pub fn parent(&self) -> Option<ObjectIdentifier>
Get the parent OID of this one (if applicable).
Trait Implementations
sourceimpl AsRef<[u8]> for ObjectIdentifier
impl AsRef<[u8]> for ObjectIdentifier
sourceimpl Clone for ObjectIdentifier
impl Clone for ObjectIdentifier
sourcefn clone(&self) -> ObjectIdentifier
fn clone(&self) -> ObjectIdentifier
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for ObjectIdentifier
impl Debug for ObjectIdentifier
sourceimpl<'a> DecodeValue<'a> for ObjectIdentifier
impl<'a> DecodeValue<'a> for ObjectIdentifier
sourcefn decode_value<R>(
reader: &mut R,
header: Header
) -> Result<ObjectIdentifier, Error>where
R: Reader<'a>,
fn decode_value<R>(
reader: &mut R,
header: Header
) -> Result<ObjectIdentifier, Error>where
R: Reader<'a>,
Reader
.sourceimpl Display for ObjectIdentifier
impl Display for ObjectIdentifier
sourceimpl EncodeValue for ObjectIdentifier
impl EncodeValue for ObjectIdentifier
sourceimpl From<&ObjectIdentifier> for ObjectIdentifier
impl From<&ObjectIdentifier> for ObjectIdentifier
sourcefn from(oid: &ObjectIdentifier) -> ObjectIdentifier
fn from(oid: &ObjectIdentifier) -> ObjectIdentifier
sourceimpl FromStr for ObjectIdentifier
impl FromStr for ObjectIdentifier
sourceimpl Hash for ObjectIdentifier
impl Hash for ObjectIdentifier
sourceimpl Ord for ObjectIdentifier
impl Ord for ObjectIdentifier
sourcefn cmp(&self, other: &ObjectIdentifier) -> Ordering
fn cmp(&self, other: &ObjectIdentifier) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<ObjectIdentifier> for ObjectIdentifier
impl PartialEq<ObjectIdentifier> for ObjectIdentifier
sourcefn eq(&self, other: &ObjectIdentifier) -> bool
fn eq(&self, other: &ObjectIdentifier) -> bool
sourceimpl PartialOrd<ObjectIdentifier> for ObjectIdentifier
impl PartialOrd<ObjectIdentifier> for ObjectIdentifier
sourcefn partial_cmp(&self, other: &ObjectIdentifier) -> Option<Ordering>
fn partial_cmp(&self, other: &ObjectIdentifier) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl TryFrom<&[u8]> for ObjectIdentifier
impl TryFrom<&[u8]> for ObjectIdentifier
sourceimpl TryFrom<AnyRef<'_>> for ObjectIdentifier
impl TryFrom<AnyRef<'_>> for ObjectIdentifier
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
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<'a, T> Choice<'a> for Twhere
T: Decode<'a> + FixedTag,
impl<'a, T> Choice<'a> for Twhere
T: Decode<'a> + FixedTag,
sourcefn can_decode(tag: Tag) -> bool
fn can_decode(tag: Tag) -> bool
Tag
decodable as a variant of this CHOICE
?sourceimpl<'a, T> Decode<'a> for Twhere
T: DecodeValue<'a> + FixedTag,
impl<'a, T> Decode<'a> for Twhere
T: DecodeValue<'a> + FixedTag,
sourceimpl<T> DerOrd for Twhere
T: EncodeValue + ValueOrd + Tagged,
impl<T> DerOrd for Twhere
T: EncodeValue + ValueOrd + Tagged,
sourceimpl<T> Encode for Twhere
T: EncodeValue + Tagged,
impl<T> Encode for Twhere
T: EncodeValue + Tagged,
sourcefn encoded_len(&self) -> Result<Length, Error>
fn encoded_len(&self) -> Result<Length, Error>
Compute the length of this value in bytes when encoded as ASN.1 DER.
sourcefn encode(&self, writer: &mut dyn Writer) -> Result<(), Error>
fn encode(&self, writer: &mut dyn Writer) -> Result<(), Error>
Encode this value as ASN.1 DER using the provided Writer
.