Struct RasnEncodeError 

pub struct RasnEncodeError {
    pub kind: Box<EncodeErrorKind>,
    pub codec: Codec,
}

An error type for failed encoding for every encoder. Abstracts over the different generic and codec-specific errors.

kind field is used to determine the kind of error that occurred. codec field is used to determine the codec that failed. backtrace field is used to determine the backtrace of the error.

There is Kind::CodecSpecific variant which wraps the codec-specific errors as CodecEncodeError type.

Example

use rasn::{Codec, error::{EncodeErrorKind, strings::PermittedAlphabetError}, prelude::*};

#[derive(AsnType, Clone, Debug, Decode, Encode, PartialEq)]
#[rasn(delegate, from("a..z"))]
struct MyConstrainedString (
    VisibleString,
);

// Below sample requires that `backtraces` feature is enabled

let constrained_str = MyConstrainedString(VisibleString::try_from("abcD").unwrap());
let encoded = Codec::Uper.encode_to_binary(&constrained_str);
match encoded {
    Ok(succ) => {
        println!("Successful encoding!");
        dbg!(succ);
    }
    Err(e) => {
        // e is EncodeError, Kind is boxed
        match *e.kind {
            EncodeErrorKind::AlphabetConstraintNotSatisfied {
               reason: PermittedAlphabetError::CharacterNotFound {character },
            } => {
                println!("Codec: {}", e.codec);
                println!("Character {} not found from the permitted list.",
                         char::from_u32(character).unwrap());
                #[cfg(feature = "backtraces")]
                println!("Backtrace:\n{}", e.backtrace);
            }
            _ => {
                panic!("Unexpected error!");
            }
        }
    }
}
// Should print ->
//
// Codec: UPER
// Character D not found from the permitted list.
// Backtrace: ...

Fields

kind: Box<EncodeErrorKind>

The inner encoding error.

codec: Codec

The codec associated with the error.

Implementations

impl EncodeError

pub fn alphabet_constraint_not_satisfied( reason: PermittedAlphabetError, codec: Codec, ) -> EncodeError

Returns an encode error for codec when the alphabet constraint is not satisfied.

pub fn size_constraint_not_satisfied( size: usize, expected: &Size, codec: Codec, ) -> EncodeError

Returns an encode error for codec when the size constraint is not satisfied.

The size is the actual size that failed the constraint and expected the expected size.

pub fn value_constraint_not_satisfied( value: BigInt, expected: &Bounded<i128>, codec: Codec, ) -> EncodeError

Returns an encode error for codec when the value constraint is not satisfied.

The value is the actual value that failed the constraint.

pub fn check_length( length: usize, expected: &Size, codec: Codec, ) -> Result<(), EncodeError>

Check the passed length against the expected size and return an error if it does not match.

pub fn length_exceeds_platform_size(codec: Codec) -> EncodeError

Create an encode error for codec when the value is too large to be encoded on the current platform.

pub fn integer_type_conversion_failed(msg: String, codec: Codec) -> EncodeError

Create an error for failed conversion from BitInt or BigUint to primitive integer types

pub fn opaque_conversion_failed(msg: String, codec: Codec) -> EncodeError

Create an error if conversion to opaque type failed.

This is mainly used as part of SMI standard which converts type to BER encoding and handles bytes as Opaque.

pub fn variant_not_in_choice(codec: Codec) -> EncodeError

Create an error when the selected variant is not found in the choice.

pub fn real_not_supported(codec: Codec) -> EncodeError

Returns an encode error when the encoder doesn’t support REAL type.

pub fn from_kind(kind: EncodeErrorKind, codec: Codec) -> EncodeError

A helper function to construct an EncodeError from the given kind and codec.

Trait Implementations

impl Debug for EncodeError

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

Formats the value using the given formatter.

impl Display for EncodeError

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

Formats the value using the given formatter.

impl Error for EncodeError

fn custom<D>(msg: D, codec: Codec) -> EncodeError

where D: Display,

Creates a new general error using msg and current codec when encoding ASN.1.

impl Error for EncodeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AperEncodeErrorKind> for EncodeError

fn from(error: AperEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<BerEncodeErrorKind> for EncodeError

fn from(error: BerEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<CerEncodeErrorKind> for EncodeError

fn from(error: CerEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<CodecEncodeError> for EncodeError

fn from(error: CodecEncodeError) -> EncodeError

Converts to this type from the input type.

impl From<CoerEncodeErrorKind> for EncodeError

fn from(error: CoerEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<DerEncodeErrorKind> for EncodeError

fn from(error: DerEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<EncodeError> for Error

fn from(source: RasnEncodeError) -> Self

Converts to this type from the input type.

impl From<JerEncodeErrorKind> for EncodeError

fn from(error: JerEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<UperEncodeErrorKind> for EncodeError

fn from(error: UperEncodeErrorKind) -> EncodeError

Converts to this type from the input type.

impl From<XerEncodeErrorKind> for EncodeError

fn from(error: XerEncodeErrorKind) -> EncodeError

Converts to this type from the input type.