Skip to main content

RoutePosture

Enum RoutePosture 

Source
pub enum RoutePosture {
    Public {
        reason: String,
    },
    Authenticated,
    Permission {
        area: String,
        operation: String,
    },
    Owner {
        field: String,
    },
    Internal {
        callers: Vec<String>,
    },
    ApiKey {
        scope: String,
    },
    Scoped {
        area: String,
        operation: String,
        owner_field: Option<String>,
    },
}
Expand description

The authorization posture of a custom route, enforced by the platform so a guest handler cannot forget it.

Variants§

§

Public

Deliberately anonymous. reason is mandatory so every public route is greppable and reviewable (third-party webhooks, signup, public profiles).

Fields

§reason: String
§

Authenticated

Any authenticated tenant principal.

§

Permission

Authenticated and holding the {area}:{operation} permission.

Fields

§area: String
§operation: String
§

Owner

Authenticated; the guest scopes the operation to rows whose field equals the caller’s subject. The platform enforces authentication.

Fields

§field: String
§

Internal

Only another service of the tenant, calling through the platform with a platform-minted identity: callers names the services allowed, or is ["*"] for any. User credentials are not accepted.

Fields

§callers: Vec<String>
§

ApiKey

Only a partner key (X-Api-Key) of the tenant holding a scope that covers scope (resource[:action], resource:* covering every action). User credentials are not accepted.

Fields

§scope: String
§

Scoped

Authenticated and holding a grant on {area}:{operation}; the platform resolves the grants’ scopes (@own, @field(…), @all) into the rows the guest may reach, @own meaning owner_field holds the caller’s subject.

Fields

§area: String
§operation: String
§owner_field: Option<String>

Implementations§

Source§

impl RoutePosture

Source

pub fn is_anonymous(&self) -> bool

Whether a caller with no credentials can reach this route.

Source

pub fn label(&self) -> &'static str

Short human label for audit output.

Source

pub fn feature(&self) -> Option<&'static str>

The platform feature this posture needs beyond route_posture.

Source

pub fn admits_caller(callers: &[String], service: &str) -> bool

Whether service may call a route of this posture: listed, or any service when callers is ["*"].

Trait Implementations§

Source§

impl Clone for RoutePosture

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RoutePosture

Source§

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

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

impl<'de> Deserialize<'de> for RoutePosture

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for RoutePosture

Source§

impl PartialEq for RoutePosture

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for RoutePosture

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RoutePosture

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.