Struct NavItem 

#[non_exhaustive]
pub struct NavItem {
    pub key: String,
    pub label: Text,
    pub path: Option<String>,
    pub icon: Option<String>,
    pub permission: Option<String>,
    pub order: i32,
    pub after: Option<String>,
    pub before: Option<String>,
    pub under: Option<String>,
}

One menu entry: a tab, or an entry under a section.

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.

key: String

Unique among every item (acme.posts): what another item names in under.

label: Text

path: Option<String>

The path under the admin mount (/posts). A section may have none: its tab then leads to its first visible entry.

icon: Option<String>

An icon name from the icon set.

permission: Option<String>

What the operator must hold to see the entry. None shows it to every signed-in operator; a section with no path shows when any entry does.

order: i32

Sorts among siblings, lowest first; equal orders sort by label.

after: Option<String>

Sits right after the sibling with this key, whatever the orders say.

before: Option<String>

Sits right before the sibling with this key, whatever the orders say.

under: Option<String>

The key of the item this sits under; None is the top bar.

Implementations

impl NavItem

pub fn new( key: impl Into<String>, label: impl Into<Text>, path: impl Into<String>, ) -> Self

An entry leading to path.

pub fn section(key: impl Into<String>, label: impl Into<Text>) -> Self

A section: a tab that holds entries and leads to the first one.

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

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

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

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

Places the entry under the section with this key.

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

Sits right after the sibling with this key.

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

Sits right before the sibling with this key.

Trait Implementations

impl Clone for NavItem

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 NavItem

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

Formats the value using the given formatter.

impl Default for NavItem

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NavItem

where NavItem: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NavItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.