Struct Resource 

#[non_exhaustive]
pub struct Resource {
    pub base_path: String,
    pub nav_label: Text,
    pub list: ListConfig,
    pub form: Option<FormConfig>,
    pub permission: Option<String>,
    pub import: Option<ImportConfig>,
    pub relations: Vec<RelationConfig>,
}

An admin resource: a list screen, optionally with a create/edit form, mounted under base_path and shown in the menu as nav_label.

Built with Resource::new plus its builder methods. Non-exhaustive because this is the descriptor a plugin author writes and the one most likely to grow: a struct literal outside this crate would freeze its field set at 1.0, so the framework could never learn anything new about a resource.

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.

base_path: String

The path the resource mounts at, relative to the admin root and starting with a slash (e.g. /products). The framework prepends the configured admin mount, so a resource never hardcodes it and survives a moved panel. The list’s edit_base and the form’s base_path are resolved the same way.

nav_label: Text

The menu label, localized at render. Serde stays a plain string.

list: ListConfig

form: Option<FormConfig>

permission: Option<String>

The permission an operator must hold to reach any of the resource’s routes. A dotted string gates every route the resource mounts, and an operator who lacks it receives 403 Forbidden; superusers pass regardless. None leaves the resource open to any signed-in operator and is allowed only for a read-only resource: a resource with a create/edit form must declare a permission, or boot aborts (see [mount_resource]).

import: Option<ImportConfig>

Whether records may be imported into this resource, and by whom. The pages mount under the resource’s path; see import.

relations: Vec<RelationConfig>

Other entities’ records that belong to each of this resource’s records, each a section on the edit page. See relation::RelationConfig.

Implementations

impl Resource

pub fn new( base_path: impl Into<String>, nav_label: impl Into<Text>, list: ListConfig, ) -> Self

A read-only resource: a list at base_path, in the menu as nav_label.

A create/edit form is added with Resource::form, which also requires Resource::permission: an unguarded write resource aborts boot.

pub fn relation(self, relation: RelationConfig) -> Self

Adds a section of related records to the edit page. Needs a form.

pub fn import(self, import: ImportConfig) -> Self

Lets records be imported into this resource, which needs a form.

pub fn form(self, form: FormConfig) -> Self

Adds the create/edit form. A resource with one must also declare a permission, or boot aborts.

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

The permission gating every route this resource mounts.

Trait Implementations

impl Serialize for Resource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.