Struct minerva_rest::fairings::auth::SessionInfo

pub struct SessionInfo {
    pub info: Session,
    pub token: String,
}

Struct for session information that can be retrieved for every access to a route that explicitly retrieves it.

Adding a State containing a SessionInfo to a route function’s parameters automatically means that the route will only be accessible by an authenticated user that passes its authentication info through cookies. If a SessionInfo can be retrieved given the cookies information, then the user is authenticated for using that route.

Fields

info: Session

Session info for the authenticated user.

token: String

Session token for the authenticated user.

Implementations

impl SessionInfo

pub fn from(info: SessionData, token: String) -> Self

Generates a new session info from a SessionData gRPC message.

Trait Implementations

impl<'r> FromRequest<'r> for SessionInfo

type Error = SessionError

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>(
    req: &'r Request<'life0>
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>>where
    'r: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl<'a> OpenApiFromRequest<'a> for SessionInfo

fn from_request_input(
    _gen: &mut OpenApiGenerator,
    _name: String,
    _required: bool
) -> Result<RequestHeaderInput>

Specifies what headers or other parameters are required for this Request Guards to validate successfully.

fn get_responses(_gen: &mut OpenApiGenerator) -> Result<Responses, OpenApiError>

Optionally add responses to the Request Guard. This can be used for when the request guard could return a “401 Unauthorized”. Or any other responses, other then one from the default response.