Struct asn1_rs::OptTaggedParser
source · pub struct OptTaggedParser {
pub class: Class,
pub tag: Tag,
}
Expand description
Helper object to parse TAGGED OPTIONAL types (explicit or implicit)
This object can be used similarly to a builder pattern, to specify the expected class and tag of the object to parse, and the content parsing function.
The content parsing function takes two arguments: the outer header, and the data.
It can be used for both EXPLICIT or IMPLICIT tagged objects by using parsing functions that expect a header (or not) in the contents.
The OptTaggedParser::from
method is a shortcut to build an object with ContextSpecific
class and the given tag. The OptTaggedParser::new
method is more generic.
See also OptTaggedExplicit
and OptTaggedImplicit
for alternatives that implement FromBer
/
FromDer
.
Examples
To parse a [APPLICATION 0] EXPLICIT INTEGER OPTIONAL
object:
use asn1_rs::{Class, FromDer, Integer, Tag, OptTaggedParser};
let bytes = &[0x60, 0x03, 0x2, 0x1, 0x2];
let (_, tagged) = OptTaggedParser::new(Class::Application, Tag(0))
.parse_der(bytes, |_, data| Integer::from_der(data))
.unwrap();
assert_eq!(tagged, Some(Integer::from(2)));
To parse a [0] IMPLICIT INTEGER OPTIONAL
object:
use asn1_rs::{Error, Integer, OptTaggedParser};
let bytes = &[0xa0, 0x1, 0x2];
let (_, tagged) = OptTaggedParser::from(0)
.parse_der::<_, Error, _>(bytes, |_, data| Ok((&[], Integer::new(data))))
.unwrap();
assert_eq!(tagged, Some(Integer::from(2)));
Fields§
§class: Class
The expected class for the object to parse
tag: Tag
The expected tag for the object to parse
Implementations§
source§impl OptTaggedParser
impl OptTaggedParser
sourcepub const fn new(class: Class, tag: Tag) -> Self
pub const fn new(class: Class, tag: Tag) -> Self
Build a new OptTaggedParser
object.
If using Class::ContextSpecific
, using OptTaggedParser::from
with either a Tag
or u32
is
a shorter way to build this object.
pub const fn universal(tag: u32) -> Self
pub const fn tagged(tag: u32) -> Self
pub const fn application(tag: u32) -> Self
pub const fn private(tag: u32) -> Self
sourcepub fn parse_ber<'a, T, E, F>(
&self,
bytes: &'a [u8],
f: F
) -> ParseResult<'a, Option<T>, E>where
F: Fn(Header<'_>, &'a [u8]) -> ParseResult<'a, T, E>,
E: From<Error>,
pub fn parse_ber<'a, T, E, F>( &self, bytes: &'a [u8], f: F ) -> ParseResult<'a, Option<T>, E>where F: Fn(Header<'_>, &'a [u8]) -> ParseResult<'a, T, E>, E: From<Error>,
Parse input as BER, and apply the provided function to parse object.
Returns the remaining bytes, and Some(T)
if expected tag was found, else None
.
This function returns an error if tag was found but has a different class, or if parsing fails.
Examples
To parse a [0] EXPLICIT INTEGER OPTIONAL
object:
use asn1_rs::{FromBer, Integer, OptTaggedParser};
let bytes = &[0xa0, 0x03, 0x2, 0x1, 0x2];
let (_, tagged) = OptTaggedParser::from(0)
.parse_ber(bytes, |_, data| Integer::from_ber(data))
.unwrap();
assert_eq!(tagged, Some(Integer::from(2)));
sourcepub fn parse_der<'a, T, E, F>(
&self,
bytes: &'a [u8],
f: F
) -> ParseResult<'a, Option<T>, E>where
F: Fn(Header<'_>, &'a [u8]) -> ParseResult<'a, T, E>,
E: From<Error>,
pub fn parse_der<'a, T, E, F>( &self, bytes: &'a [u8], f: F ) -> ParseResult<'a, Option<T>, E>where F: Fn(Header<'_>, &'a [u8]) -> ParseResult<'a, T, E>, E: From<Error>,
Parse input as DER, and apply the provided function to parse object.
Returns the remaining bytes, and Some(T)
if expected tag was found, else None
.
This function returns an error if tag was found but has a different class, or if parsing fails.
Examples
To parse a [0] EXPLICIT INTEGER OPTIONAL
object:
use asn1_rs::{FromDer, Integer, OptTaggedParser};
let bytes = &[0xa0, 0x03, 0x2, 0x1, 0x2];
let (_, tagged) = OptTaggedParser::from(0)
.parse_der(bytes, |_, data| Integer::from_der(data))
.unwrap();
assert_eq!(tagged, Some(Integer::from(2)));
Trait Implementations§
source§impl Debug for OptTaggedParser
impl Debug for OptTaggedParser
source§impl From<Tag> for OptTaggedParser
impl From<Tag> for OptTaggedParser
Auto Trait Implementations§
impl RefUnwindSafe for OptTaggedParser
impl Send for OptTaggedParser
impl Sync for OptTaggedParser
impl Unpin for OptTaggedParser
impl UnwindSafe for OptTaggedParser
Blanket Implementations§
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.