Struct Encoder 

pub struct Encoder { /* private fields */ }

Encodes Rust structures into Basic Encoding Rules data.

Every value is written straight into one output buffer. A value whose contents length is not known in advance reserves one length octet, which is completed once the contents are written; when the long form is needed, the contents are shifted along to make room. The components of a SET and the elements of a SET OF are encoded in sequence and reordered in place.

Implementations

impl Encoder

pub fn new(config: EncoderOptions) -> Self

Creates a new instance from the given config.

pub fn codec(&self) -> Codec

Returns the currently selected codec.

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.

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.

pub fn output(self) -> Vec<u8>

Consumes the encoder and returns the output of the encoding.

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.

pub fn datetime_to_canonical_utc_time_bytes(value: &DateTime<Utc>) -> Vec<u8>

Canonical byte presentation for CER/DER UTCTime as defined in X.690 section 11.8. Also used for BER on this crate.

pub fn naivedate_to_date_bytes(value: &NaiveDate) -> Vec<u8>

Canonical byte presentation for CER/DER DATE as defined in X.690 section 8.26.2 Also used for BER on this crate.

Trait Implementations

impl Encoder<'_> for Encoder

fn encode_extension_addition_group<const RC: usize, const EC: usize, E>( &mut self, value: Option<&E>, _: Identifier, ) -> Result<Self::Ok, Self::Error>

where E: Encode + Constructed<RC, EC>,

Encode a extension addition group value.

type Ok = ()

The associated success type returned on success.

type Error = EncodeError

The associated error type returned on failure.

type AnyEncoder<'this, const R: usize, const E: usize> = Encoder

Helper type for encoding recursive Encoder instances with different RCL or ECL values.

fn codec(&self) -> Codec

Returns codec variant of Codec that current encoder is encoding.

fn encode_any( &mut self, tag: Tag, value: &Any, _identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode an unknown ASN.1 value.

fn encode_bit_string( &mut self, tag: Tag, constraints: &Constraints, value: &BitStr, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a BIT STRING value.

fn encode_bool( &mut self, tag: Tag, value: bool, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a BOOL value.

fn encode_choice<E: Encode>( &mut self, _: &Constraints, _t: Tag, encode_fn: impl FnOnce(&mut Self) -> Result<Tag, Self::Error>, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a CHOICE value.

fn encode_enumerated<E: Enumerated>( &mut self, tag: Tag, value: &E, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a ENUMERATED value.

fn encode_integer<I: IntegerType>( &mut self, tag: Tag, constraints: &Constraints, value: &I, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a INTEGER value.

fn encode_real<R: RealType>( &mut self, _: Tag, _: &Constraints, _: &R, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a REAL value.

fn encode_null( &mut self, tag: Tag, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a NULL value.

fn encode_object_identifier( &mut self, tag: Tag, oid: &[u32], _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a OBJECT IDENTIFIER value.

fn encode_octet_string( &mut self, tag: Tag, constraints: &Constraints, value: &[u8], _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a OCTET STRING value.

fn encode_visible_string( &mut self, tag: Tag, constraints: &Constraints, value: &VisibleString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a VisibleString value.

fn encode_ia5_string( &mut self, tag: Tag, constraints: &Constraints, value: &Ia5String, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a Ia5String value.

fn encode_general_string( &mut self, tag: Tag, constraints: &Constraints, value: &GeneralString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a GeneralString value.

fn encode_graphic_string( &mut self, tag: Tag, constraints: &Constraints, value: &GraphicString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a GraphicString value.

fn encode_printable_string( &mut self, tag: Tag, constraints: &Constraints, value: &PrintableString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a Ia5String value.

fn encode_numeric_string( &mut self, tag: Tag, constraints: &Constraints, value: &NumericString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a NumericString value.

fn encode_teletex_string( &mut self, tag: Tag, constraints: &Constraints, value: &TeletexString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a TeletexString value.

fn encode_bmp_string( &mut self, tag: Tag, constraints: &Constraints, value: &BmpString, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a BmpString value.

fn encode_utf8_string( &mut self, tag: Tag, constraints: &Constraints, value: &str, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a Utf8String value.

fn encode_utc_time( &mut self, tag: Tag, value: &UtcTime, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a UtcTime value.

fn encode_generalized_time( &mut self, tag: Tag, value: &GeneralizedTime, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a GeneralizedTime value.

fn encode_date( &mut self, tag: Tag, value: &Date, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a ‘Date’ value.

fn encode_some<E: Encode>( &mut self, value: &E, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_some_with_tag<E: Encode>( &mut self, tag: Tag, value: &E, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_some_with_tag_and_constraints<E: Encode>( &mut self, tag: Tag, constraints: &Constraints, value: &E, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_none<E: Encode>( &mut self, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the absent value of an optional field.

fn encode_none_with_tag( &mut self, _: Tag, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the absent value with tag of an optional field.

fn encode_sequence_of<E: Encode>( &mut self, tag: Tag, values: &[E], constraints: &Constraints, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a SEQUENCE OF value.

fn encode_set_of<E: Encode + Eq + Hash>( &mut self, tag: Tag, values: &SetOf<E>, constraints: &Constraints, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a SET OF value.

fn encode_explicit_prefix<V: Encode>( &mut self, tag: Tag, value: &V, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a explicitly tagged value.

fn encode_sequence<'b, const RC: usize, const EC: usize, C, F>( &'b mut self, tag: Tag, encoder_scope: F, _: Identifier, ) -> Result<Self::Ok, Self::Error>

where C: Constructed<RC, EC>, F: FnOnce(&mut Self::AnyEncoder<'b, 0, 0>) -> Result<(), Self::Error>,

Encode a SEQUENCE value.

fn encode_set<'b, const RC: usize, const EC: usize, C, F>( &'b mut self, tag: Tag, encoder_scope: F, _: Identifier, ) -> Result<Self::Ok, Self::Error>

where C: Constructed<RC, EC>, F: FnOnce(&mut Self::AnyEncoder<'b, 0, 0>) -> Result<(), Self::Error>,

Encode a SET value.

fn encode_extension_addition<E: Encode>( &mut self, tag: Tag, constraints: &Constraints, value: E, _: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode a extension addition value.

fn encode_or_default<E: Encode + Default + PartialEq>( &mut self, value: &E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the value a field or skip if it matches the default..

fn encode_with_tag_or_default<E: Encode + Default + PartialEq>( &mut self, tag: Tag, value: &E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_default<E: Encode + PartialEq>( &mut self, value: &E, default: impl FnOnce() -> E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_default_with_tag<E: Encode + PartialEq>( &mut self, tag: Tag, value: &E, default: impl FnOnce() -> E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_default_with_explicit_prefix<E: Encode + PartialEq>( &mut self, tag: Tag, value: &E, default: impl FnOnce() -> E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the preset value of an optional field using Explicit Tags

fn encode_default_with_tag_and_constraints<E: Encode + PartialEq>( &mut self, tag: Tag, constraints: &Constraints, value: &E, default: impl FnOnce() -> E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present value of an optional field.

fn encode_default_with_constraints<E: Encode + PartialEq>( &mut self, constraints: &Constraints, value: &E, default: impl FnOnce() -> E, identifier: Identifier, ) -> Result<Self::Ok, Self::Error>

Encode the present constrained value of an optional field.