ohkami 0.24.9

A performant, declarative, and runtime-flexible web framework for Rust
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

#![cfg(feature = "rt_worker")]

pub use ::ohkami_macros::{DurableObject, bindings, worker};

pub trait FromEnv: Sized {
    fn from_env(env: &worker::Env) -> Result<Self, worker::Error>;

    #[doc(hidden)]
    /// list of bindings: `(BindingName, Option<BindingType>)`
    ///
    /// `Option<BindingType>` is `None` for KV binding and `Some` holding :
    ///
    /// - `"String"` for Variable and Secret binding (https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/env.rs#L201-L236)
    /// - `"Ai"` for AI binding (ref: https://github.com/cloudflare/workers-rs/blob/38af58acc4e54b29c73336c1720188f3c3e86cc4/worker/src/ai.rs#L63-L79)
    /// - `"R2Bucket"` for R2 binding (ref: https://github.com/cloudflare/workers-rs/blob/38af58acc4e54b29c73336c1720188f3c3e86cc4/worker/src/r2/mod.rs#L131-L133)
    /// - `"Fetcher"` for Service binding (ref: https://github.com/cloudflare/workers-rs/blob/38af58acc4e54b29c73336c1720188f3c3e86cc4/worker/src/fetcher.rs#L94-L96)
    /// - `"DurableObjectNamespace"` for DurableObject binding (ref: https://github.com/cloudflare/workers-rs/blob/38af58acc4e54b29c73336c1720188f3c3e86cc4/worker/src/durable.rs#L742-L744)
    /// - `"D1Database"` for D1 binding (ref: https://github.com/cloudflare/workers-rs/blob/38af58acc4e54b29c73336c1720188f3c3e86cc4/worker/src/d1/mod.rs#L83-L101)
    /// - `"Hyperdrive"` for Hyperdrive binding (ref: https://github.com/cloudflare/workers-rs/blob/3e4d7cd2b511b39994be0ad111554c773405d3e4/worker/src/hyperdrive.rs#L12-L14)
    /// - `"WorkerQueue"` for Queue binding (ref: https://github.com/cloudflare/workers-rs/blob/3e4d7cd2b511b39994be0ad111554c773405d3e4/worker/src/queue.rs#L318-L320)
    /// - `"AnalyticsEngineDataset"` for Analytics Engine (https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/analytics_engine.rs#L15)
    /// - `"DynamicDispatcher"` for Dynamic Dispatcher (https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/dynamic_dispatch.rs#L29)
    /// - `"Fetcher"` for Assets (https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/env.rs#L114)
    /// - `"Fetcher"` for Secret Store (https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/secret_store.rs#L17)
    /// - `"Ratelimit"` for Rate Limiter (https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/rate_limit.rs#L24)
    fn bindings_meta() -> &'static [(&'static str, Option<&'static str>)] {
        &[]
    }
    #[doc(hidden)]
    fn dummy_env() -> worker::Env {
        use worker::js_sys::{Function, Object, Reflect};
        use worker::wasm_bindgen::{JsCast, closure::Closure};

        let env = Object::new();
        for (binding_name, binding_type) in Self::bindings_meta() {
            let binding = Object::new();
            if let Some(binding_type) = binding_type {
                let constructor = Function::<fn() -> worker::js_sys::Undefined>::unchecked_from_js(
                    Closure::<dyn Fn()>::new(|| {}).into_js_value(),
                );
                {
                    let attributes = Object::new();
                    Reflect::set(&attributes, &"value".into(), &(*binding_type).into()).unwrap();
                    Reflect::define_property(&constructor, &"name".into(), &attributes).unwrap();
                }
                Reflect::set(&binding, &"constructor".into(), &constructor).unwrap();
            }
            Reflect::set(&env, &(*binding_name).into(), &binding).unwrap();
        }
        worker::Env::unchecked_from_js(env.unchecked_into())
    }
}

pub mod bindings {
    /// `Var` binding can also be accessed via associated const of the same name.
    pub type Var = &'static str;
    pub type Secret = String;
    pub type AI = ::worker::Ai;
    pub type KV = ::worker::kv::KvStore;
    pub type R2 = ::worker::Bucket;
    pub type Service = ::worker::Fetcher;
    pub type DurableObject = ::worker::ObjectNamespace;
    pub type D1 = ::worker::d1::D1Database;
    pub type Hyperdrive = ::worker::Hyperdrive;
    /// `Queue` may cause a lot of *WARNING*s on `npm run dev`, but
    /// it's not an actual problem and `Queue` binding does work.
    pub type Queue = ::worker::Queue;
    pub type AnalyticsEngine = ::worker::AnalyticsEngineDataset;
    pub type DynamicDispatcher = ::worker::DynamicDispatcher;
    // ref: https://github.com/cloudflare/workers-rs/blob/5f06bb0732b8593f234ff34c0e752bf3685189dd/worker/src/env.rs#L114
    pub type Assets = ::worker::Fetcher;
    pub type SecretStore = ::worker::SecretStore;
    pub type RateLimiter = ::worker::RateLimiter;
}

#[doc(hidden)]
#[allow(non_camel_case_types)]
pub trait has_DurableObject_attribute {}

/// **Note:** Implement this trait with a standard `impl DurableObject for YourType` block, but in order to
/// integrate them with the Workers Runtime, you must also add the **`#[DurableObject]`** attribute
/// to the struct.
///
/// ### Example
///
/// ```no_run
/// use ohkami::DurableObject;
///
/// # struct User;
/// # struct Message;
///
/// #[DurableObject]
/// pub struct Chatroom {
///     users: Vec<User>,
///     messages: Vec<Message>,
///     state: worker::State,
///     env: worker::Env, // access `Env` across requests, use inside `fetch`
/// }
///
/// impl DurableObject for Chatroom {
///     fn new(state: worker::State, env: worker::Env) -> Self {
///         Self {
///             users: vec![],
///             messages: vec![],
///             state,
///             env,
///         }
///     }
///
///     async fn fetch(&mut self, req: worker::Request) -> worker::Result<worker::Response> {
///         // do something when a worker makes a request to this DO
///         worker::Response::ok(&format!("{} active users.", self.users.len()))
///     }
/// }
/// ```
#[allow(async_fn_in_trait/* `Send` is not needed */)]
pub trait DurableObject: has_DurableObject_attribute {
    fn new(state: worker::State, env: worker::Env) -> Self;

    async fn fetch(&mut self, req: worker::Request) -> worker::Result<worker::Response>;

    async fn alarm(&mut self) -> worker::Result<worker::Response> {
        worker::console_error!("alarm() handler is not implemented");
        Err(worker::Error::RustError(
            "alarm() handler is not implemented".into(),
        ))
    }

    #[allow(unused_variables)]
    async fn websocket_message(
        &mut self,
        ws: worker::WebSocket,
        message: worker::WebSocketIncomingMessage,
    ) -> worker::Result<()> {
        Ok(())
    }

    #[allow(unused_variables)]
    async fn websocket_close(
        &mut self,
        ws: worker::WebSocket,
        code: usize,
        reason: String,
        was_clean: bool,
    ) -> worker::Result<()> {
        Ok(())
    }

    #[allow(unused_variables)]
    async fn websocket_error(
        &mut self,
        ws: worker::WebSocket,
        error: worker::Error,
    ) -> worker::Result<()> {
        Ok(())
    }
}