wtx 0.43.0

A collection of different transport implementations and related tools focused primarily on web technologies.
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Convenient subset of HTTP parameters. Intended to be only used by HTTP endpoints.

use crate::{
  client_api_framework::network::transport::TransportParams,
  collection::Vector,
  http::{Headers, Method, Mime, ReqResBuffer, StatusCode},
  misc::{Lease, LeaseMut, UriString},
};
use alloc::string::String;

#[derive(Debug)]
#[doc = generic_trans_params_doc!()]
pub struct HttpParams(HttpReqParams, HttpResParams);

impl HttpParams {
  /// For example, from `http://localhost`.
  #[inline]
  pub fn from_uri(uri: String) -> Self {
    Self(
      HttpReqParams {
        host: true,
        method: Method::Get,
        mime: None,
        rrb: ReqResBuffer {
          body: Vector::new(),
          headers: Headers::new(),
          uri: UriString::new(uri),
        },
        user_agent_custom: None,
        user_agent_default: true,
      },
      HttpResParams { status_code: StatusCode::Forbidden },
    )
  }
}

impl Lease<HttpParams> for HttpParams {
  #[inline]
  fn lease(&self) -> &HttpParams {
    self
  }
}

impl LeaseMut<HttpParams> for HttpParams {
  #[inline]
  fn lease_mut(&mut self) -> &mut HttpParams {
    self
  }
}

impl TransportParams for HttpParams {
  type ExternalRequestParams = HttpReqParams;
  type ExternalResponseParams = HttpResParams;

  #[inline]
  fn ext_params(&self) -> (&Self::ExternalRequestParams, &Self::ExternalResponseParams) {
    (&self.0, &self.1)
  }

  #[inline]
  fn ext_params_mut(
    &mut self,
  ) -> (&mut Self::ExternalRequestParams, &mut Self::ExternalResponseParams) {
    (&mut self.0, &mut self.1)
  }

  #[inline]
  fn reset(&mut self) {
    self.0.reset();
    self.1.reset();
  }
}

#[derive(Debug)]
#[doc = generic_trans_req_params_doc!("HTTP")]
pub struct HttpReqParams {
  /// If the host should be included in the headers.
  ///
  /// Defaults to `true`.
  pub host: bool,
  /// See [`Method`].
  pub method: Method,
  /// See [`Mime`].
  pub mime: Option<Mime>,
  /// See [`ReqResBuffer`].
  pub rrb: ReqResBuffer,
  /// Custom user agent that will be included in the headers
  ///
  /// If `user_agent_default` is `true`, then this field becomes a NO-OP.
  pub user_agent_custom: Option<&'static str>,
  /// System's user agent that will be included in the headers. For example, "wtx/0.0.1".
  ///
  /// Defaults to `true`.
  pub user_agent_default: bool,
}

impl HttpReqParams {
  /// Sets the inner parameters with their default values.
  #[inline]
  pub fn reset(&mut self) {
    let Self { host, method, mime, rrb, user_agent_custom, user_agent_default } = self;
    *host = true;
    *method = Method::Get;
    *mime = None;
    *user_agent_custom = None;
    *user_agent_default = true;
    let ReqResBuffer { body, headers, uri } = rrb;
    body.clear();
    headers.clear();
    uri.truncate_with_initial_len();
  }
}

#[doc = generic_trans_res_params_doc!("HTTP")]
#[derive(Debug)]
pub struct HttpResParams {
  /// Status code.
  pub status_code: StatusCode,
}

impl HttpResParams {
  /// Sets the inner parameters with their default values.
  #[inline]
  pub const fn reset(&mut self) {
    self.status_code = StatusCode::InternalServerError;
  }
}