warcat 0.3.0

Command-line tool and library for handling Web ARChive (WARC) files
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

use std::{collections::VecDeque, io::Read};

use crate::error::GeneralError;

use super::{
    codec::CodecPipeline,
    header::{MessageHeader, TrailerFields},
};

/// Encodes a HTTP request/response message.
///
/// Important: This struct makes no semantic validation! It simply outputs
/// what you call.
pub struct Sender {
    codec_pipeline: CodecPipeline,
    output_buf: VecDeque<u8>,
}

impl Sender {
    pub fn new() -> Self {
        Self {
            codec_pipeline: CodecPipeline::default(),
            output_buf: VecDeque::new(),
        }
    }

    /// Send the header.
    pub fn send_header(&mut self, header: &MessageHeader) -> Result<(), GeneralError> {
        let mut codecs = Vec::new();
        super::codec::build_encoders(header, &mut codecs)?;

        self.codec_pipeline = CodecPipeline::new(codecs);

        header.serialize(&mut self.output_buf).unwrap();

        Ok(())
    }

    /// Send body data.
    pub fn send_body(&mut self, data: &[u8]) -> Result<(), GeneralError> {
        self.codec_pipeline.transform(data, &mut self.output_buf)?;

        Ok(())
    }

    /// Ends the message with a chunked-transfer encoding.
    ///
    /// Flushes any buffered output and outputs the trailer.
    pub fn send_trailer(&mut self, fields: &TrailerFields) -> Result<(), GeneralError> {
        self.codec_pipeline.finish_input(&mut self.output_buf)?;

        fields.serialize(&mut self.output_buf).unwrap();

        Ok(())
    }

    /// Ends the message, flushing any buffered output.
    pub fn end_message(&mut self) -> Result<(), GeneralError> {
        self.codec_pipeline.finish_input(&mut self.output_buf)?;

        Ok(())
    }

    /// At the end of the message, reset the internal state for a new message.
    pub fn reset(&mut self) {
        self.codec_pipeline = CodecPipeline::default();
    }

    /// Writes the output data into the given buffer and returns the amount written.
    pub fn read_output(&mut self, buf: &mut [u8]) -> usize {
        self.output_buf.read(buf).unwrap()
    }
}

impl Default for Sender {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tracing_test::traced_test]
    #[test]
    fn test_send() {
        let mut output = Vec::new();
        let mut sender = Sender::new();

        let header = MessageHeader::new_request("GET", "/index.html");
        sender.send_header(&header).unwrap();
        sender.send_body(b"Hello world!").unwrap();
        sender.end_message().unwrap();

        loop {
            let mut buf = [0u8; 1024];
            let len = sender.read_output(&mut buf);

            if len == 0 {
                break;
            }

            output.extend_from_slice(&buf[0..len]);
        }

        assert_eq!(
            output,
            b"GET /index.html HTTP/1.1\r\n\
            \r\n\
            Hello world!"
        );
    }
}