sark-http 0.22.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

use core::{mem, ops, ptr};

use crate::field::text::percent::{octet, scan, utf8};

#[derive(Debug)]
pub enum Error {
    Bounds {
        capacity: usize,
        source: ops::Range<usize>,
        destination: usize,
    },
}

pub struct Decoder<'a> {
    bytes: &'a mut [u8],
    read: usize,
    start: usize,
    written: usize,
}

impl<'a> Decoder<'a> {
    pub fn new(bytes: &'a mut [u8], src: ops::Range<usize>, dst: usize) -> Result<Self, Error> {
        let capacity = bytes.len();
        let Some(read) = src.start.checked_sub(dst).filter(|_| src.start <= src.end) else {
            return Err(Error::Bounds {
                capacity,
                source: src,
                destination: dst,
            });
        };
        let Some(bytes) = bytes.get_mut(dst..src.end) else {
            return Err(Error::Bounds {
                capacity,
                source: src,
                destination: dst,
            });
        };
        Ok(Self {
            bytes,
            read,
            start: dst,
            written: 0,
        })
    }

    /// Decodes within the admitted window without expanding the input.
    /// Each token consumes at least as many bytes as UTF-8 repair emits.
    pub fn decode(mut self) -> Written {
        let mut utf8 = utf8::Utf8::new();
        while self.read < self.bytes.len() {
            let byte = self.bytes[self.read];
            let rest = &self.bytes[self.read + 1..];
            let literal = if byte == b'%' || !byte.is_ascii() {
                0
            } else {
                1 + scan::Scan::new(rest).literal()
            };
            if literal != 0 && utf8.is_ready() {
                self.copy(literal);
                continue;
            }
            let (byte, consumed) = if literal != 0 || byte != b'%' {
                (byte, 1)
            } else {
                rest.first()
                    .copied()
                    .zip(rest.get(1).copied())
                    .and_then(|(high, low)| octet::decode(high, low))
                    .map_or((byte, 1), |byte| (byte, 3))
            };
            utf8.push(self.bytes, &mut self.written, byte);
            self.read += consumed;
        }
        utf8.finish(self.bytes, &mut self.written);
        Written::new(self.start..self.start + self.written)
    }

    fn copy(&mut self, len: usize) {
        // SAFETY: the literal scan bounds len by this owner's unread suffix.
        // Emission never overtakes read, and this run starts with no pending
        // UTF-8 bytes. Both ranges stay in the admitted window; copy permits overlap.
        unsafe {
            let bytes = self.bytes.as_mut_ptr();
            ptr::copy(bytes.add(self.read), bytes.add(self.written), len);
        }
        self.read += len;
        self.written += len;
    }
}

const _: () = assert!(
    mem::size_of::<Decoder<'_>>() == mem::size_of::<&mut [u8]>() + 3 * mem::size_of::<usize>()
);

/// An exact range of UTF-8 emitted by the repairing decoder.
/// Only admitted decoding constructs this proof; the owner must preserve its bytes.
pub struct Written {
    range: ops::Range<usize>,
}

impl Written {
    const fn new(range: ops::Range<usize>) -> Self {
        Self { range }
    }

    pub fn range(self) -> ops::Range<usize> {
        self.range
    }
}

const _: () = assert!(size_of::<Written>() == 2 * size_of::<usize>());