adminx-core 0.3.0

Framework-neutral core for the adminx admin-panel framework: the Resource trait, storage abstraction, registry, and neutral request/response types shared by every web-framework and database adapter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

// adminx-core/src/actions.rs
//
// Framework-neutral custom actions: extra id-scoped operations a resource
// exposes beyond CRUD (e.g. "publish", "approve", "toggle-status"). The handler
// is a plain fn pointer returning a neutral `ApiResponse`, so it works under any
// web adapter. Wired by adapters at `POST /{base}/{id}/action/{name}`.

use crate::request::ReqCtx;
use crate::response::ApiResponse;
use serde_json::Value;
use std::future::Future;
use std::pin::Pin;

/// Boxed future returned by an action handler.
pub type ActionFuture = Pin<Box<dyn Future<Output = ApiResponse> + Send>>;

/// An action handler receives the (cloned) request context, the target record
/// id, and the JSON request body (`{}` when none was sent).
pub type ActionHandler = fn(ReqCtx, String, Value) -> ActionFuture;

/// Describes a custom action exposed by a resource.
pub struct CustomAction {
    /// URL/segment name, e.g. `"publish"`.
    pub name: &'static str,
    /// Human label for the UI button (defaults to `name`).
    pub label: Option<&'static str>,
    /// Server-side handler.
    pub handler: ActionHandler,
}

impl CustomAction {
    pub fn new(name: &'static str, handler: ActionHandler) -> Self {
        Self {
            name,
            label: None,
            handler,
        }
    }

    pub fn labeled(name: &'static str, label: &'static str, handler: ActionHandler) -> Self {
        Self {
            name,
            label: Some(label),
            handler,
        }
    }

    pub fn display_label(&self) -> &'static str {
        self.label.unwrap_or(self.name)
    }
}