Skip to main content

ResourceAdmin

Struct ResourceAdmin 

Source
pub struct ResourceAdmin {
    pub visible: Option<bool>,
    pub roles: Vec<String>,
    pub label: Option<String>,
    pub plural: Option<String>,
    pub group: Option<String>,
    pub display_field: Option<String>,
    pub columns: Vec<String>,
    pub search_field: Option<String>,
    pub order: i64,
}
Expand description

The [admin] section of a resource: how it is presented — and to whom — in the generated dashboard.

This is presentation only. Hiding a resource from the dashboard does not make its API endpoints any less reachable; that is what Permissions is for. The two are deliberately separate: [permissions] decides what the API allows, [admin] decides what an operator is shown.

Fields§

§visible: Option<bool>

Show this resource in the dashboard. Unset means “decide from the resource” — see ResourceAdmin::is_visible.

§roles: Vec<String>

Organisation roles that may see it. Empty means “anyone who can list it” — the API remains the authority either way.

§label: Option<String>

Human label for one record (“Product”). Defaults to the resource name.

§plural: Option<String>

Human label for the collection (“Products”). Defaults to label + “s”.

§group: Option<String>

Sidebar group heading (“Catalogue”). Ungrouped resources sort last.

§display_field: Option<String>

Which field to render when a record is named — in tables, in reference pickers, in breadcrumbs. Defaults to the first sensible string field.

§columns: Vec<String>

Columns to show in the list table, in order. Empty means “pick for me”.

§search_field: Option<String>

Field the list search box filters on. Defaults to display_field.

§order: i64

Sort key within the sidebar group; lower comes first.

Implementations§

Source§

impl ResourceAdmin

Source

pub fn is_visible(&self, resource_name: &str) -> bool

Whether the named resource appears in the dashboard’s resource navigation.

An explicit visible always wins. Otherwise the auth resources default to hidden — they are managed through purpose-built screens (account, team, organisation, API keys), and a raw table of membership rows is exactly the developer-facing surface the dashboard is meant to avoid.

Trait Implementations§

Source§

impl Clone for ResourceAdmin

Source§

fn clone(&self) -> ResourceAdmin

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResourceAdmin

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ResourceAdmin

Source§

fn default() -> ResourceAdmin

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ResourceAdmin

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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