Struct SecurityScopes 

pub struct SecurityScopes { /* private fields */ }

Required OAuth2 security scopes for a handler.

SecurityScopes aggregates the scopes required by the current handler’s security dependency chain. It is typically injected alongside a bearer token extractor so the handler can verify that the token grants the required scopes.

In Python FastAPI, SecurityScopes is automatically populated from the scopes parameter on Security(...) dependencies. In this Rust implementation, scopes are set via request extensions (populated by middleware or route configuration) and read by the FromRequest impl.

Example

use fastapi_core::{SecurityScopes, BearerToken};

async fn get_admin(
    token: BearerToken,
    scopes: SecurityScopes,
) -> impl IntoResponse {
    // scopes.scopes() returns ["admin", "users:read"]
    // Verify the token grants all required scopes
    for scope in scopes.scopes() {
        // check token has scope...
    }
}

Implementations

impl SecurityScopes

pub fn new() -> Self

Create empty security scopes (no scopes required).

pub fn from_scopes(scopes: impl IntoIterator<Item = impl Into<String>>) -> Self

Create from a list of scope strings.

Duplicates are removed while preserving order.

pub fn from_scope_str(scope_str: &str) -> Self

Create from a space-separated scope string.

The string is split on spaces, empty segments are ignored, and duplicates are removed while preserving order.

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

Get the required scopes as a slice.

pub fn scope_str(&self) -> &str

Get the space-separated scope string.

pub fn contains(&self, scope: &str) -> bool

Check if a specific scope is required.

pub fn is_empty(&self) -> bool

Returns true if no scopes are required.

pub fn len(&self) -> usize

Returns the number of required scopes.

pub fn merge(&mut self, other: &SecurityScopes)

Merge another set of scopes into this one.

New scopes are appended, preserving order and deduplicating.

pub fn merged(&self, other: &SecurityScopes) -> Self

Create a new SecurityScopes by merging two sets.

Trait Implementations

impl Clone for SecurityScopes

fn clone(&self) -> SecurityScopes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityScopes

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

Formats the value using the given formatter.

impl Default for SecurityScopes

fn default() -> Self

Returns the “default value” for a type.

impl Display for SecurityScopes

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

Formats the value using the given formatter.

impl FromRequest for SecurityScopes

type Error = SecurityScopesError

Error type when extraction fails.

async fn from_request( _ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request.