Struct Header

pub struct Header<'a> { /* private fields */ }

Available on crate feature mtls only.

BER/DER object header (identifier and length)

Implementations

impl<'a> Header<'a>

pub const fn new( class: Class, constructed: bool, tag: Tag, length: Length, ) -> Header<'a>

Build a new BER/DER header from the provided values

pub const fn new_simple(tag: Tag) -> Header<'a>

Build a new BER/DER header from the provided tag, with default values for other fields

pub fn with_class(self, class: Class) -> Header<'a>

Set the class of this Header

pub fn with_constructed(self, constructed: bool) -> Header<'a>

Set the constructed flags of this Header

pub fn with_tag(self, tag: Tag) -> Header<'a>

Set the tag of this Header

pub fn with_length(self, length: Length) -> Header<'a>

Set the length of this Header

pub fn with_raw_tag(self, raw_tag: Option<Cow<'a, [u8]>>) -> Header<'a>

Update header to add reference to raw tag

pub const fn class(&self) -> Class

Return the class of this header.

pub const fn constructed(&self) -> bool

Return true if this header has the ‘constructed’ flag.

pub const fn tag(&self) -> Tag

Return the tag of this header.

pub const fn length(&self) -> Length

Return the length of this header.

pub fn raw_tag(&self) -> Option<&[u8]>

Return the raw tag encoding, if it was stored in this object

pub const fn is_primitive(&self) -> bool

Test if object is primitive

pub const fn is_constructed(&self) -> bool

Test if object is constructed

pub const fn assert_class(&self, class: Class) -> Result<(), Error>

Return error if class is not the expected class

pub const fn assert_tag(&self, tag: Tag) -> Result<(), Error>

Return error if tag is not the expected tag

pub const fn assert_primitive(&self) -> Result<(), Error>

Return error if object is not primitive

pub const fn assert_constructed(&self) -> Result<(), Error>

Return error if object is primitive

pub const fn is_universal(&self) -> bool

Test if object class is Universal

pub const fn is_application(&self) -> bool

Test if object class is Application

pub const fn is_contextspecific(&self) -> bool

Test if object class is Context-specific

pub const fn is_private(&self) -> bool

Test if object class is Private

pub const fn assert_definite(&self) -> Result<(), Error>

Return error if object length is definite

pub fn parse_ber_content<'i>( &self, i: &'i [u8], ) -> Result<(&'i [u8], &'i [u8]), Err<Error>>

Get the content following a BER header

pub fn parse_der_content<'i>( &self, i: &'i [u8], ) -> Result<(&'i [u8], &'i [u8]), Err<Error>>

Get the content following a DER header

Trait Implementations

impl<'a> Clone for Header<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Header<'a>

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

Formats the value using the given formatter.

impl DynTagged for Header<'_>

fn tag(&self) -> Tag

impl From<Tag> for Header<'_>

fn from(tag: Tag) -> Header<'_>

Converts to this type from the input type.

impl<'a> FromBer<'a> for Header<'a>

fn from_ber(bytes: &'a [u8]) -> Result<(&'a [u8], Header<'a>), Err<Error>>

Attempt to parse input bytes into a BER object

impl<'a> FromDer<'a> for Header<'a>

fn from_der(bytes: &'a [u8]) -> Result<(&'a [u8], Header<'a>), Err<Error>>

Attempt to parse input bytes into a DER object (enforcing constraints)

impl<'a> PartialEq for Header<'a>

Compare two BER headers. len fields are compared only if both objects have it set (same for raw_tag)

fn eq(&self, other: &Header<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToDer for Header<'_>

fn to_der_len(&self) -> Result<usize, Error>

Get the length of the object (including the header), when encoded

fn write_der_header( &self, writer: &mut dyn Write, ) -> Result<usize, SerializeError>

Attempt to write the DER header to this writer.

fn write_der_content( &self, _writer: &mut dyn Write, ) -> Result<usize, SerializeError>

Attempt to write the DER content (all except header) to this writer.

fn write_der_raw(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Similar to using to_der, but uses provided values without changes. This can generate an invalid encoding for a DER object.

fn to_der_vec(&self) -> Result<Vec<u8>, SerializeError>

Write the DER encoded representation to a newly allocated Vec<u8>.

fn to_der_vec_raw(&self) -> Result<Vec<u8>, SerializeError>

Similar to using to_vec, but uses provided values without changes. This can generate an invalid encoding for a DER object.

fn write_der(&self, writer: &mut dyn Write) -> Result<usize, SerializeError>

Attempt to write the DER encoded representation (header and content) into this writer.

impl<'a> ToStatic for Header<'a>

type Owned = Header<'static>

fn to_static(&self) -> <Header<'a> as ToStatic>::Owned

impl Eq for Header<'_>