PageDefinition

Struct PageDefinition 

Source
pub struct PageDefinition {
Show 16 fields pub route: String, pub title: String, pub icon: Option<String>, pub description: Option<String>, pub show_in_menu: bool, pub menu_order: i32, pub parent_route: Option<String>, pub requires_auth: bool, pub permissions: Vec<String>, pub roles: Vec<String>, pub state: HashMap<String, StateFieldDefinition>, pub computed: HashMap<String, String>, pub sections: Vec<ComponentSchema>, pub actions: HashMap<String, Action>, pub hooks: Option<PageLifecycleHooks>, pub dialogs: Vec<DialogDefinition>,
}
Expand description

Enhanced page definition for plugin UI.

Fields§

§route: String

Route path for the page.

§title: String

Page title.

§icon: Option<String>

Icon name (from icon library).

§description: Option<String>

Page description.

§show_in_menu: bool

Whether to show in navigation menu.

§menu_order: i32

Menu order (lower = higher priority).

§parent_route: Option<String>

Parent route (for nested pages).

§requires_auth: bool

Whether authentication is required.

§permissions: Vec<String>

Required permissions to view page.

§roles: Vec<String>

Required roles to view page.

§state: HashMap<String, StateFieldDefinition>

Page-level state definition.

§computed: HashMap<String, String>

Computed values derived from state.

§sections: Vec<ComponentSchema>

Page sections/content.

§actions: HashMap<String, Action>

Page-level action definitions.

§hooks: Option<PageLifecycleHooks>

Page lifecycle hooks.

§dialogs: Vec<DialogDefinition>

Dialog definitions.

Implementations§

Source§

impl PageDefinition

Source

pub fn validate(&self) -> Result<()>

Validate the page definition.

§Errors

Returns an error if the page is invalid.

Source

pub fn full_route(&self, plugin_name: &str) -> String

Get the full route path with plugin prefix.

Trait Implementations§

Source§

impl Clone for PageDefinition

Source§

fn clone(&self) -> PageDefinition

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PageDefinition

Source§

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

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

impl<'de> Deserialize<'de> for PageDefinition

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PageDefinition

Source§

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

Serialize this value into the given Serde serializer. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,