Struct asn1_rs::TaggedValue

pub struct TaggedValue<T, E, TagKind, const CLASS: u8, const TAG: u32> { /* private fields */ }

Helper object for creating FromBer/FromDer types for TAGGED OPTIONAL types

When parsing ContextSpecific (the most common class), see TaggedExplicit and TaggedImplicit alias types.

Notes

CLASS must be between 0 and 4. See Class for possible values for the CLASS parameter. Constants from this class can be used, but they must be wrapped in braces due to Rust syntax for generics (see example below).

Examples

To parse a [APPLICATION 0] EXPLICIT INTEGER object:

use asn1_rs::{Class, Error, Explicit, FromBer, Integer, TaggedValue};

let bytes = &[0x60, 0x03, 0x2, 0x1, 0x2];

// If tagged object is present (and has expected tag), parsing succeeds:
let (_, tagged) =
    TaggedValue::<Integer, Error, Explicit, {Class::APPLICATION}, 0>::from_ber(bytes)
        .unwrap();
assert_eq!(tagged, TaggedValue::explicit(Integer::from(2)));

Implementations

impl<T, E, TagKind, const CLASS: u8, const TAG: u32> TaggedValue<T, E, TagKind, CLASS, TAG>

pub fn into_inner(self) -> T

Consumes the TaggedParser, returning the wrapped value.

pub const fn tag(&self) -> Tag

Return the (outer) tag of this object

pub const fn class(&self) -> u8

Return the (outer) class of this object

impl<T, E, const CLASS: u8, const TAG: u32> TaggedValue<T, E, Explicit, CLASS, TAG>

pub const fn explicit(inner: T) -> Self

Constructs a new EXPLICIT TaggedParser with the provided value

impl<T, E, const CLASS: u8, const TAG: u32> TaggedValue<T, E, Implicit, CLASS, TAG>

pub const fn implicit(inner: T) -> Self

Constructs a new IMPLICIT TaggedParser with the provided value

Trait Implementations

impl<T, E, TagKind, const CLASS: u8, const TAG: u32> AsRef<T> for TaggedValue<T, E, TagKind, CLASS, TAG>

fn as_ref(&self) -> &T

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

impl<'a, T, E, const CLASS: u8, const TAG: u32> CheckDerConstraints for TaggedValue<T, E, Explicit, CLASS, TAG> where
    T: CheckDerConstraints, 

fn check_constraints(any: &Any<'_>) -> Result<()>

impl<'a, T, E, const CLASS: u8, const TAG: u32> CheckDerConstraints for TaggedValue<T, E, Implicit, CLASS, TAG> where
    T: CheckDerConstraints,
    T: Tagged, 

fn check_constraints(any: &Any<'_>) -> Result<()>

impl<T: Debug, E: Debug, TagKind: Debug, const CLASS: u8, const TAG: u32> Debug for TaggedValue<T, E, TagKind, CLASS, TAG>

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

Formats the value using the given formatter.

impl<'a, T, E, const CLASS: u8, const TAG: u32> FromDer<'a, E> for TaggedValue<T, E, Explicit, CLASS, TAG> where
    T: FromDer<'a, E>,
    E: From<Error>, 

fn from_der(bytes: &'a [u8]) -> ParseResult<'a, Self, E>

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

impl<'a, T, E, const CLASS: u8, const TAG: u32> FromDer<'a, E> for TaggedValue<T, E, Implicit, CLASS, TAG> where
    T: TryFrom<Any<'a>, Error = E>,
    T: Tagged,
    E: From<Error>, 

fn from_der(bytes: &'a [u8]) -> ParseResult<'a, Self, E>

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

impl<T: PartialEq, E: PartialEq, TagKind: PartialEq, const CLASS: u8, const TAG: u32> PartialEq<TaggedValue<T, E, TagKind, CLASS, TAG>> for TaggedValue<T, E, TagKind, CLASS, TAG>

fn eq(&self, other: &TaggedValue<T, E, TagKind, CLASS, TAG>) -> bool

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

fn ne(&self, other: &TaggedValue<T, E, TagKind, CLASS, TAG>) -> bool

This method tests for !=.

impl<T, E, TagKind, const CLASS: u8, const TAG: u32> Tagged for TaggedValue<T, E, TagKind, CLASS, TAG>

const TAG: Tag = Tag(TAG)

impl<T, E, const CLASS: u8, const TAG: u32> ToDer for TaggedValue<T, E, Explicit, CLASS, TAG> where
    T: ToDer, 

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

Get the length of the object, when encoded

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

Attempt to write the DER header to this writer.

fn write_der_content(&self, writer: &mut dyn Write) -> SerializeResult<usize>

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

fn to_der_vec(&self) -> SerializeResult<Vec<u8>>

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

fn to_der_vec_raw(&self) -> SerializeResult<Vec<u8>>

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) -> SerializeResult<usize>

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

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

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

impl<T, E, const CLASS: u8, const TAG: u32> ToDer for TaggedValue<T, E, Implicit, CLASS, TAG> where
    T: ToDer, 

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

Get the length of the object, when encoded

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

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

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

Attempt to write the DER header to this writer.

fn write_der_content(&self, writer: &mut dyn Write) -> SerializeResult<usize>

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

fn to_der_vec(&self) -> SerializeResult<Vec<u8>>

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

fn to_der_vec_raw(&self) -> SerializeResult<Vec<u8>>

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

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

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

impl<'a, 'b, T, E, const CLASS: u8, const TAG: u32> TryFrom<&'b Any<'a>> for TaggedValue<T, E, Explicit, CLASS, TAG> where
    T: FromBer<'a, E>,
    E: From<Error>, 

type Error = E

The type returned in the event of a conversion error.

fn try_from(any: &'b Any<'a>) -> Result<Self, E>

Performs the conversion.

impl<'a, 'b, E, T, const CLASS: u8, const TAG: u32> TryFrom<&'b Any<'a>> for TaggedValue<T, E, Implicit, CLASS, TAG> where
    T: TryFrom<Any<'a>, Error = E>,
    T: Tagged,
    E: From<Error>, 

type Error = E

The type returned in the event of a conversion error.

fn try_from(any: &'b Any<'a>) -> Result<Self, E>

Performs the conversion.

impl<'a, T, E, const CLASS: u8, const TAG: u32> TryFrom<Any<'a>> for TaggedValue<T, E, Explicit, CLASS, TAG> where
    T: FromBer<'a, E>,
    E: From<Error>, 

type Error = E

The type returned in the event of a conversion error.

fn try_from(any: Any<'a>) -> Result<Self, E>

Performs the conversion.

impl<'a, T, E, const CLASS: u8, const TAG: u32> TryFrom<Any<'a>> for TaggedValue<T, E, Implicit, CLASS, TAG> where
    T: TryFrom<Any<'a>, Error = E>,
    T: Tagged,
    E: From<Error>, 

type Error = E

The type returned in the event of a conversion error.

fn try_from(any: Any<'a>) -> Result<Self, E>

Performs the conversion.

impl<T, E, TagKind, const CLASS: u8, const TAG: u32> StructuralPartialEq for TaggedValue<T, E, TagKind, CLASS, TAG>