Enum rsip::Error

pub enum Error {
    MissingHeader(String),
    InvalidParam(String),
    ParseError(String),
    TokenizeError(String),
    Utf8Error(String),
    Unexpected(String),
}

The Error enum indicates that something went wrong

It has 6 variants:

• MissingHeader that a header that is expected to be found was completely missing. There are some headers that are required everywhere in SIP, like From, To etc.
• InvalidParam means some header parser did not succeed, and the reason for it is a missing or invalid parameter. Inner String should have the nom verbose error about it.
• ParseError indicates a general parsing error. Inner String should have the verbose nom error giving hints on what went wrong.
• TokenizeError indicates a general tokenizer error. Inner String should have the verbose nom error giving hints on what went wrong. A Tokenizer just tries to break the bytes into parts/components of rsip structs, but never tries to parse/convert to a specific type. So if a tokenizer fails and you get this error, it means it couldn’t even manage to break the SIP message in the correct breakpoints.
• Utf8Error indicates that the from_utf8 std method completely failed. At least you should get the information regarding which header had this issue.
• Unexpected indicates any other error.

Variants

MissingHeader(String)

InvalidParam(String)

ParseError(String)

TokenizeError(String)

Utf8Error(String)

Unexpected(String)

Implementations

impl Error

pub fn tokenizer<'a, S, T>(tuple: (S, T)) -> Self where
    S: Into<String>,
    T: Into<&'a BStr>, 

pub fn missing_header(header: &'static str) -> Self

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<Err<TokenizerError>> for Error

fn from(from: Err<TokenizerError>) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for Error

fn from(error: ParseIntError) -> Self

Converts to this type from the input type.

impl From<TokenizerError> for Error

fn from(from: TokenizerError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(error: Utf8Error) -> Self

Converts to this type from the input type.

impl PartialEq<Error> for Error

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Error) -> bool

This method tests for !=.

impl Eq for Error

impl StructuralEq for Error

impl StructuralPartialEq for Error