Enum Error

#[non_exhaustive]
pub enum Error {
    Pattern(PatternProblem),
    Init(InitStage),
    Prereq(Prerequisite),
    State(StateProblem),
    Input,
    Dh,
    Decrypt,
    Rng,
}

snow provides decently detailed errors, exposed as the Error enum, to allow developers to react to errors in a more actionable way.

With that said, security vulnerabilities can be introduced by passing along detailed failure information to an attacker. While an effort was made to not make any particularly foolish choices in this regard, we strongly recommend you don’t dump the Debug output to a user, for example.

This enum is intentionally non-exhasutive to allow new error types to be introduced without causing a breaking API change.

snow may eventually add a feature flag and enum variant to only return an “unspecified” error for those who would prefer safety over observability.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pattern(PatternProblem)

The noise pattern failed to parse.

Init(InitStage)

Initialization failure, at a provided stage.

Prereq(Prerequisite)

Missing prerequisite material.

State(StateProblem)

An error in snow’s internal state.

Input

Invalid input.

Dh

Diffie-Hellman agreement failed.

Decrypt

Decryption failed.

Rng

RNG failed.

Trait Implementations

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)>

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<InitStage> for Error

fn from(reason: InitStage) -> Self

Converts to this type from the input type.

impl From<PatternProblem> for Error

fn from(reason: PatternProblem) -> Self

Converts to this type from the input type.

impl From<Prerequisite> for Error

fn from(reason: Prerequisite) -> Self

Converts to this type from the input type.

impl From<StateProblem> for Error

fn from(reason: StateProblem) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error