sark-http 0.27.0

HTTP wire types, semantics, codecs, and ownership invariants for Sark
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

use crate::field::metadata::map::record::Span;

pub mod buffer;
mod framing;
mod gate;
mod name;
mod outcome;
mod plan;
mod scan;
pub mod table;
mod value;

pub use framing::{Content, ContentError, Framing};
pub use gate::Gate;
pub use name::Name;
pub use outcome::Outcome;
pub use plan::Plan;
pub use scan::Scan;
pub use value::Value;

/// A classification bound to the immutable bytes that established it.
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Named<'a> {
    span: Span<'a>,
    proof: Name,
}

impl<'a> Named<'a> {
    pub fn from_span(span: Span<'a>) -> Self {
        Self::from_scanned(span, Name::from_span(span))
    }

    pub const fn from_slice(bytes: &'a [u8]) -> Self {
        Self::from_scanned(Span::from_slice(bytes), Name::classify(bytes))
    }

    pub(crate) const fn from_scanned(span: Span<'a>, proof: Name) -> Self {
        Self { span, proof }
    }

    pub const fn span(self) -> Span<'a> {
        self.span
    }

    pub const fn proof(self) -> Name {
        self.proof
    }
}

/// Value bytes with their retained admission verdict.
/// A rejected source field remains rejected when its value is reused.
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Valued<'a> {
    span: Span<'a>,
    validation: Validation,
}

impl<'a> Valued<'a> {
    pub fn from_span(span: Span<'a>) -> Self {
        Self::from_scanned(span, Value::from_span(span).finish())
    }

    pub(crate) const fn from_scanned(span: Span<'a>, check: Validation) -> Self {
        Self {
            span,
            validation: check,
        }
    }

    pub const fn span(self) -> Span<'a> {
        self.span
    }

    pub const fn validation(self) -> Validation {
        self.validation
    }
}

#[derive(Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum Kind {
    Request,
    Response,
    Trailers,
    PushPromise,
}

/// Extended CONNECT capability advertised by the peer.
#[derive(Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum Connect {
    Disabled,
    Enabled,
}

/// Header validation rules selected by the wire protocol.
#[derive(Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum Version {
    Two,
    Three,
}

#[derive(Clone, Copy, PartialEq, Eq, Debug)]
#[repr(u8)]
pub enum Validation {
    Valid,
    Malformed,
    RejectPush,
}

/// The message phase established by a valid compressed response status.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Response {
    Informational,
    Final,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum Form {
    Path,
    Asterisk,
    Connect,
    ExtendedConnect,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum Authority {
    None,
    Pseudo,
    Host,
    Target,
}

const _: () = {
    assert!(core::mem::size_of::<Connect>() == core::mem::size_of::<bool>());
    assert!(core::mem::align_of::<Connect>() == core::mem::align_of::<bool>());
    assert!(core::mem::size_of::<Version>() == core::mem::size_of::<bool>());
    assert!(core::mem::align_of::<Version>() == core::mem::align_of::<bool>());
};