//! Error type for BER/DER parsers

use crate::ber::BerObject;

use crate::der::DerObject;

use alloc::fmt;

use nom::error::{ErrorKind, FromExternalError, ParseError};

use nom::IResult;

/// Holds the result of parsing functions

///

/// `O` is the output type, and defaults to a `BerObject`.

///

/// Note that this type is also a `Result`, so usual functions (`map`, `unwrap` etc.) are available.

///

/// This type is a wrapper around nom's IResult type

pub type BerResult<'a, O = BerObject<'a>> = IResult<&'a [u8], O, BerError>;

/// Holds the result of parsing functions (DER)

///

/// Note that this type is also a `Result`, so usual functions (`map`, `unwrap` etc.) are available.

pub type DerResult<'a> = BerResult<'a, DerObject<'a>>;

/// Error for BER/DER parsers

#[derive(Debug, PartialEq, Copy, Clone)]

pub enum BerError {

    /// BER object does not have the expected type

    BerTypeError,

    /// BER object does not have the expected value

    BerValueError,

    InvalidTag,

    InvalidClass,

    InvalidLength,

    IndefiniteLengthUnexpected,

    /// DER object was expected to be constructed (and found to be primitive)

    ConstructExpected,

    /// DER object was expected to be primitive (and found to be constructed)

    ConstructUnexpected,

    /// BER string has characters forbidden in standard

    StringInvalidCharset,

    /// BER integer is too large to fit in a native type. Use `as_bigint()`

    IntegerTooLarge,

    /// BER integer is negative, while an unsigned integer was requested

    IntegerNegative,

    /// BER recursive parsing reached maximum depth (See

    /// [MAX_RECURSION](../ber/constant.MAX_RECURSION.html))

    BerMaxDepth,

    /// When parsing a defined sequence, some items could not be found

    ObjectTooShort,

    /// A DER constraint failed (object may be using BER encoding?)

    DerConstraintFailed,

    UnknownTag,

    /// Feature is not yet implemented

    Unsupported,

    /// Custom error type left for parsers on top of this crate, so they can handle their custom

    /// errors

    Custom(u32),

    /// Error raised by the underlying nom parser

    NomError(ErrorKind),

}

impl From<BerError> for nom::Err<BerError> {

    fn from(e: BerError) -> nom::Err<BerError> {

        nom::Err::Error(e)

    }

}

impl<I> ParseError<I> for BerError {

    fn from_error_kind(_input: I, kind: ErrorKind) -> Self {

        BerError::NomError(kind)

    }

<der_parser::error::BerError as nom::error::ParseError<&[u8]>>::from_error_kind

Line

Count

Source

79

345k

    fn from_error_kind(_input: I, kind: ErrorKind) -> Self {

80

345k

        BerError::NomError(kind)

81

345k

    }

<der_parser::error::BerError as nom::error::ParseError<&[u8]>>::from_error_kind

Line

Count

Source

79

95.8k

    fn from_error_kind(_input: I, kind: ErrorKind) -> Self {

80

95.8k

        BerError::NomError(kind)

81

95.8k

    }

    fn append(_input: I, kind: ErrorKind, _other: Self) -> Self {

        BerError::NomError(kind)

    }

<der_parser::error::BerError as nom::error::ParseError<&[u8]>>::append

Line

Count

Source

82

11.7k

    fn append(_input: I, kind: ErrorKind, _other: Self) -> Self {

83

11.7k

        BerError::NomError(kind)

84

11.7k

    }

<der_parser::error::BerError as nom::error::ParseError<&[u8]>>::append

Line

Count

Source

82

44.8k

    fn append(_input: I, kind: ErrorKind, _other: Self) -> Self {

83

44.8k

        BerError::NomError(kind)

84

44.8k

    }

}

impl<I, E> FromExternalError<I, E> for BerError {

    fn from_external_error(_input: I, kind: ErrorKind, _e: E) -> BerError {

        BerError::NomError(kind)

    }

<der_parser::error::BerError as nom::error::FromExternalError<&[u8], der_parser::error::BerError>>::from_external_error

Line

Count

Source

88

9.58k

    fn from_external_error(_input: I, kind: ErrorKind, _e: E) -> BerError {

89

9.58k

        BerError::NomError(kind)

90

9.58k

    }

Unexecuted instantiation: <der_parser::error::BerError as nom::error::FromExternalError<_, _>>::from_external_error

}

impl fmt::Display for BerError {

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

        write!(f, "{:?}", self)

    }

}

#[cfg(feature = "std")]

impl std::error::Error for BerError {}

#[cfg(all(test, feature = "std"))]

mod tests {

    use super::*;

    use std::boxed::Box;

    use std::error::Error;

    #[test]

    fn test_unwrap_bererror() {

        let e = BerError::IntegerTooLarge;

        // println!("{}", e);

        let _: Result<(), Box<dyn Error>> = Err(Box::new(e));

    }

}