Skip to main content

AdminPageCtx

Struct AdminPageCtx 

Source
pub struct AdminPageCtx<'a> {
    pub tera: &'a Arc<Tera>,
    pub tenant: &'a Tenant,
    pub headers: &'a HeaderMap,
    pub user: Option<&'a User>,
    pub uri: &'a Uri,
    pub action: Option<&'a str>,
}
Expand description

Request-scoped context handed to every custom admin page. References rather than owns so the handler doesn’t have to clone the Tera instance / per-tenant pool.

Fields§

§tera: &'a Arc<Tera>§tenant: &'a Tenant§headers: &'a HeaderMap§user: Option<&'a User>

The signed-in user, which the dispatcher has already resolved.

Without it a custom page can know only that somebody is logged in, so it cannot gate on a codename — and a page that manages anything sensitive has to. It is also what crate::admin::handlers::add_chrome needs to fill in the per-user half of the sidebar.

§uri: &'a Uri

The request URI, for the query string (?id=7, ?q=…).

§action: Option<&'a str>

The path segment after the slug: edit for /cms-admin/x/<slug>/edit, None for the page itself.

Implementations§

Source§

impl AdminPageCtx<'_>

Source

pub fn query(&self) -> HashMap<String, String>

The query string as a map. A repeated key keeps its last value.

Source

pub fn query_param(&self, name: &str) -> Option<String>

One query-string value, trimmed; None when absent or blank.

Source

pub async fn render(&self, template: &str, ctx: &mut Context) -> Response

Render template inside the admin chrome. Adds what every admin screen needs to ctx: the sidebar (with this page marked active), the signed-in user, branding, the admin theme, the admin language, csrf_token and pending flash messages. A template error renders a 500.

Source

pub fn redirect(&self, to: &str, level: MessageLevel, message: &str) -> Response

303 See Other to to, with a flash message the next admin page shows. The message is translated for the admin language when the catalogs have it.

Source

pub async fn has_perm(&self, codename: &str) -> bool

Whether the signed-in user holds codename. Superusers hold every codename; no user holds none.

Source

pub fn page_url(&self) -> String

/cms-admin/x/<slug>, the URL of this page.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for AdminPageCtx<'a>

§

impl<'a> !UnwindSafe for AdminPageCtx<'a>

§

impl<'a> Forget for AdminPageCtx<'a>

§

impl<'a> Freeze for AdminPageCtx<'a>

§

impl<'a> Send for AdminPageCtx<'a>

§

impl<'a> Sync for AdminPageCtx<'a>

§

impl<'a> Unpin for AdminPageCtx<'a>

§

impl<'a> UnsafeUnpin for AdminPageCtx<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more