Enum AuthTokenError 

pub enum AuthTokenError {
    DeadlineNotInFuture {
        deadline: i64,
        now: i64,
    },
    TtlTooLarge {
        deadline: i64,
        now: i64,
        max_ttl_secs: i64,
    },
    ClockBeforeEpoch,
    MessageEncoding {
        offset: usize,
    },
}

Errors raised by build_auth_token.

Variants

DeadlineNotInFuture

The supplied deadline is at or before now.

Fields

deadline: i64

Caller-supplied deadline (UNIX seconds).

now: i64

Reference now (UNIX seconds).

TtlTooLarge

The supplied deadline exceeds the venue’s maximum TTL.

Fields

deadline: i64

Caller-supplied deadline (UNIX seconds).

now: i64

Reference now (UNIX seconds).

max_ttl_secs: i64

Configured maximum TTL in seconds.

ClockBeforeEpoch

The system clock is before the UNIX epoch.

MessageEncoding

An 8-byte chunk of the message decoded to a non-canonical Goldilocks element (>= p).

Cannot occur for the auth-token format ("{deadline}:{account}:{key}") since every byte is ASCII; surfaced as a typed error rather than a panic so callers of hash_auth_message with arbitrary input get a recoverable failure.

Fields

offset: usize

Byte offset of the offending 8-byte chunk in the input.

Trait Implementations

impl Debug for AuthTokenError

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

Formats the value using the given formatter.

impl Display for AuthTokenError

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

Formats the value using the given formatter.

impl Eq for AuthTokenError

impl Error for AuthTokenError

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 PartialEq for AuthTokenError

fn eq(&self, other: &AuthTokenError) -> 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 AuthTokenError