Skip to main content

AdminState

quokka_admin::state

Struct AdminState 

Source 
pub struct AdminState<S> {
    pub title: String,
    pub navigation_groups: HashMap<String, AdminNavigationGroup>,
    pub sidebar_widgets: Vec<AdminSidebarWidget>,
    pub dashboard_widgets: Vec<AdminDashboardWidget>,
    pub entities: Vec<Arc<dyn TypeErasedEntityHandler<S> + Send + Sync>>,
    pub auth_providers: AuthProviders<S>,
    pub login_url: String,
    pub super_admin_group: Option<String>,
    pub login_providers: LoginProviders,
}

Fields§

§title: String§navigation_groups: HashMap<String, AdminNavigationGroup>§sidebar_widgets: Vec<AdminSidebarWidget>§dashboard_widgets: Vec<AdminDashboardWidget>§entities: Vec<Arc<dyn TypeErasedEntityHandler<S> + Send + Sync>>§auth_providers: AuthProviders<S>§login_url: String§super_admin_group: Option<String>§login_providers: LoginProviders

Implementations§

Source§

impl<S> AdminState<S>
where S: State + 'static,

Source

pub fn add_navigation(&mut self, group: impl Into<AdminNavigationGroup>)

Adds a navigation section for your bundle

Examples found in repository?
examples/full-admin.rs (lines 74-78)
67    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
68        let admin: &mut AdminState<_> = state.provide_mut();
69
70        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
71        admin.add_auth_provider(TestAuthProvider);
72        admin.add_login_provider(TestLoginProvider);
73
74        admin.add_navigation(
75            AdminNavigationGroup::new("Example").add(
76                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
77            ),
78        );
79
80        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
81        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible
82
83        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
84        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
85        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
86        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
87
88        admin.register_entity_handler(EntityHandler::<
89            S,
90            TestEntityCreateForm,
91            TestEntityUpdateForm,
92            TestEntityListing,
93        >::new("Example"));
94
95        Ok(())
96    }
Source

pub fn get_navigation(&self) -> Vec<AdminNavigationGroup>

Gets an ordered version of the navigation

Source

pub fn add_sidebar_widget(&mut self, widget: impl Into<AdminSidebarWidget>)

Adds a sidebar widget, check AdminSidebarWidget for details

Examples found in repository?
examples/full-admin.rs (line 80)
67    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
68        let admin: &mut AdminState<_> = state.provide_mut();
69
70        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
71        admin.add_auth_provider(TestAuthProvider);
72        admin.add_login_provider(TestLoginProvider);
73
74        admin.add_navigation(
75            AdminNavigationGroup::new("Example").add(
76                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
77            ),
78        );
79
80        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
81        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible
82
83        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
84        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
85        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
86        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
87
88        admin.register_entity_handler(EntityHandler::<
89            S,
90            TestEntityCreateForm,
91            TestEntityUpdateForm,
92            TestEntityListing,
93        >::new("Example"));
94
95        Ok(())
96    }
Source

pub fn add_dashboard_widget(&mut self, widget: impl Into<AdminDashboardWidget>)

Adds a dashboard widget, check AdminDashboardWidget for details

Examples found in repository?
examples/full-admin.rs (line 83)
67    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
68        let admin: &mut AdminState<_> = state.provide_mut();
69
70        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
71        admin.add_auth_provider(TestAuthProvider);
72        admin.add_login_provider(TestLoginProvider);
73
74        admin.add_navigation(
75            AdminNavigationGroup::new("Example").add(
76                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
77            ),
78        );
79
80        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
81        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible
82
83        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
84        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
85        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
86        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
87
88        admin.register_entity_handler(EntityHandler::<
89            S,
90            TestEntityCreateForm,
91            TestEntityUpdateForm,
92            TestEntityListing,
93        >::new("Example"));
94
95        Ok(())
96    }
Source

pub fn register_entity_handler<C, U, L>( &mut self, handler: EntityHandler<S, C, U, L>, )
where S: ProvideState<Database> + ProvideState<Templating> + ProvideState<FormBuilder<S>> + ProvideState<AdminCreateFormPageLoader<S, C>> + ProvideState<AdminUpdateFormPageLoader<S, U>> + ProvideState<AdminPageLoader>, C: AdminCreateForm<S> + DeserializeOwned + Serialize + Debug + Send + Sync + 'static, U: AdminUpdateForm<S> + DeserializeOwned + Serialize + Debug + Send + Sync + 'static, U::PrimaryKeys: DeserializeOwned + Send + Sync + 'static, L: AdminListing<S> + Clone + Send + Sync + Serialize + 'static, L::PrimaryKeys: DeserializeOwned + Send + Sync + 'static, L::Entity: Serialize + DeserializeOwned + Clone + Debug + Send + 'static,

Registers your custom entity to be managable in the admin-ui. Check the EntityHandler for more details.

Examples found in repository?
examples/full-admin.rs (lines 88-93)
67    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
68        let admin: &mut AdminState<_> = state.provide_mut();
69
70        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
71        admin.add_auth_provider(TestAuthProvider);
72        admin.add_login_provider(TestLoginProvider);
73
74        admin.add_navigation(
75            AdminNavigationGroup::new("Example").add(
76                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
77            ),
78        );
79
80        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
81        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible
82
83        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
84        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
85        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
86        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
87
88        admin.register_entity_handler(EntityHandler::<
89            S,
90            TestEntityCreateForm,
91            TestEntityUpdateForm,
92            TestEntityListing,
93        >::new("Example"));
94
95        Ok(())
96    }
Source

pub fn register_routes(&self, router: Router<S>) -> Router<S>

Registers the route for the [AdminBundle]

Source

pub fn add_auth_provider<P: AdminAuthProvider<S> + InnerAuthProvider<S> + 'static>( &mut self, provider: P, )

Adds a custom auth provider. Check the AdminAuthProvider for more details.

Examples found in repository?
examples/full-admin.rs (line 71)
67    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
68        let admin: &mut AdminState<_> = state.provide_mut();
69
70        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
71        admin.add_auth_provider(TestAuthProvider);
72        admin.add_login_provider(TestLoginProvider);
73
74        admin.add_navigation(
75            AdminNavigationGroup::new("Example").add(
76                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
77            ),
78        );
79
80        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
81        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible
82
83        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
84        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
85        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
86        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
87
88        admin.register_entity_handler(EntityHandler::<
89            S,
90            TestEntityCreateForm,
91            TestEntityUpdateForm,
92            TestEntityListing,
93        >::new("Example"));
94
95        Ok(())
96    }
Source

pub fn add_login_provider<P: AdminLoginProvider + InnerLoginProvider + Send + Sync + 'static>( &mut self, provider: P, )

Adds a custom login provider. Check the AdminLoginProvider for details.

Examples found in repository?
examples/full-admin.rs (line 72)
67    fn configure_state(&mut self, state: &mut S) -> quokka::Result<()> {
68        let admin: &mut AdminState<_> = state.provide_mut();
69
70        admin.super_admin_group = EXAMPLE_SUPER_USER_GROUP.to_string().into(); // This can be and usually should be set via the config
71        admin.add_auth_provider(TestAuthProvider);
72        admin.add_login_provider(TestLoginProvider);
73
74        admin.add_navigation(
75            AdminNavigationGroup::new("Example").add(
76                NavigationItem::new("example_page", "Example Page").link("/admin/example/page"),
77            ),
78        );
79
80        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/test_widget"));
81        admin.add_sidebar_widget(AdminSidebarWidget::htmx("/example/admin/time_widget")); // .hx_trigger("load, every 1s") // This widget should be refreshed, but as it spams the console I leave this comment here so you know that it is possible
82
83        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
84        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
85        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
86        admin.add_dashboard_widget(AdminDashboardWidget::htmx("/example/admin/test_widget"));
87
88        admin.register_entity_handler(EntityHandler::<
89            S,
90            TestEntityCreateForm,
91            TestEntityUpdateForm,
92            TestEntityListing,
93        >::new("Example"));
94
95        Ok(())
96    }

Trait Implementations§

Source§

impl<S: Clone> Clone for AdminState<S>

Source§

fn clone(&self) -> AdminState<S>

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<S> TryFromModule for AdminState<S>

Source§

async fn try_from_module(module: &Module) -> Result<Option<Self>>
where Self: Sized,

Builds the state from a module Read more
Source§

fn try_from_config(config: &Config) -> impl Future<Output = Result<Self, Error>>
where Self: Sized,

Simplifies building from the root config struct Read more
Source§

fn try_from_modules( modules: &Vec<Module>, ) -> impl Future<Output = Result<Self, Error>>
where Self: Sized,

Simplifies building from multiple modules Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for AdminState<S>

§

impl<S> !UnwindSafe for AdminState<S>

§

impl<S> Freeze for AdminState<S>

§

impl<S> Send for AdminState<S>

§

impl<S> Sync for AdminState<S>

§

impl<S> Unpin for AdminState<S>

§

impl<S> UnsafeUnpin for AdminState<S>

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSendSync for T

Source§

impl<S, T> ProvideState<T> for S
where T: FromState<S>,

Source§

fn provide(&self) -> T

Source§

impl<S, T> ProvideStateRef<T> for S
where T: FromStateRef<S>,

Source§

fn provide_ref(&self) -> &T

Source§

fn provide_mut(&mut self) -> &mut T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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