pub struct Encoder { /* private fields */ }
Expand description
A BER and variants encoder. Capable of encoding to BER, CER, and DER.
Implementations§
Source§impl Encoder
impl Encoder
Sourcepub fn new(config: EncoderOptions) -> Self
pub fn new(config: EncoderOptions) -> Self
Creates a new instance from the given config
.
pub fn codec(&self) -> Codec
Sourcepub fn new_set(config: EncoderOptions) -> Self
pub fn new_set(config: EncoderOptions) -> Self
Creates a new instance from the given config
, and uses SET encoding
logic, ensuring that all messages are encoded in order by tag.
Sourcepub fn new_with_buffer(config: EncoderOptions, buffer: Vec<u8>) -> Self
pub fn new_with_buffer(config: EncoderOptions, buffer: Vec<u8>) -> Self
Creates a new instance from the given config
and a user-supplied
Vec<u8>
buffer. This allows reuse of an existing buffer instead of
allocating a new encoding buffer each time an Encoder
is created.
The buffer will be cleared before use.
Sourcepub fn object_identifier_as_bytes(
&mut self,
oid: &[u32],
) -> Result<Vec<u8>, EncodeError>
pub fn object_identifier_as_bytes( &mut self, oid: &[u32], ) -> Result<Vec<u8>, EncodeError>
Converts an object identifier into a byte vector in BER format. Reusable function by other codecs.
Sourcepub fn datetime_to_canonical_generalized_time_bytes(
value: &DateTime<FixedOffset>,
) -> Vec<u8> ⓘ
pub fn datetime_to_canonical_generalized_time_bytes( value: &DateTime<FixedOffset>, ) -> Vec<u8> ⓘ
Canonical byte presentation for CER/DER as defined in X.690 section 11.7. Also used for BER on this crate.
Trait Implementations§
Source§impl Encoder for Encoder
impl Encoder for Encoder
Source§fn encode_extension_addition_group<E>(
&mut self,
value: Option<&E>,
) -> Result<Self::Ok, Self::Error>where
E: Encode + Constructed,
fn encode_extension_addition_group<E>(
&mut self,
value: Option<&E>,
) -> Result<Self::Ok, Self::Error>where
E: Encode + Constructed,
Encode a extension addition group value.
type Ok = ()
type Error = EncodeError
Source§fn encode_any(&mut self, _: Tag, value: &Any) -> Result<Self::Ok, Self::Error>
fn encode_any(&mut self, _: Tag, value: &Any) -> Result<Self::Ok, Self::Error>
Encode an unknown ASN.1 value.
Source§fn encode_bit_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &BitStr,
) -> Result<Self::Ok, Self::Error>
fn encode_bit_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &BitStr, ) -> Result<Self::Ok, Self::Error>
Encode a
BIT STRING
value.Source§fn encode_bool(
&mut self,
tag: Tag,
value: bool,
) -> Result<Self::Ok, Self::Error>
fn encode_bool( &mut self, tag: Tag, value: bool, ) -> Result<Self::Ok, Self::Error>
Encode a
BOOL
value.Source§fn encode_choice<E: Encode>(
&mut self,
_: Constraints<'_>,
_t: Tag,
encode_fn: impl FnOnce(&mut Self) -> Result<Tag, Self::Error>,
) -> Result<Self::Ok, Self::Error>
fn encode_choice<E: Encode>( &mut self, _: Constraints<'_>, _t: Tag, encode_fn: impl FnOnce(&mut Self) -> Result<Tag, Self::Error>, ) -> Result<Self::Ok, Self::Error>
Encode a
CHOICE
value.Source§fn encode_enumerated<E: Enumerated>(
&mut self,
tag: Tag,
value: &E,
) -> Result<Self::Ok, Self::Error>
fn encode_enumerated<E: Enumerated>( &mut self, tag: Tag, value: &E, ) -> Result<Self::Ok, Self::Error>
Encode a
ENUMERATED
value.Source§fn encode_integer(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &BigInt,
) -> Result<Self::Ok, Self::Error>
fn encode_integer( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &BigInt, ) -> Result<Self::Ok, Self::Error>
Encode a
INTEGER
value.Source§fn encode_object_identifier(
&mut self,
tag: Tag,
oid: &[u32],
) -> Result<Self::Ok, Self::Error>
fn encode_object_identifier( &mut self, tag: Tag, oid: &[u32], ) -> Result<Self::Ok, Self::Error>
Encode a
OBJECT IDENTIFIER
value.Source§fn encode_octet_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &[u8],
) -> Result<Self::Ok, Self::Error>
fn encode_octet_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &[u8], ) -> Result<Self::Ok, Self::Error>
Encode a
OCTET STRING
value.Source§fn encode_visible_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &VisibleString,
) -> Result<Self::Ok, Self::Error>
fn encode_visible_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &VisibleString, ) -> Result<Self::Ok, Self::Error>
Encode a
VisibleString
value.Source§fn encode_ia5_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &Ia5String,
) -> Result<Self::Ok, Self::Error>
fn encode_ia5_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &Ia5String, ) -> Result<Self::Ok, Self::Error>
Encode a
Ia5String
value.Source§fn encode_general_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &GeneralString,
) -> Result<Self::Ok, Self::Error>
fn encode_general_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &GeneralString, ) -> Result<Self::Ok, Self::Error>
Encode a
GeneralString
value.Source§fn encode_printable_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &PrintableString,
) -> Result<Self::Ok, Self::Error>
fn encode_printable_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &PrintableString, ) -> Result<Self::Ok, Self::Error>
Encode a
Ia5String
value.Source§fn encode_numeric_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &NumericString,
) -> Result<Self::Ok, Self::Error>
fn encode_numeric_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &NumericString, ) -> Result<Self::Ok, Self::Error>
Encode a
NumericString
value.Source§fn encode_teletex_string(
&mut self,
tag: Tag,
_: Constraints<'_>,
value: &TeletexString,
) -> Result<Self::Ok, Self::Error>
fn encode_teletex_string( &mut self, tag: Tag, _: Constraints<'_>, value: &TeletexString, ) -> Result<Self::Ok, Self::Error>
Encode a
TeletexString
value.Source§fn encode_bmp_string(
&mut self,
tag: Tag,
_constraints: Constraints<'_>,
value: &BmpString,
) -> Result<Self::Ok, Self::Error>
fn encode_bmp_string( &mut self, tag: Tag, _constraints: Constraints<'_>, value: &BmpString, ) -> Result<Self::Ok, Self::Error>
Encode a
BmpString
value.Source§fn encode_utf8_string(
&mut self,
tag: Tag,
_: Constraints<'_>,
value: &str,
) -> Result<Self::Ok, Self::Error>
fn encode_utf8_string( &mut self, tag: Tag, _: Constraints<'_>, value: &str, ) -> Result<Self::Ok, Self::Error>
Encode a
Utf8String
value.Source§fn encode_utc_time(
&mut self,
tag: Tag,
value: &UtcTime,
) -> Result<Self::Ok, Self::Error>
fn encode_utc_time( &mut self, tag: Tag, value: &UtcTime, ) -> Result<Self::Ok, Self::Error>
Encode a
UtcTime
value.Source§fn encode_generalized_time(
&mut self,
tag: Tag,
value: &GeneralizedTime,
) -> Result<Self::Ok, Self::Error>
fn encode_generalized_time( &mut self, tag: Tag, value: &GeneralizedTime, ) -> Result<Self::Ok, Self::Error>
Encode a
GeneralizedTime
value.Source§fn encode_some<E: Encode>(&mut self, value: &E) -> Result<Self::Ok, Self::Error>
fn encode_some<E: Encode>(&mut self, value: &E) -> Result<Self::Ok, Self::Error>
Encode the present value of an optional field.
Source§fn encode_some_with_tag<E: Encode>(
&mut self,
tag: Tag,
value: &E,
) -> Result<Self::Ok, Self::Error>
fn encode_some_with_tag<E: Encode>( &mut self, tag: Tag, value: &E, ) -> Result<Self::Ok, Self::Error>
Encode the present value of an optional field.
Source§fn encode_some_with_tag_and_constraints<E: Encode>(
&mut self,
tag: Tag,
constraints: Constraints<'_>,
value: &E,
) -> Result<Self::Ok, Self::Error>
fn encode_some_with_tag_and_constraints<E: Encode>( &mut self, tag: Tag, constraints: Constraints<'_>, value: &E, ) -> Result<Self::Ok, Self::Error>
Encode the present value of an optional field.
Source§fn encode_none<E: Encode>(&mut self) -> Result<Self::Ok, Self::Error>
fn encode_none<E: Encode>(&mut self) -> Result<Self::Ok, Self::Error>
Encode the absent value of an optional field.
Source§fn encode_none_with_tag(&mut self, _: Tag) -> Result<Self::Ok, Self::Error>
fn encode_none_with_tag(&mut self, _: Tag) -> Result<Self::Ok, Self::Error>
Encode the absent value with
tag
of an optional field.Source§fn encode_sequence_of<E: Encode>(
&mut self,
tag: Tag,
values: &[E],
_constraints: Constraints<'_>,
) -> Result<Self::Ok, Self::Error>
fn encode_sequence_of<E: Encode>( &mut self, tag: Tag, values: &[E], _constraints: Constraints<'_>, ) -> Result<Self::Ok, Self::Error>
Encode a
SEQUENCE OF
value.Source§fn encode_set_of<E: Encode>(
&mut self,
tag: Tag,
values: &SetOf<E>,
_constraints: Constraints<'_>,
) -> Result<Self::Ok, Self::Error>
fn encode_set_of<E: Encode>( &mut self, tag: Tag, values: &SetOf<E>, _constraints: Constraints<'_>, ) -> Result<Self::Ok, Self::Error>
Encode a
SET OF
value.Source§fn encode_explicit_prefix<V: Encode>(
&mut self,
tag: Tag,
value: &V,
) -> Result<Self::Ok, Self::Error>
fn encode_explicit_prefix<V: Encode>( &mut self, tag: Tag, value: &V, ) -> Result<Self::Ok, Self::Error>
Encode a explicitly tagged value.
Source§fn encode_sequence<C, F>(
&mut self,
tag: Tag,
encoder_scope: F,
) -> Result<Self::Ok, Self::Error>
fn encode_sequence<C, F>( &mut self, tag: Tag, encoder_scope: F, ) -> Result<Self::Ok, Self::Error>
Encode a
SEQUENCE
value.Source§fn encode_set<C, F>(
&mut self,
tag: Tag,
encoder_scope: F,
) -> Result<Self::Ok, Self::Error>
fn encode_set<C, F>( &mut self, tag: Tag, encoder_scope: F, ) -> Result<Self::Ok, Self::Error>
Encode a
SET
value.Source§fn encode_extension_addition<E: Encode>(
&mut self,
tag: Tag,
constraints: Constraints<'_>,
value: E,
) -> Result<Self::Ok, Self::Error>
fn encode_extension_addition<E: Encode>( &mut self, tag: Tag, constraints: Constraints<'_>, value: E, ) -> Result<Self::Ok, Self::Error>
Encode a extension addition value.
Source§fn encode_or_default<E: Encode + Default + PartialEq>(
&mut self,
value: &E,
) -> Result<Self::Ok, Self::Error>
fn encode_or_default<E: Encode + Default + PartialEq>( &mut self, value: &E, ) -> Result<Self::Ok, Self::Error>
Encode the value a field or skip if it matches the default..
Source§fn encode_with_tag_or_default<E: Encode + Default + PartialEq>(
&mut self,
tag: Tag,
value: &E,
) -> Result<Self::Ok, Self::Error>
fn encode_with_tag_or_default<E: Encode + Default + PartialEq>( &mut self, tag: Tag, value: &E, ) -> Result<Self::Ok, Self::Error>
Encode the present value of an optional field.
Source§fn encode_default<E: Encode + PartialEq>(
&mut self,
value: &E,
default: impl FnOnce() -> E,
) -> Result<Self::Ok, Self::Error>
fn encode_default<E: Encode + PartialEq>( &mut self, value: &E, default: impl FnOnce() -> E, ) -> Result<Self::Ok, Self::Error>
Encode the present value of an optional field.
Source§fn encode_default_with_tag<E: Encode + PartialEq>(
&mut self,
tag: Tag,
value: &E,
default: impl FnOnce() -> E,
) -> Result<Self::Ok, Self::Error>
fn encode_default_with_tag<E: Encode + PartialEq>( &mut self, tag: Tag, value: &E, default: impl FnOnce() -> E, ) -> Result<Self::Ok, Self::Error>
Encode the present value of an optional field.
Auto Trait Implementations§
impl Freeze for Encoder
impl RefUnwindSafe for Encoder
impl Send for Encoder
impl Sync for Encoder
impl Unpin for Encoder
impl UnwindSafe for Encoder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§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,
Borrows
self
and passes that borrow into the pipe function. Read moreSource§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,
Mutably borrows
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.