tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

improve ApiMethod docu

Browse Source
This commit is contained in:
Dietmar Maurer 2019-02-01 10:38:07 +01:00
parent 4b2cdeb9a6
commit 6278365fd9
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/api/router.rs
View File

@ -63,6 +63,7 @@ type ApiHandlerFn = fn(Value, &ApiMethod, &mut dyn RpcEnvironment) -> Result<Val
type ApiAsyncHandlerFn = fn(Parts, Body, Value, &ApiAsyncMethod, &mut dyn RpcEnvironment) -> Result<BoxFut, Error>; type ApiAsyncHandlerFn = fn(Parts, Body, Value, &ApiAsyncMethod, &mut dyn RpcEnvironment) -> Result<BoxFut, Error>;
/// This struct defines synchronous API call which returns the restulkt as json `Value`
pub struct ApiMethod { pub struct ApiMethod {
/// The protected flag indicates that the provides function should be forwarded /// The protected flag indicates that the provides function should be forwarded
/// to the deaemon running in priviledged mode. /// to the deaemon running in priviledged mode.
@ -70,8 +71,11 @@ pub struct ApiMethod {
/// This flag indicates that the provided method may change the local timezone, so the server /// This flag indicates that the provided method may change the local timezone, so the server
/// should do a tzset afterwards /// should do a tzset afterwards
pub reload_timezone: bool, pub reload_timezone: bool,
/// Parameter type Schema
pub parameters: ObjectSchema, pub parameters: ObjectSchema,
/// Return type Schema
pub returns: Arc<Schema>, pub returns: Arc<Schema>,
/// Handler function
pub handler: ApiHandlerFn, pub handler: ApiHandlerFn,
} }