Enum schnorrkel::errors::SignatureError

source ·
pub enum SignatureError {
    EquationFalse,
    PointDecompressionError,
    ScalarFormatError,
    InvalidKey,
    BytesLengthError {
        name: &'static str,
        description: &'static str,
        length: usize,
    },
    NotMarkedSchnorrkel,
    MuSigAbsent {
        musig_stage: MultiSignatureStage,
    },
    MuSigInconsistent {
        musig_stage: MultiSignatureStage,
        duplicate: bool,
    },
}
Expand description

Errors which may occur while processing signatures and keypairs.

All these errors represent a failed signature when they occur in the context of verifying a signature, including in deserializaing for verification. We expose the distinction among them primarily for debugging purposes.

This error may arise due to:

  • Being given bytes with a length different to what was expected.

  • A problem decompressing r, a curve point, in the Signature, or the curve point for a PublicKey.

  • A problem with the format of s, a scalar, in the Signature. This is only raised if the high-bit of the scalar was set. (Scalars must only be constructed from 255-bit integers.)

  • Multi-signature protocol errors

Variants§

§

EquationFalse

A signature verification equation failed.

We emphasise that all variants represent a failed signature, not only this one.

§

PointDecompressionError

Invalid point provided, usually to verify methods.

§

ScalarFormatError

Invalid scalar provided, usually to Signature::from_bytes.

§

InvalidKey

The provided key is not valid.

§

BytesLengthError

An error in the length of bytes handed to a constructor.

To use this, pass a string specifying the name of the type which is returning the error, and the length in bytes which its constructor expects.

Fields

§name: &'static str

Identifies the type returning the error

§description: &'static str

Describes the type returning the error

§length: usize

Length expected by the constructor in bytes

§

NotMarkedSchnorrkel

Signature not marked as schnorrkel, maybe try ed25519 instead.

§

MuSigAbsent

There is no record of the preceding multi-signautre protocol stage for the specified public key.

Fields

§musig_stage: MultiSignatureStage

Identifies the multi-signature protocol stage during which the error occurred.

§

MuSigInconsistent

For this public key, there are either conflicting records for the preceding multi-signautre protocol stage or else duplicate duplicate records for the current stage.

Fields

§musig_stage: MultiSignatureStage

Identifies the multi-signature protocol stage during which the error occurred.

§duplicate: bool

Set true if the stage was reached correctly once but this duplicate disagrees.

Trait Implementations§

source§

impl Clone for SignatureError

source§

fn clone(&self) -> SignatureError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SignatureError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for SignatureError

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for SignatureError

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for SignatureError

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for SignatureError

source§

impl Eq for SignatureError

source§

impl StructuralPartialEq for SignatureError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V