Struct der_parser::ber::BerObject
source · pub struct BerObject<'a> {
pub header: BerObjectHeader<'a>,
pub content: BerObjectContent<'a>,
}
Expand description
Representation of a DER-encoded (X.690) object
Fields§
§header: BerObjectHeader<'a>
§content: BerObjectContent<'a>
Implementations§
source§impl<'a> BerObject<'a>
impl<'a> BerObject<'a>
sourcepub fn from_header_and_content<'hdr>(
header: BerObjectHeader<'hdr>,
content: BerObjectContent<'hdr>
) -> BerObject<'hdr>
pub fn from_header_and_content<'hdr>( header: BerObjectHeader<'hdr>, content: BerObjectContent<'hdr> ) -> BerObject<'hdr>
Build a BerObject from a header and content. Note: values are not checked, so the tag can be different from the real content, or flags can be invalid.
sourcepub fn from_obj(c: BerObjectContent<'_>) -> BerObject<'_>
pub fn from_obj(c: BerObjectContent<'_>) -> BerObject<'_>
Build a BerObject from its content, using default flags (no class, correct tag, and structured flag set only for Set and Sequence)
sourcepub fn from_int_slice(i: &'a [u8]) -> BerObject<'a>
pub fn from_int_slice(i: &'a [u8]) -> BerObject<'a>
Build a DER integer object from a slice containing an encoded integer
sourcepub fn set_raw_tag(self, raw_tag: Option<&'a [u8]>) -> BerObject<'_>
pub fn set_raw_tag(self, raw_tag: Option<&'a [u8]>) -> BerObject<'_>
Set a tag for the BER object
sourcepub fn from_seq(l: Vec<BerObject<'_>>) -> BerObject<'_>
pub fn from_seq(l: Vec<BerObject<'_>>) -> BerObject<'_>
Build a DER sequence object from a vector of DER objects
sourcepub fn from_set(l: Vec<BerObject<'_>>) -> BerObject<'_>
pub fn from_set(l: Vec<BerObject<'_>>) -> BerObject<'_>
Build a DER set object from a vector of DER objects
sourcepub fn to_header(&self) -> BerObjectHeader<'_>
👎Deprecated since 0.5.0: please use obj.header
or obj.header.clone()
instead
pub fn to_header(&self) -> BerObjectHeader<'_>
obj.header
or obj.header.clone()
insteadBuild a BER header from this object content
sourcepub fn as_u64(&self) -> Result<u64, BerError>
pub fn as_u64(&self) -> Result<u64, BerError>
Attempt to read integer value from DER object. This can fail if the object is not an integer, or if it is too large.
let der_int = BerObject::from_int_slice(b"\x01\x00\x01");
assert_eq!(
der_int.as_u64(),
Ok(0x10001)
);
sourcepub fn as_u32(&self) -> Result<u32, BerError>
pub fn as_u32(&self) -> Result<u32, BerError>
Attempt to read integer value from DER object. This can fail if the object is not an integer, or if it is too large.
let der_int = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
assert_eq!(
der_int.as_u32(),
Ok(0x10001)
);
sourcepub fn as_bool(&self) -> Result<bool, BerError>
pub fn as_bool(&self) -> Result<bool, BerError>
Attempt to read integer value from DER object. This can fail if the object is not a boolean.
sourcepub fn as_oid(&self) -> Result<&Oid<'a>, BerError>
pub fn as_oid(&self) -> Result<&Oid<'a>, BerError>
Attempt to read an OID value from DER object. This can fail if the object is not an OID.
sourcepub fn as_oid_val(&self) -> Result<Oid<'a>, BerError>
pub fn as_oid_val(&self) -> Result<Oid<'a>, BerError>
Attempt to read an OID value from DER object. This can fail if the object is not an OID.
sourcepub fn as_context_specific(
&self
) -> Result<(BerTag, Option<Box<BerObject<'a>>>), BerError>
pub fn as_context_specific( &self ) -> Result<(BerTag, Option<Box<BerObject<'a>>>), BerError>
Attempt to read the content from a context-specific DER object. This can fail if the object is not context-specific.
Note: the object is cloned.
sourcepub fn as_bitstring_ref(&self) -> Result<&BitStringObject<'_>, BerError>
pub fn as_bitstring_ref(&self) -> Result<&BitStringObject<'_>, BerError>
Attempt to read a reference to a BitString value from DER object. This can fail if the object is not an BitString.
Note that this function returns a reference to the BitString. To get an owned value,
use as_bitstring
sourcepub fn as_bitstring(&'a self) -> Result<BitStringObject<'a>, BerError>
pub fn as_bitstring(&'a self) -> Result<BitStringObject<'a>, BerError>
Attempt to read a BitString value from DER object. This can fail if the object is not an BitString.
sourcepub fn as_sequence(&self) -> Result<&Vec<BerObject<'a>>, BerError>
pub fn as_sequence(&self) -> Result<&Vec<BerObject<'a>>, BerError>
Attempt to extract the list of objects from a DER sequence. This can fail if the object is not a sequence.
sourcepub fn as_set(&self) -> Result<&Vec<BerObject<'a>>, BerError>
pub fn as_set(&self) -> Result<&Vec<BerObject<'a>>, BerError>
Attempt to extract the list of objects from a DER set. This can fail if the object is not a set.
sourcepub fn as_slice(&self) -> Result<&'a [u8], BerError>
pub fn as_slice(&self) -> Result<&'a [u8], BerError>
Attempt to get the content from a DER object, as a slice. This can fail if the object does not contain a type directly equivalent to a slice (e.g a sequence). This function mostly concerns string types, integers, or unknown DER objects.
sourcepub fn as_str(&self) -> Result<&'a str, BerError>
pub fn as_str(&self) -> Result<&'a str, BerError>
Attempt to get the content from a DER object, as a str. This can fail if the object does not contain a string type.
Only NumericString, PrintableString, UTF8String and IA5String
are considered here. Other string types can be read using as_slice
.
sourcepub fn is_universal(&self) -> bool
pub fn is_universal(&self) -> bool
Test if object class is Universal
sourcepub fn is_application(&self) -> bool
pub fn is_application(&self) -> bool
Test if object class is Application
sourcepub fn is_contextspecific(&self) -> bool
pub fn is_contextspecific(&self) -> bool
Test if object class is Context-specific
sourcepub fn is_private(&self) -> bool
pub fn is_private(&self) -> bool
Test if object class is Private
sourcepub fn is_primitive(&self) -> bool
pub fn is_primitive(&self) -> bool
Test if object is primitive
sourcepub fn is_constructed(&self) -> bool
pub fn is_constructed(&self) -> bool
Test if object is constructed
source§impl<'a> BerObject<'a>
impl<'a> BerObject<'a>
sourcepub fn to_vec(&self) -> Result<Vec<u8>, GenError>
Available on crate feature serialize
only.
pub fn to_vec(&self) -> Result<Vec<u8>, GenError>
serialize
only.Attempt to encode object as BER
Note that the encoding will not check that the values of the BerObject
fields are correct.
The length is automatically calculated, and the field is ignored.
ContextSpecific
objects will be encoded as EXPLICIT.
This function is only available if the serialize
feature is enabled.
Trait Implementations§
source§impl<'a> From<BerObjectContent<'a>> for BerObject<'a>
impl<'a> From<BerObjectContent<'a>> for BerObject<'a>
Build a DER object from a BerObjectContent.