wtx 0.45.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

use crate::{
  codec::{
    Id,
    protocol::{JsonRpcEncoder, VerbatimEncoder},
  },
  collection::Vector,
};

/// # Packages Auxiliary
///
/// Responsible for assisting the creation and management of packages and their requests.
///
/// # Types
///
/// * `API`: Application Programming Interface
/// * `DRSR`: DeserializeR/SerializeR
/// * `TP`: Transport Parameters
#[derive(Debug)]
pub struct PkgsAux<A, DRSR, TP> {
  /// API instance.
  pub api: A,
  /// The number of build requests
  pub built_requests: Id,
  /// Used by practically all transports to serialize or receive data in any desired operation.
  ///
  /// Some transports require a pre-filled buffer so it is important to not modify indiscriminately.
  pub bytes_buffer: Vector<u8>,
  /// Deserializer/Serializer instance
  pub drsr: DRSR,
  /// Useful in cases where the data is already encoded in the buffers.
  pub encode_data: bool,
  /// /// If the current request/response should be logged.
  pub log_data: bool,
  /// External request and response parameters.
  pub tp: TP,
}

impl<A, DRSR, TP> PkgsAux<A, DRSR, TP> {
  /// Creates an instance with the minimum amount of relevant parameters.
  #[inline]
  pub const fn from_minimum(api: A, drsr: DRSR, tp: TP) -> Self {
    Self {
      api,
      bytes_buffer: Vector::new(),
      drsr,
      encode_data: true,
      log_data: false,
      tp,
      built_requests: 0,
    }
  }

  /// New instance
  #[inline]
  pub const fn new(
    api: A,
    built_requests: u64,
    bytes_buffer: Vector<u8>,
    drsr: DRSR,
    encode_data: bool,
    log_data: bool,
    tp: TP,
  ) -> Self {
    Self { api, built_requests, bytes_buffer, drsr, encode_data, log_data, tp }
  }

  /// Should be used after a new request construction
  pub const fn increase_requests_num(&mut self) {
    self.built_requests = self.built_requests.wrapping_add(1);
  }

  /// Constructs [JsonRpcEncoder] and also increases the number of requests.
  #[inline]
  pub const fn json_rpc_request<P>(
    &mut self,
    method: &'static str,
    params: P,
  ) -> JsonRpcEncoder<P> {
    self.increase_requests_num();
    JsonRpcEncoder { id: self.built_requests, method, params }
  }

  /// Constructs [VerbatimEncoder] and also increases the number of requests.
  #[inline]
  pub const fn verbatim_request<D>(&mut self, data: D) -> VerbatimEncoder<D> {
    self.increase_requests_num();
    VerbatimEncoder { data }
  }
}