wtx 0.50.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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! <https://datatracker.ietf.org/doc/html/rfc7692>

mod deflate_config;
mod web_socket_decompression;
mod window_bits;
#[cfg(feature = "zlib-rs")]
mod zlib_rs;

use crate::{codec::Compression, collections::ArrayVectorCopy, http::GenericHeader};
pub use deflate_config::DeflateConfig;
pub use web_socket_decompression::WebSocketDecompression;
pub use window_bits::WindowBits;
#[cfg(feature = "zlib-rs")]
pub use zlib_rs::{
  NegotiatedZlibRs, NegotiatedZlibRsCompression, NegotiatedZlibRsDecompression, ZlibRs,
};

/// Initial compression parameters defined before a handshake.
pub trait WsCompression<const IS_CLIENT: bool> {
  /// See [`NegotiatedWsCompression`].
  type NegotiatedCompression: NegotiatedWsCompression;

  /// Manages the defined parameters with the received parameters to decide which
  /// parameters will be settled.
  fn negotiate(
    self,
    headers: impl Iterator<Item = impl GenericHeader>,
  ) -> crate::Result<Self::NegotiatedCompression>;

  /// Requests headers bytes that will be sent to the server.
  fn req_headers(&self) -> ArrayVectorCopy<u8, 160>;
}

impl<const IS_CLIENT: bool> WsCompression<IS_CLIENT> for () {
  type NegotiatedCompression = ();

  #[inline]
  fn negotiate(
    self,
    _: impl Iterator<Item = impl GenericHeader>,
  ) -> crate::Result<Self::NegotiatedCompression> {
    Ok(())
  }

  #[inline]
  fn req_headers(&self) -> ArrayVectorCopy<u8, 160> {
    ArrayVectorCopy::new()
  }
}

/// Final compression parameters defined after a handshake.
pub trait NegotiatedWsCompression: WebSocketCompression + WebSocketDecompression {
  /// See [`WebSocketCompression`].
  type Compression: WebSocketCompression;
  /// See [`WebSocketDecompression`].
  type Decompression: WebSocketDecompression;

  /// Splits itself.
  fn into_split(self) -> (Self::Compression, Self::Decompression);

  /// Response headers
  fn res_headers(&self) -> ArrayVectorCopy<u8, 160>;

  /// Rsv1 bit
  fn rsv1(&self) -> u8;
}

impl NegotiatedWsCompression for () {
  type Compression = ();
  type Decompression = ();

  #[inline]
  fn into_split(self) -> (Self::Compression, Self::Decompression) {
    ((), ())
  }

  #[inline]
  fn res_headers(&self) -> ArrayVectorCopy<u8, 160> {
    ArrayVectorCopy::new()
  }

  #[inline]
  fn rsv1(&self) -> u8 {
    0
  }
}

impl<T> NegotiatedWsCompression for Option<T>
where
  T: NegotiatedWsCompression,
{
  type Compression = Option<T::Compression>;
  type Decompression = Option<T::Decompression>;

  #[inline]
  fn into_split(self) -> (Self::Compression, Self::Decompression) {
    match self {
      Some(el) => {
        let (compression, decompression) = el.into_split();
        (Some(compression), Some(decompression))
      }
      None => (None, None),
    }
  }

  #[inline]
  fn res_headers(&self) -> ArrayVectorCopy<u8, 160> {
    match self {
      Some(el) => el.res_headers(),
      None => ArrayVectorCopy::new(),
    }
  }

  #[inline]
  fn rsv1(&self) -> u8 {
    match self {
      Some(el) => el.rsv1(),
      None => ().rsv1(),
    }
  }
}

/// WebSocket Decompression
pub trait WebSocketCompression: Compression {
  /// No Content Takeover
  fn no_context_takeover(&self) -> bool;
}

impl WebSocketCompression for () {
  #[inline]
  fn no_context_takeover(&self) -> bool {
    false
  }
}

impl<T> WebSocketCompression for Option<T>
where
  T: WebSocketCompression,
{
  #[inline]
  fn no_context_takeover(&self) -> bool {
    if let Some(elem) = self { elem.no_context_takeover() } else { false }
  }
}