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

proxmox-rest-server: start module docs

Browse Source
This commit is contained in:
Dietmar Maurer 2021-09-30 13:49:29 +02:00
parent 49e25688f1
commit a98a288e2d
2 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
proxmox-rest-server/src/lib.rs
View File

@ -1,3 +1,21 @@
//! # Proxmox REST server
//!
//! This module provides convenient building blocks to implement a
//! REST server.
//!
//! ## Features
//!
//! * HTTP and HTTP2
//! * highly threaded code, uses Rust async
//! * static API definitions using schemas
//! * restartable systemd daemons using `systemd_notify`
//! * support for long running worker tasks (threads or async tokio tasks)
//! * supports separate access and authentification log files
//! * separate control socket to trigger management operations
//! - logfile rotation
//! - worker task management
//! * generic interface to authenticate user
use std::sync::atomic::{Ordering, AtomicBool}; use std::sync::atomic::{Ordering, AtomicBool};
use anyhow::{bail, format_err, Error}; use anyhow::{bail, format_err, Error};

13
proxmox-rest-server/src/rest.rs
View File

@ -19,6 +19,7 @@ use serde_json::Value;
use tokio::fs::File; use tokio::fs::File;
use tokio::time::Instant; use tokio::time::Instant;
use url::form_urlencoded; use url::form_urlencoded;
use tower_service::Service;
use proxmox::api::schema::{ use proxmox::api::schema::{
parse_parameter_strings, parse_simple_value, verify_json_object, ObjectSchemaType, parse_parameter_strings, parse_simple_value, verify_json_object, ObjectSchemaType,
@ -53,6 +54,9 @@ impl UserInformation for EmptyUserInformation {
} }
/// REST server implementation (configured with [ApiConfig]) /// REST server implementation (configured with [ApiConfig])
///
/// This struct implements the [Service] trait in order to use it with
/// [hyper::server::Builder::serve].
pub struct RestServer { pub struct RestServer {
api_config: Arc<ApiConfig>, api_config: Arc<ApiConfig>,
} }
@ -61,6 +65,7 @@ const MAX_URI_QUERY_LENGTH: usize = 3072;
const CHUNK_SIZE_LIMIT: u64 = 32 * 1024; const CHUNK_SIZE_LIMIT: u64 = 32 * 1024;
impl RestServer { impl RestServer {
/// Creates a new instance.
pub fn new(api_config: ApiConfig) -> Self { pub fn new(api_config: ApiConfig) -> Self {
Self { Self {
api_config: Arc::new(api_config), api_config: Arc::new(api_config),
@ -68,7 +73,7 @@ impl RestServer {
} }
} }
impl tower_service::Service<&Pin<Box<tokio_openssl::SslStream<tokio::net::TcpStream>>>> impl Service<&Pin<Box<tokio_openssl::SslStream<tokio::net::TcpStream>>>>
for RestServer for RestServer
{ {
type Response = ApiService; type Response = ApiService;
@ -94,7 +99,7 @@ impl tower_service::Service<&Pin<Box<tokio_openssl::SslStream<tokio::net::TcpStr
} }
} }
impl tower_service::Service<&hyper::server::conn::AddrStream> for RestServer { impl Service<&hyper::server::conn::AddrStream> for RestServer {
type Response = ApiService; type Response = ApiService;
type Error = Error; type Error = Error;
type Future = Pin<Box<dyn Future<Output = Result<ApiService, Error>> + Send>>; type Future = Pin<Box<dyn Future<Output = Result<ApiService, Error>> + Send>>;
@ -113,7 +118,7 @@ impl tower_service::Service<&hyper::server::conn::AddrStream> for RestServer {
} }
} }
impl tower_service::Service<&tokio::net::UnixStream> for RestServer { impl Service<&tokio::net::UnixStream> for RestServer {
type Response = ApiService; type Response = ApiService;
type Error = Error; type Error = Error;
type Future = Pin<Box<dyn Future<Output = Result<ApiService, Error>> + Send>>; type Future = Pin<Box<dyn Future<Output = Result<ApiService, Error>> + Send>>;
@ -220,7 +225,7 @@ fn get_user_agent(headers: &HeaderMap) -> Option<String> {
.ok() .ok()
} }
impl tower_service::Service<Request<Body>> for ApiService { impl Service<Request<Body>> for ApiService {
type Response = Response<Body>; type Response = Response<Body>;
type Error = Error; type Error = Error;
#[allow(clippy::type_complexity)] #[allow(clippy::type_complexity)]