Expand description
An object identifer.
Object identifiers are globally unique, hierarchical values that are used to identify objects or their type. When written, they are presented as a sequence of integers separated by dots such as ‘1.3.6.1.5.5.7.1’ or with the integers separated by white space and enclosed in curly braces such as ‘{ 1 3 6 1 5 5 7 1 }’. Individual integers or sequences of integers can also be given names which then are used instead of the integers.
Values of this type keep a single object identifer in its BER encoding,
i.e., in some form of byte sequence. Because different representations
may be useful, the type is actually generic over something that can
become a reference to a bytes slice. Parsing is only defined for Bytes
values, though.
The only use for object identifiers currently is to compare them to
predefined values. For this purpose, you typically define your known
object identifiers in a oid
submodule as contants of
Oid<&'static [u8]>
– or its type alias ConstOid
. This is also the
reason why the wrapped value is pub
for now. This will change once
const fn
is stable.
Unfortunately, there is currently no proc macro to generate the object
identifier constants in the code. Instead, the crate ships with a
mkoid
binary which accepts object identifiers in ‘dot integer’ notation
and produces the u8
array for their encoded value. You can install
this binary via cargo install ber
.
Tuple Fields
0: T
Implementations
sourceimpl Oid<Bytes>
impl Oid<Bytes>
sourcepub fn skip_in<S: Source>(
cons: &mut Constructed<'_, S>
) -> Result<(), DecodeError<S::Error>>
pub fn skip_in<S: Source>(
cons: &mut Constructed<'_, S>
) -> Result<(), DecodeError<S::Error>>
Skips over an object identifier value.
If the source has reached its end, if the next value does not have
the Tag::OID
, or if it is not a primitive value, returns a malformed
error.
sourcepub fn skip_opt_in<S: Source>(
cons: &mut Constructed<'_, S>
) -> Result<Option<()>, DecodeError<S::Error>>
pub fn skip_opt_in<S: Source>(
cons: &mut Constructed<'_, S>
) -> Result<Option<()>, DecodeError<S::Error>>
Skips over an optional object identifier value.
If the source has reached its end of if the next value does not have
the Tag::OID
, returns Ok(None)
. If the next value has the right
tag but is not a primitive value, returns a malformed error.
sourcepub fn take_from<S: Source>(
constructed: &mut Constructed<'_, S>
) -> Result<Self, DecodeError<S::Error>>
pub fn take_from<S: Source>(
constructed: &mut Constructed<'_, S>
) -> Result<Self, DecodeError<S::Error>>
Takes an object identifier value from the source.
If the source has reached its end, if the next value does not have
the Tag::OID
, or if it is not a primitive value, returns a malformed
error.
sourcepub fn take_opt_from<S: Source>(
constructed: &mut Constructed<'_, S>
) -> Result<Option<Self>, DecodeError<S::Error>>
pub fn take_opt_from<S: Source>(
constructed: &mut Constructed<'_, S>
) -> Result<Option<Self>, DecodeError<S::Error>>
Takes an optional object identifier value from the source.
If the source has reached its end of if the next value does not have
the Tag::OID
, returns Ok(None)
. If the next value has the right
tag but is not a primitive value, returns a malformed error.
sourceimpl<T: AsRef<[u8]>> Oid<T>
impl<T: AsRef<[u8]>> Oid<T>
sourcepub fn skip_if<S: Source>(
&self,
constructed: &mut Constructed<'_, S>
) -> Result<(), DecodeError<S::Error>>
pub fn skip_if<S: Source>(
&self,
constructed: &mut Constructed<'_, S>
) -> Result<(), DecodeError<S::Error>>
Skip over an object identifier if it matches self
.
sourceimpl<T: AsRef<[u8]>> Oid<T>
impl<T: AsRef<[u8]>> Oid<T>
sourcepub fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = Component<'a>;
pub fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = Component<'a>;
Returns an iterator to the components of this object identifiers.
Panics
The returned identifier will eventually panic if self
does not
contain a correctly encoded object identifier.
Trait Implementations
sourceimpl<T: AsRef<[u8]>> PrimitiveContent for Oid<T>
impl<T: AsRef<[u8]>> PrimitiveContent for Oid<T>
sourcefn encoded_len(&self, _: Mode) -> usize
fn encoded_len(&self, _: Mode) -> usize
Returns the length of the encoded content of this type.
sourcefn write_encoded<W: Write>(&self, _: Mode, target: &mut W) -> Result<(), Error>
fn write_encoded<W: Write>(&self, _: Mode, target: &mut W) -> Result<(), Error>
Writes the encoded content to a writer.
sourcefn to_encoded_bytes(&self, mode: Mode) -> Bytes
fn to_encoded_bytes(&self, mode: Mode) -> Bytes
Encodes the value to bytes (useful when you need to sign a structure)
sourcefn encode(self) -> Primitive<Self>
fn encode(self) -> Primitive<Self>
Returns a value encoder for this content using the natural tag. Read more
sourcefn encode_as(self, tag: Tag) -> Primitive<Self>
fn encode_as(self, tag: Tag) -> Primitive<Self>
Returns a value encoder for this content using the given tag. Read more
sourcefn encode_ref(&self) -> Primitive<&Self>
fn encode_ref(&self) -> Primitive<&Self>
Returns a value encoder for a reference using the natural tag.
sourcefn encode_ref_as(&self, tag: Tag) -> Primitive<&Self>
fn encode_ref_as(&self, tag: Tag) -> Primitive<&Self>
Returns a value encoder for a reference using the given tag.
impl<T: AsRef<[u8]>> Eq for Oid<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for Oid<T> where
T: RefUnwindSafe,
impl<T> Send for Oid<T> where
T: Send,
impl<T> Sync for Oid<T> where
T: Sync,
impl<T> Unpin for Oid<T> where
T: Unpin,
impl<T> UnwindSafe for Oid<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more