Struct Identities 

pub struct Identities { /* private fields */ }

Installs the identity layer. See the module docs.

Order does not matter: the middleware runs in Phase::Call, which is inside the phase the session plugin uses, so the session is always loaded by the time the deadlines are checked.

Implementations

impl Identities

pub fn new() -> Self

No deadlines, and 401 for an unauthenticated visitor.

pub fn login_deadline(self, secs: i64) -> Self

End a login secs after it started, however active the visitor is.

Panics

If secs is not positive. A deadline of zero or less would log every visitor out on the request after they signed in, which is never the intent.

pub fn visit_deadline(self, secs: i64) -> Self

End a login after secs with no requests.

Enabling this makes the layer maintain a last-seen timestamp in the session. It is refreshed at most once per tenth of the deadline, not on every request: the session plugin only re-issues a cookie when the session changed, and touching a timestamp on every request would rewrite the cookie every time and quietly extend the expiry of a session nobody is really using. The cost of that thrift is that the idle timeout is accurate to within a tenth of itself.

Panics

If secs is not positive.

pub fn login_url(self, url: impl Into<String>) -> Self

Send unauthenticated visitors to url instead of answering 401.

Applies to the Authenticated extractor. An API generally wants the 401; a server-rendered application generally wants the redirect.

Trait Implementations

impl Clone for Identities

fn clone(&self) -> Identities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identities

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

Formats the value using the given formatter.

impl Default for Identities

fn default() -> Identities

Returns the “default value” for a type.

impl Plugin for Identities

fn install(self: Box<Self>, app: &mut AppBuilder)

Install this plugin into the builder (register middleware, state, etc.). Consumes the boxed plugin.