mirror of
https://git.proxmox.com/git/proxmox
synced 2025-06-02 20:51:10 +00:00
29 lines
849 B
Rust
29 lines
849 B
Rust
//! Proxmox API module. This provides utilities for HTTP and command line APIs.
|
|
//!
|
|
//! The main component here is the [`Router`] which is filled with entries pointing to
|
|
//! [`ApiMethodInfos`](crate::ApiMethodInfo).
|
|
//!
|
|
//! Note that you'll rarely need the [`Router`] type itself, as you'll most likely be creating them
|
|
//! with the `router` macro provided by the `proxmox-api-macro` crate.
|
|
|
|
use std::future::Future;
|
|
use std::pin::Pin;
|
|
|
|
use failure::Error;
|
|
use http::Response;
|
|
|
|
mod api_output;
|
|
pub use api_output::*;
|
|
|
|
mod api_type;
|
|
pub use api_type::*;
|
|
|
|
mod router;
|
|
pub use router::*;
|
|
|
|
/// Return type of an API method.
|
|
pub type ApiOutput<Body> = Result<Response<Body>, Error>;
|
|
|
|
/// Future type of an API method. In order to support `async fn` this is a pinned box.
|
|
pub type ApiFuture<Body> = Pin<Box<dyn Future<Output = ApiOutput<Body>> + Send>>;
|