Struct 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<'i, T, E, const CLASS: u8, const TAG: u32> BerParser<'i> for TaggedValue<T, E, Explicit, CLASS, TAG>

where T: BerParser<'i>,

type Error = <T as BerParser<'i>>::Error

The Error type for parsing errors.

fn from_ber_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new BER object from header and data.

fn parse_ber(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new BER object from data.

fn parse_ber_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_ber_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl<'i, T, E, const CLASS: u8, const TAG: u32> BerParser<'i> for TaggedValue<T, E, Implicit, CLASS, TAG>

where T: BerParser<'i>,

type Error = <T as BerParser<'i>>::Error

The Error type for parsing errors.

fn from_ber_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new BER object from header and data.

fn parse_ber(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new BER object from data.

fn parse_ber_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_ber_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl<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<T, E, const CLASS: u8, const TAG: u32> CheckDerConstraints for TaggedValue<T, E, Implicit, CLASS, TAG>

where T: CheckDerConstraints + 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<'i, T, E, const CLASS: u8, const TAG: u32> DerParser<'i> for TaggedValue<T, E, Explicit, CLASS, TAG>

where T: DerParser<'i>,

type Error = <T as DerParser<'i>>::Error

The Error type for parsing errors.

fn from_der_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new DER object from header and data.

fn parse_der(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new DER object from data.

fn parse_der_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_der_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl<'i, T, E, const CLASS: u8, const TAG: u32> DerParser<'i> for TaggedValue<T, E, Implicit, CLASS, TAG>

where T: DerParser<'i>,

type Error = <T as DerParser<'i>>::Error

The Error type for parsing errors.

fn from_der_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new DER object from header and data.

fn parse_der(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new DER object from data.

fn parse_der_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_der_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

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

where T: DynTagged,

fn class(&self) -> Class

Return the class of the object

fn constructed(&self) -> bool

Return true if the object is constructed

fn tag(&self) -> Tag

Return the tag number of the object

fn accept_tag(tag: Tag) -> bool

Return true if the tag number is acceptable for this object

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> + 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 for TaggedValue<T, E, TagKind, CLASS, TAG>

fn eq(&self, other: &TaggedValue<T, E, TagKind, CLASS, TAG>) -> 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<T, E, const CLASS: u8, const TAG: u32> Tagged for TaggedValue<T, E, Explicit, CLASS, TAG>

const CLASS: Class

const CONSTRUCTED: bool = true

const TAG: Tag

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

where T: ToBer + DynTagged,

type Encoder = BerGenericEncoder

fn ber_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn ber_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn ber_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn ber_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn ber_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn ber_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn ber_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn ber_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

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

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

fn write_ber<W: Write>(&self, writer: &mut W) -> SerializeResult<usize>

Encode in BER and write the object (header + content) to the writer target

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

where T: ToBer + DynTagged,

type Encoder = BerGenericEncoder

fn ber_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn ber_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn ber_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn ber_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn ber_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn ber_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn ber_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn ber_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

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

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

fn write_ber<W: Write>(&self, writer: &mut W) -> SerializeResult<usize>

Encode in BER and write the object (header + content) to the writer target

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

where T: ToDer + DynTagged,

type Encoder = BerGenericEncoder

fn der_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn der_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn der_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn der_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn der_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn der_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn der_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn der_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

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

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

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

Encode in DER and write the object (header + content) to the writer target

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

👎Deprecated since 0.8.0: Use der_total_len() instead.

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

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

👎Deprecated since 0.8.0: Use to_der_vec() instead.

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

where T: ToDer + DynTagged,

type Encoder = BerGenericEncoder

fn der_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn der_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn der_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn der_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn der_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn der_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn der_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn der_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

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

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

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

Encode in DER and write the object (header + content) to the writer target

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

👎Deprecated since 0.8.0: Use der_total_len() instead.

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

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

👎Deprecated since 0.8.0: Use to_der_vec() instead.

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> + 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> + 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: Eq, E: Eq, TagKind: Eq, const CLASS: u8, const TAG: u32> Eq for TaggedValue<T, E, TagKind, CLASS, TAG>

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