wtx 0.28.0

A collection of different transport implementations and related tools focused primarily on web technologies.
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

/// Useful to automatically create a local `PkgsAux` wrapper that implements
/// `core::ops::DerefMut` in case you want to use a fluent-like interface for your APIs.
#[macro_export]
macro_rules! create_packages_aux_wrapper {
  () => {
    $crate::create_packages_aux_wrapper!(@PkgsAux<A with A>);
  };
  ($name:ident) => {
    $crate::create_packages_aux_wrapper!(@$name<A with A>);
  };
  ($name:ident, $api_ty:ty) => {
    $crate::create_packages_aux_wrapper!(@$name<with $api_ty>);
  };
  (
    @$name:ident<
      $($api_param:ident)? with $api_ty:ty
    >
  ) => {
    /// Just a wrapper that implements [core::ops::Deref] and [`core::ops::DerefMut`] to easily call
    /// methods from `PkgsAux`.
    #[derive(Debug)]
    pub struct $name<$($api_param,)? DRSR, TP>($crate::client_api_framework::pkg::PkgsAux<$api_ty, DRSR, TP>)
    where
      TP: $crate::client_api_framework::network::transport::TransportParams;

    impl<$($api_param,)? DRSR, TP> $name<$api_ty, DRSR, TP>
    where
      TP: $crate::client_api_framework::network::transport::TransportParams
    {
      /// Proxy of [`$crate::client_api_framework::pkg::PkgsAux::from_minimum`].
      #[inline]
      pub fn from_minimum(api: $api_ty, drsr: DRSR, tp: TP) -> Self {
        Self($crate::client_api_framework::pkg::PkgsAux::from_minimum(api, drsr, tp))
      }

      /// Proxy of [`$crate::client_api_framework::pkg::PkgsAux::new`].
      #[inline]
      pub fn new(api: $api_ty, byte_buffer: $crate::misc::Vector<u8>, drsr: DRSR, tp: TP) -> Self {
        Self($crate::client_api_framework::pkg::PkgsAux::new(api, byte_buffer, drsr, tp))
      }
    }

    impl<$($api_param,)? DRSR, TP> core::ops::Deref for $name<$api_ty, DRSR, TP>
    where
      TP: $crate::client_api_framework::network::transport::TransportParams
    {
      type Target = $crate::client_api_framework::pkg::PkgsAux<$api_ty, DRSR, TP>;

      #[inline]
      fn deref(&self) -> &Self::Target {
        &self.0
      }
    }

    impl<$($api_param,)? DRSR, TP> core::ops::DerefMut for $name<$api_ty, DRSR, TP>
    where
      TP: $crate::client_api_framework::network::transport::TransportParams
    {
      #[inline]
      fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
      }
    }

    impl<$($api_param,)? DRSR, TP> From<$crate::client_api_framework::pkg::PkgsAux<$api_ty, DRSR, TP>> for $name<$api_ty, DRSR, TP>
    where
      TP: $crate::client_api_framework::network::transport::TransportParams
    {
      #[inline]
      fn from(from: $crate::client_api_framework::pkg::PkgsAux<$api_ty, DRSR, TP>) -> Self {
        Self(from)
      }
    }
  };
}

macro_rules! _create_set_of_request_throttling {
  (
    $name:ident {
      $( $method:ident ),+ $(,)?
    }
  ) => {
    /// A set of [`$crate::utils::RequestThrottling`] for specified API usage
    #[derive(Debug)]
    pub struct $name {
      $(
        pub(crate) $method: $crate::utils::RequestThrottling,
      )+
    }

    impl $name {
            pub fn new(
        $( $method: $crate::utils::RequestLimit, )+
      ) -> Self {
        Self {
          $(
            $method: $crate::utils::RequestThrottling::from_rl($method),
          )+
        }
      }
    }
  };
}

macro_rules! generic_trans_params_doc {
  () => {
    "Grouping of request and response parameters"
  };
}

macro_rules! generic_trans_req_params_doc {
  ($ty:literal) => {
    concat!("All possible ", $ty, " parameters that a request can manipulate for sending.")
  };
}

macro_rules! generic_trans_res_params_doc {
  ($ty:literal) => {
    concat!("All possible response parameters returned by a ", $ty, " request.")
  };
}