Struct SettingsItem 

#[non_exhaustive]
pub struct SettingsItem {
    pub code: String,
    pub label: Text,
    pub description: Text,
    pub category: Text,
    pub hint: Option<Text>,
    pub confirm_leave: bool,
    pub order: i32,
    pub icon: Option<String>,
    pub permission: Option<String>,
    pub link: Option<String>,
    pub fields: Vec<FormField>,
    pub per_operator: bool,
    /* private fields */
}

A settings model surfaced in the admin: a storage code, a category and order that place it in the index, and the fields to edit.

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.

code: String

Storage key. Matches the model’s SettingsModel::CODE.

This is a storage key and never a URL. It is dotted, like the module identity it derives from, and a dotted identifier in a path is how these screens spent months at /settings/rainmill.discovery.robots. Where the screen mounts is SettingsItem::route, resolved at boot through the module’s namespace like every other contributed screen.

label: Text

The item’s label, description, and category heading, localized at render.

description: Text

category: Text

Group heading in the index.

hint: Option<Text>

A fuller explanation, shown as a note at the top of this screen and nowhere else. Where SettingsItem::description must stay short enough to read in a sidebar, this has room to say why the screen exists.

confirm_leave: bool

Ask before leaving this screen with changes unsaved. Default true.

order: i32

Weight within the category (lower sorts first).

icon: Option<String>

Icon name shown beside the item in the context sidebar (a Lucide name such as users or shield). None falls back to a generic glyph.

permission: Option<String>

Permission required to edit, enforced by middleware. None means any authenticated operator.

link: Option<String>

When set, the item links to this route (e.g. a resource list) instead of its settings form. Used to place list/form screens (like Administrators) in the settings menu rather than the main menu.

fields: Vec<FormField>

per_operator: bool

Stored once per operator, among their preferences, and edited from the Preferences page rather than Settings. See store::PreferencesModel.

Implementations

impl SettingsItem

pub fn new( code: impl Into<String>, label: impl Into<Text>, fields: Vec<FormField>, ) -> Self

A settings screen for code (the model’s SettingsModel::CODE), titled label, editing fields.

Everything else takes a default and is opted into through a builder method, so a field added later costs existing callers nothing.

pub fn per_operator(self) -> Self

Keeps a value per operator, edited from their Preferences page. The permission still applies; the category is not used.

pub fn description(self, text: impl Into<Text>) -> Self

The sentence under the item’s name in the index and sidebar.

Keep it to two lines in the sidebar, which is 72 characters at the panel’s width. A description longer than that stops being a label and starts being a lecture in a column 211 pixels wide; put the explanation in SettingsItem::hint, where the reader has already chosen to look.

pub fn hint(self, text: impl Into<Text>) -> Self

A fuller explanation for the top of this screen. Unlike the description, it has no length limit: the reader has opened the screen.

pub fn confirm_leave(self, ask: bool) -> Self

Whether leaving this screen with changes unsaved asks first. Default true.

pub fn category(self, text: impl Into<Text>) -> Self

The group heading this item sorts under.

pub fn order(self, order: i32) -> Self

Weight within the category; lower sorts first.

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

A Lucide icon name shown beside the item.

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

The permission required to edit, enforced by middleware.

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

Point the item at an existing route instead of its own settings form, so a list screen can sit in the settings menu.

pub fn path(&self, admin_path: &str) -> String

Where this item leads, resolved under the admin mount (admin_path): its link target if set, else its own settings screen. Both are authored relative to the admin root, so this prepends the mount.

Trait Implementations

impl Clone for SettingsItem

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 SettingsItem

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

Formats the value using the given formatter.

impl Serialize for SettingsItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.