Struct cryptographic_message_syntax::Oid

pub struct Oid<T = Bytes>(pub T) 
where
    T: AsRef<[u8]>;

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

impl Oid<Bytes>

Decoding and Encoding

pub fn skip_in<S>(
    cons: &mut Constructed<'_, S>
) -> Result<(), DecodeError<<S as Source>::Error>> where
    S: Source, 

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.

pub fn skip_opt_in<S>(
    cons: &mut Constructed<'_, S>
) -> Result<Option<()>, DecodeError<<S as Source>::Error>> where
    S: Source, 

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.

pub fn take_from<S>(
    constructed: &mut Constructed<'_, S>
) -> Result<Oid<Bytes>, DecodeError<<S as Source>::Error>> where
    S: Source, 

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.

pub fn take_opt_from<S>(
    constructed: &mut Constructed<'_, S>
) -> Result<Option<Oid<Bytes>>, DecodeError<<S as Source>::Error>> where
    S: Source, 

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.

impl<T> Oid<T> where
    T: AsRef<[u8]>, 

pub fn skip_if<S>(
    &self,
    constructed: &mut Constructed<'_, S>
) -> Result<(), DecodeError<<S as Source>::Error>> where
    S: Source, 

Skip over an object identifier if it matches self.

impl<T> Oid<T> where
    T: AsRef<[u8]>, 

Access to Sub-identifiers

pub fn iter(&self) -> Iter<'_>

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

impl<T> AsRef<[u8]> for Oid<T> where
    T: AsRef<[u8]>, 

fn as_ref(&self) -> &[u8]

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

impl<T> Clone for Oid<T> where
    T: Clone + AsRef<[u8]>, 

fn clone(&self) -> Oid<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Oid<T> where
    T: Debug + AsRef<[u8]>, 

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

Formats the value using the given formatter.

impl<T> Display for Oid<T> where
    T: AsRef<[u8]>, 

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

Formats the value using the given formatter.

impl From<DigestAlgorithm> for Oid<Bytes>

fn from(alg: DigestAlgorithm) -> Oid<Bytes>

Converts to this type from the input type.

impl From<KeyAlgorithm> for Oid<Bytes>

fn from(alg: KeyAlgorithm) -> Oid<Bytes>

Converts to this type from the input type.

impl From<SignatureAlgorithm> for Oid<Bytes>

fn from(alg: SignatureAlgorithm) -> Oid<Bytes>

Converts to this type from the input type.

impl<T> Hash for Oid<T> where
    T: AsRef<[u8]>, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T, U> PartialEq<Oid<U>> for Oid<T> where
    T: AsRef<[u8]>,
    U: AsRef<[u8]>, 

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

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

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

This method tests for !=.

impl<T> PrimitiveContent for Oid<T> where
    T: AsRef<[u8]>, 

const TAG: Tag = Tag::OID

The natural tag of an encoded value of this type.

fn encoded_len(&self, Mode) -> usize

Returns the length of the encoded content of this type.

fn write_encoded<W>(&self, Mode, target: &mut W) -> Result<(), Error> where
    W: Write, 

Writes the encoded content to a writer.

fn to_encoded_bytes(&self, mode: Mode) -> Bytes

Encodes the value to bytes (useful when you need to sign a structure)

fn encode(self) -> Primitive<Self>

Returns a value encoder for this content using the natural tag.

fn encode_as(self, tag: Tag) -> Primitive<Self>

Returns a value encoder for this content using the given tag.

fn encode_ref(&self) -> Primitive<&Self>

Returns a value encoder for a reference using the natural tag.

fn encode_ref_as(&self, tag: Tag) -> Primitive<&Self>

Returns a value encoder for a reference using the given tag.

impl<T> Eq for Oid<T> where
    T: AsRef<[u8]>,