rede_schema 0.2.0

Exposes the request schema used by rede
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

//! Library containing the structs used in the `rede` crate.
//!
//! # Features
//!
//! - `input_params`

#![warn(clippy::pedantic)]

/// Contains all the specific types used in the body
pub mod body;

#[cfg(feature = "input_params")]
mod input_param;

#[doc(inline)]
pub use body::Body;

#[cfg(feature = "input_params")]
#[doc(inline)]
pub use input_param::InputParam;

use std::collections::BTreeMap;

use http::{HeaderMap, Method, Version};

/// Representation of a rede HTTP request. Contains all the supported content by the current schema
/// to allow the creation and dispatching of the HTTP request with the command-line interface.
#[derive(Debug)]
pub struct Request {
    /// HTTP method of the request
    pub method: Method,
    /// URL of the request
    pub url: String,
    /// HTTP version of the request
    pub http_version: Version,
    /// Metadata of the request file
    pub metadata: BTreeMap<String, String>,
    /// Headers of the request
    pub headers: HeaderMap,
    /// Query parameters of the request
    pub query_params: Vec<(String, String)>,
    /// Body of the request
    pub body: Body,
    /// Variables to provide values for placeholders in the request
    pub variables: BTreeMap<String, String>,

    #[cfg(feature = "input_params")]
    /// Keys of placeholders to ask the user for input
    pub input_params: BTreeMap<String, InputParam>,
}