Struct AuthRefusal 

pub struct AuthRefusal { /* private fields */ }

A refusal an AuthProvider returns, as CratestackError::AuthRefused through AuthRefusal::into_error. See the module documentation.

Implementations

impl AuthRefusal

pub fn unauthenticated(message: impl Into<String>) -> AuthRefusal

A 401 refusal (UNAUTHORIZED, RPC unauthenticated).

pub fn forbidden(message: impl Into<String>) -> AuthRefusal

A 403 refusal (FORBIDDEN, RPC permission_denied).

pub fn with_member(self, name: impl Into<String>, value: Value) -> AuthRefusal

Adds a top-level envelope member. A name in RESERVED_ENVELOPE_MEMBERS is ignored: a refusal cannot replace the framework’s code, message or details this way.

pub fn with_details(self, details: Value) -> AuthRefusal

Sets the envelope’s details member.

pub fn with_challenge(self, challenge: impl Into<String>) -> AuthRefusal

Adds a WWW-Authenticate header value, e.g. Bearer error="invalid_token". A value with anything but visible ASCII, spaces and tabs (a newline, a non-ASCII byte) is ignored, so a refusal can never break the response it rides on, and every client can read the header as text.

pub fn into_error(self) -> CratestackError

The CratestackError to return from AuthProvider::authenticate: Err(refusal.into_error()).

pub const fn kind(&self) -> AuthRefusalKind

401 or 403.

pub fn message(&self) -> &str

The public message, the envelope’s message.

pub fn members(&self) -> &BTreeMap<String, Value>

The extra top-level envelope members.

pub fn details(&self) -> Option<&Value>

The envelope’s details, if any.

pub fn challenges(&self) -> &[String]

The WWW-Authenticate header values, in the order they were added.

pub const fn is_dispatch_owned(&self) -> bool

Whether the generated dispatch claimed this refusal as its own: it refused the request before any procedure body ran, so an idempotency layer releases the key instead of recording the refusal (cratestack#1261). false for every refusal a provider or a body builds.

Trait Implementations

impl Clone for AuthRefusal

fn clone(&self) -> AuthRefusal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthRefusal

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

Formats the value using the given formatter.

impl PartialEq for AuthRefusal

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