proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-08-05 13:19:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix typos in doc comments.

Browse Source 
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
This commit is contained in:
Christian Ebner 2020-01-30 12:08:02 +01:00 committed by Dietmar Maurer
parent db316a1fd8
commit 98708e346d
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
proxmox/src/api/router.rs
View File

@ -113,7 +113,7 @@ pub type ApiAsyncHttpHandlerFn = &'static (dyn Fn(
+ Sync + Sync
+ 'static); + 'static);
/// The output of an asynchronous API handler is a futrue yielding a `Response`. /// The output of an asynchronous API handler is a future yielding a `Response`.
pub type ApiResponseFuture = pub type ApiResponseFuture =
Pin<Box<dyn Future<Output = Result<Response<Body>, failure::Error>> + Send>>; Pin<Box<dyn Future<Output = Result<Response<Body>, failure::Error>> + Send>>;
@ -154,13 +154,13 @@ impl PartialEq for ApiHandler {
/// - `name`: The name of the subdir /// - `name`: The name of the subdir
/// - `router`: The router for this subdir /// - `router`: The router for this subdir
/// ///
/// **Note:** The list has to be storted by name, because we use a binary /// **Note:** The list has to be sorted by name, because we use a binary
/// search to find items. /// search to find items.
/// ///
/// This is a workaround unless RUST can const_fn `Hash::new()` /// This is a workaround unless RUST can const_fn `Hash::new()`
pub type SubdirMap = &'static [(&'static str, &'static Router)]; pub type SubdirMap = &'static [(&'static str, &'static Router)];
/// Clasify different types of routers /// Classify different types of routers
pub enum SubRoute { pub enum SubRoute {
//Hash(HashMap<String, Router>), //Hash(HashMap<String, Router>),
/// Router with static lookup map. /// Router with static lookup map.
@ -306,10 +306,10 @@ impl Router {
self self
} }
/// Find the router for a specic path. /// Find the router for a specific path.
/// ///
/// - `components`: Path, split into individual components. /// - `components`: Path, split into individual components.
/// - `uri_param`: Mutable hash map to store paramater from `MatchAll` router. /// - `uri_param`: Mutable hash map to store parameter from `MatchAll` router.
pub fn find_route( pub fn find_route(
&self, &self,
components: &[&str], components: &[&str],
@ -343,7 +343,7 @@ impl Router {
/// Lookup the API method for a specific path. /// Lookup the API method for a specific path.
/// - `components`: Path, split into individual components. /// - `components`: Path, split into individual components.
/// - `method`: The HTTP method. /// - `method`: The HTTP method.
/// - `uri_param`: Mutable hash map to store paramater from `MatchAll` router. /// - `uri_param`: Mutable hash map to store parameter from `MatchAll` router.
pub fn find_method( pub fn find_method(
&self, &self,
components: &[&str], components: &[&str],
@ -383,11 +383,11 @@ fn dummy_handler_fn(
const DUMMY_HANDLER: ApiHandler = ApiHandler::Sync(&dummy_handler_fn); const DUMMY_HANDLER: ApiHandler = ApiHandler::Sync(&dummy_handler_fn);
/// This struct defines synchronous API call which returns the restulkt as json `Value` /// This struct defines a synchronous API call which returns the result as json `Value`
#[cfg_attr(feature = "test-harness", derive(Eq, PartialEq))] #[cfg_attr(feature = "test-harness", derive(Eq, PartialEq))]
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 daemon running in privileged mode.
pub protected: bool, pub protected: bool,
/// 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