Enum der_parser::ber::BerObjectContent

pub enum BerObjectContent<'a> {
    EndOfContent,
    Boolean(bool),
    Integer(&'a [u8]),
    BitString(u8, BitStringObject<'a>),
    OctetString(&'a [u8]),
    Null,
    Enum(u64),
    OID(Oid<'a>),
    RelativeOID(Oid<'a>),
    NumericString(&'a str),
    VisibleString(&'a str),
    PrintableString(&'a str),
    IA5String(&'a str),
    UTF8String(&'a str),
    T61String(&'a [u8]),
    VideotexString(&'a [u8]),
    BmpString(&'a [u8]),
    UniversalString(&'a [u8]),
    Sequence(Vec<BerObject<'a>>),
    Set(Vec<BerObject<'a>>),
    UTCTime(&'a str),
    GeneralizedTime(&'a str),
    ObjectDescriptor(&'a [u8]),
    GraphicString(&'a [u8]),
    GeneralString(&'a [u8]),
    Optional(Option<Box<BerObject<'a>>>),
    Tagged(BerClass, BerTag, Box<BerObject<'a>>),
    Private(BerObjectHeader<'a>, &'a [u8]),
    Unknown(BerClass, BerTag, &'a [u8]),
}

BER object content

Variants

EndOfContent

EOC (no content)

Boolean(bool)

BOOLEAN: decoded value

Tuple Fields of Boolean

0: bool

Integer(&'a [u8])

INTEGER: raw bytes

Note: the reason to store the raw bytes is that integers have non-finite length in the spec, and also that the raw encoding is also important for some applications.

To extract the number, see the as_u64, as_u32, as_bigint and as_biguint methods.

Tuple Fields of Integer

0: &'a [u8]

BitString(u8, BitStringObject<'a>)

BIT STRING: number of unused bits, and object

Tuple Fields of BitString

0: u81: BitStringObject<'a>

OctetString(&'a [u8])

OCTET STRING: slice

Tuple Fields of OctetString

0: &'a [u8]

Null

NULL (no content)

Enum(u64)

ENUMERATED: decoded enum number

Tuple Fields of Enum

0: u64

OID(Oid<'a>)

OID

Tuple Fields of OID

0: Oid<'a>

RelativeOID(Oid<'a>)

RELATIVE OID

Tuple Fields of RelativeOID

0: Oid<'a>

NumericString(&'a str)

NumericString: decoded string

Tuple Fields of NumericString

0: &'a str

VisibleString(&'a str)

VisibleString: decoded string

Tuple Fields of VisibleString

0: &'a str

PrintableString(&'a str)

PrintableString: decoded string

Tuple Fields of PrintableString

0: &'a str

IA5String(&'a str)

IA5String: decoded string

Tuple Fields of IA5String

0: &'a str

UTF8String(&'a str)

UTF8String: decoded string

Tuple Fields of UTF8String

0: &'a str

T61String(&'a [u8])

T61String: raw object bytes

Tuple Fields of T61String

0: &'a [u8]

VideotexString(&'a [u8])

VideotexString: raw object bytes

Tuple Fields of VideotexString

0: &'a [u8]

BmpString(&'a [u8])

BmpString: raw object bytes

Tuple Fields of BmpString

0: &'a [u8]

UniversalString(&'a [u8])

UniversalString: raw object bytes

Tuple Fields of UniversalString

0: &'a [u8]

Sequence(Vec<BerObject<'a>>)

SEQUENCE: list of objects

Tuple Fields of Sequence

0: Vec<BerObject<'a>>

Set(Vec<BerObject<'a>>)

SET: list of objects

Tuple Fields of Set

0: Vec<BerObject<'a>>

UTCTime(&'a str)

UTCTime: decoded string

Tuple Fields of UTCTime

0: &'a str

GeneralizedTime(&'a str)

GeneralizedTime: decoded string

Tuple Fields of GeneralizedTime

0: &'a str

ObjectDescriptor(&'a [u8])

Object descriptor: raw object bytes

Tuple Fields of ObjectDescriptor

0: &'a [u8]

GraphicString(&'a [u8])

GraphicString: raw object bytes

Tuple Fields of GraphicString

0: &'a [u8]

GeneralString(&'a [u8])

GeneralString: raw object bytes

Tuple Fields of GeneralString

0: &'a [u8]

Optional(Option<Box<BerObject<'a>>>)

Optional object

Tuple Fields of Optional

0: Option<Box<BerObject<'a>>>

Tagged(BerClass, BerTag, Box<BerObject<'a>>)

Tagged object (EXPLICIT): class, tag and content of inner object

Tuple Fields of Tagged

0: BerClass1: BerTag2: Box<BerObject<'a>>

Private(BerObjectHeader<'a>, &'a [u8])

Private

Tuple Fields of Private

0: BerObjectHeader<'a>1: &'a [u8]

Unknown(BerClass, BerTag, &'a [u8])

Unknown object: object tag (copied from header), and raw content

Tuple Fields of Unknown

0: BerClass1: BerTag2: &'a [u8]

Implementations

impl<'a> BerObjectContent<'a>

pub fn as_i64(&self) -> Result<i64, BerError>

Attempt to read a signed integer value from this object.

This can fail if the object is not an integer, or if it is too large.

Examples

let der_int  = BerObject::from_int_slice(b"\x80");
assert_eq!(
    der_int.as_i64(),
    Ok(-128)
);

pub fn as_i32(&self) -> Result<i32, BerError>

Attempt to read a signed integer value from this object.

This can fail if the object is not an integer, or if it is too large.

Examples

let der_int  = BerObject::from_int_slice(b"\x80");
assert_eq!(
    der_int.as_i32(),
    Ok(-128)
);

pub fn as_u64(&self) -> Result<u64, BerError>

Attempt to read integer value from this object.

This can fail if the object is not an unsigned integer, or if it is too large.

Examples

let der_int  = BerObject::from_int_slice(b"\x01\x00\x01");
assert_eq!(
    der_int.as_u64(),
    Ok(0x10001)
);

pub fn as_u32(&self) -> Result<u32, BerError>

Attempt to read integer value from this object.

This can fail if the object is not an unsigned integer, or if it is too large.

Examples

let der_int  = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
assert_eq!(
    der_int.as_u32(),
    Ok(0x10001)
);

pub fn as_bool(&self) -> Result<bool, BerError>

pub fn as_oid(&self) -> Result<&Oid<'a>, BerError>

pub fn as_oid_val(&self) -> Result<Oid<'a>, BerError>

pub fn as_optional(&'a self) -> Result<Option<&BerObject<'a>>, BerError>

pub fn as_tagged(
    &'a self
) -> Result<(BerClass, BerTag, &BerObject<'a>), BerError>

pub fn as_bitstring_ref(&self) -> Result<&BitStringObject<'_>, BerError>

pub fn as_bitstring(&'a self) -> Result<BitStringObject<'a>, BerError>

pub fn as_bitslice(&self) -> Result<&BitSlice<Msb0, u8>, BerError>

Constructs a shared &BitSlice reference over the object data, if available as slice.

pub fn as_sequence(&self) -> Result<&Vec<BerObject<'a>>, BerError>

pub fn as_set(&self) -> Result<&Vec<BerObject<'a>>, BerError>

pub fn as_slice(&self) -> Result<&'a [u8], BerError>

pub fn as_str(&self) -> Result<&'a str, BerError>

Trait Implementations

impl<'a> Clone for BerObjectContent<'a>

fn clone(&self) -> BerObjectContent<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BerObjectContent<'a>

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

Formats the value using the given formatter.

impl<'a> From<BerObjectContent<'a>> for BerObject<'a>

Build a DER object from a BerObjectContent.

fn from(obj: BerObjectContent<'a>) -> BerObject<'a>

Performs the conversion.

impl<'a> PartialEq<BerObjectContent<'a>> for BerObjectContent<'a>

fn eq(&self, other: &BerObjectContent<'a>) -> bool

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

fn ne(&self, other: &BerObjectContent<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for BerObjectContent<'a>