summaryrefslogtreecommitdiffstats
path: root/ipfs-api/src/header.rs
blob: aec3c0a8c3ebd3448c4fa6e23cced423e8ff46de (plain)
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
// Copyright 2017 rust-ipfs-api Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//

use hyper;
use hyper::header::{self, Header, Raw};
use std::fmt;

/// Header that is returned for streaming calls.
///
/// A `Trailer` header indicates that after a streaming call, there will
/// be some additional information in the response.
///
#[derive(Debug, Clone, Copy)]
pub enum Trailer {
    /// This trailer indicates that an error header will be returned in
    /// the stream if there is an error while streaming.
    ///
    StreamError,
}

impl Header for Trailer {
    fn header_name() -> &'static str {
        "Trailer"
    }

    fn parse_header(raw: &Raw) -> hyper::Result<Trailer> {
        if let Some(bytes) = raw.one() {
            let value = String::from_utf8_lossy(bytes);

            match value.as_ref() {
                "X-Stream-Error" => Ok(Trailer::StreamError),
                _ => Err(hyper::Error::Header),
            }
        } else {
            Err(hyper::Error::Header)
        }
    }

    fn fmt_header(&self, f: &mut header::Formatter) -> fmt::Result {
        let value = match *self {
            Trailer::StreamError => "X-Stream-Error",
        };

        f.fmt_line(&value)
    }
}

/// This header is included while streaming if an error occured
/// while streaming the data.
///
#[derive(Debug, Clone)]
pub struct XStreamError {
    pub error: String,
}

impl Header for XStreamError {
    fn header_name() -> &'static str {
        "X-Stream-Error"
    }

    fn parse_header(raw: &Raw) -> hyper::Result<XStreamError> {
        if let Some(bytes) = raw.one() {
            let value = String::from_utf8_lossy(bytes);

            Ok(XStreamError {
                error: value.into_owned(),
            })
        } else {
            Err(hyper::Error::Header)
        }
    }

    fn fmt_header(&self, f: &mut header::Formatter) -> fmt::Result {
        f.fmt_line(&self.error)
    }
}