Struct ImpersonationBanner 

#[non_exhaustive]
pub struct ImpersonationBanner {
    pub effective_user_id: String,
    pub impersonator_id: String,
    pub admin_prefix: String,
    pub csrf_token: String,
    pub csrf_form_field: String,
    pub return_to: String,
}

Everything the impersonation banner needs to render.

Built from an ImpersonationState plus the request’s CSRF token; see impersonation_banner_for for the one-call version that reads both from the request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

effective_user_id: String

The user the session is currently acting as.

impersonator_id: String

The real operator behind the session.

admin_prefix: String

Prefix the admin plugin is mounted at; the revert form posts to {admin_prefix}/impersonate/stop.

csrf_token: String

CSRF token for that form. Empty when no CsrfLayer is installed, in which case the hidden field is omitted entirely.

csrf_form_field: String

Configured CSRF form-field name (defaults to _csrf when empty).

return_to: String

Path the browser returns to after reverting. Empty means “the admin panel”; the revert route re-validates it as a same-origin relative path either way, so it can never become an open redirect.

Implementations

impl ImpersonationBanner

pub fn new( state: &ImpersonationState, admin_prefix: &str, csrf_token: &str, csrf_form_field: &str, ) -> Self

Build the banner view-model for an active impersonation.

pub fn returning_to(self, path: impl Into<String>) -> Self

Return the operator to path after reverting, instead of to the admin panel. Worth setting when the banner is embedded in the application’s own layout. Re-validated server-side on the revert route.

Trait Implementations

impl Clone for ImpersonationBanner

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImpersonationBanner

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

Formats the value using the given formatter.