Enum Code

#[non_exhaustive]
pub enum Code {
    MissingSecret,
    InvalidSecret,
    MissingUserIp,
    InvalidUserIp,
    MissingSiteKey,
    InvalidSiteKey,
    MissingResponse,
    InvalidResponse,
    BadRequest,
    InvalidAlreadySeen,
    SiteSecretMismatch,
    InvalidSecretExtWrongLen,
    InvalidSecretExtNotHex,
    SecretVersionUnknown,
    Unknown(String),
}

Error code mapping for the error responses from the captval API. Returned in the [enum@Error] type.

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.

MissingSecret

Secret key is missing.

InvalidSecret

Secret key is invalid or malformed.

MissingUserIp

User IP string is missing.

InvalidUserIp

User IP is invalid or malformed.

MissingSiteKey

Site Key string is missing.

InvalidSiteKey

Site Key is invalid or malformed.

MissingResponse

The response parameter (verification token) is missing.

InvalidResponse

The response parameter (verification token) is invalid or malformed.

BadRequest

The request is invalid or malformed.

InvalidAlreadySeen

The response parameter has already been checked, or has another issue.

SiteSecretMismatch

The sitekey is not registered with the provided secret.

InvalidSecretExtWrongLen

Extended secret check reports that the secret string is the wrong length.

InvalidSecretExtNotHex

Extended secret check reports that the secret string is not a hex string.

SecretVersionUnknown

Extended secret check identifies the version of secret by the first two characters. If the secret is valid there may be a new version that is not yet known. A false report can be worked around by dropping the ext feature.

captval = {version = "2.3.0", default-features = false, features = [rustls-backend]}

Unknown(String)

Collect any new error codes issued by the API.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Code

fn deserialize<D>(de: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Custom deserialize to map the captval API error codes for reporting as a Code in [enum@Error].

impl Display for Code

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

Formats the value using the given formatter.

impl Hash for Code

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Code

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Code

impl StructuralPartialEq for Code