AccessDenied

Struct AccessDenied 

Source
pub struct AccessDenied { /* private fields */ }
Expand description

Error returned when authorization is explicitly denied.

This type is distinct from SDK errors (Error). It represents a successful authorization check that resulted in denial, not a failure to check.

§When is AccessDenied Returned?

  • check() returns Ok(false) for denial (not an error)
  • require() returns Err(AccessDenied) for denial
use inferadb::VaultClient;

async fn example(vault: &VaultClient) -> Result<(), Box<dyn std::error::Error>> {
    // check() - denial is Ok(false), not an error
    let allowed = vault.check("user:alice", "view", "doc:secret").await?;
    if !allowed {
        println!("Access denied (but no error)");
    }

    // require() - denial IS an error (AccessDenied)
    vault.check("user:alice", "view", "doc:secret")
        .require()
        .await?; // Returns Err(AccessDenied) if denied

    Ok(())
}

§Key Invariant

AccessDenied is NOT the same as ErrorKind::Forbidden:

TypeMeaningExample
AccessDeniedSubject lacks permission to resourceAlice can’t view doc:secret
ErrorKind::ForbiddenAPI caller lacks control plane permissionCan’t manage vault

§Rich Context

AccessDenied includes the authorization context for debugging:

use inferadb::AccessDenied;

fn handle_denied(denied: &AccessDenied) {
    println!("Subject: {}", denied.subject());
    println!("Permission: {}", denied.permission());
    println!("Resource: {}", denied.resource());

    if let Some(reason) = denied.reason() {
        println!("Reason: {}", reason);
    }
}

Implementations§

Source§

impl AccessDenied

Source

pub fn new( subject: impl Into<Cow<'static, str>>, permission: impl Into<Cow<'static, str>>, resource: impl Into<Cow<'static, str>>, ) -> Self

Creates a new AccessDenied error.

§Arguments
  • subject - The subject (e.g., “user:alice”) that was denied
  • permission - The permission (e.g., “view”) that was checked
  • resource - The resource (e.g., “document:readme”) that was checked
§Example
use inferadb::AccessDenied;

let denied = AccessDenied::new("user:alice", "delete", "document:readme");
assert_eq!(denied.subject(), "user:alice");
assert_eq!(denied.permission(), "delete");
assert_eq!(denied.resource(), "document:readme");
Source

pub fn subject(&self) -> &str

Returns the subject that was denied access.

This is typically in the format “type:id”, e.g., “user:alice” or “team:engineering”.

Source

pub fn permission(&self) -> &str

Returns the permission that was checked.

For example: “view”, “edit”, “delete”, “admin”.

Source

pub fn resource(&self) -> &str

Returns the resource that was checked.

This is typically in the format “type:id”, e.g., “document:readme” or “folder:reports”.

Source

pub fn reason(&self) -> Option<&str>

Returns the denial reason, if available.

The reason provides additional context about why access was denied. This may include information about missing relationships or failed conditions.

Source

pub fn request_id(&self) -> Option<&str>

Returns the request ID, if available.

Include this in logs for debugging and support correlation.

Source

pub fn with_reason(self, reason: impl Into<Cow<'static, str>>) -> Self

Sets the denial reason.

Source

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Sets the request ID.

Source

pub fn to_log_string(&self) -> String

Returns a formatted string suitable for logging.

This includes all available context in a structured format.

Trait Implementations§

Source§

impl Clone for AccessDenied

Source§

fn clone(&self) -> AccessDenied

Returns a duplicate 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 AccessDenied

Source§

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

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

impl Display for AccessDenied

Source§

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

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

impl Error for AccessDenied

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

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. Read more
Source§

impl From<AccessDenied> for Error

Allows converting AccessDenied to the main Error type.

Note: This creates an Error with kind Forbidden, but AccessDenied and ErrorKind::Forbidden have different semantic meanings:

  • AccessDenied: Subject lacks permission (data plane)
  • ErrorKind::Forbidden: Caller lacks API permission (control plane)
Source§

fn from(denied: AccessDenied) -> Self

Converts to this type from the input type.

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: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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§

fn to_string(&self) -> String

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

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

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

Source§

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

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more