llsd 0.1.0

LLSD serializer and deserializer
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

// LLSD for Rust - Parser and Writer for the LLSD format.
// Copyright (C) 2017-2018  Leonardo Schwarz <mail@leoschwarz.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

//! Handles auto detecting the representation of the format.

use data::Value;

lazy_static! {
    pub static ref PREFIX_BINARY: Vec<u8> = "<? LLSD/BINARY ?>\n".bytes().collect();
    pub static ref PREFIX_XML: Vec<u8> = "<?xml ".bytes().collect();
    pub static ref PREFIX_NOTATION: Vec<u8> = "<?llsd/notation?>\n".bytes().collect();
}

#[derive(Debug)]
pub enum Representation {
    Binary,
    Xml,
    Notation,
    Unknown,
}

fn determine_representation(buf: &[u8]) -> Representation {
    if buf.starts_with(&PREFIX_BINARY[..]) {
        Representation::Binary
    } else if buf.starts_with(&PREFIX_XML[..]) {
        Representation::Xml
    } else if buf.starts_with(&PREFIX_NOTATION[..]) {
        Representation::Notation
    } else {
        Representation::Unknown
    }
}

#[derive(Debug, Fail)]
pub enum ReadError {
    #[fail(display = "Reading binary LLSD failed: {}", _0)]
    ReadBinary(#[cause] ::binary::ReadError),

    #[fail(display = "Reading xml LLSD failed: {}", _0)]
    ReadXml(#[cause] ::xml::ReadError),

    #[fail(display = "Invalid LLSD representation: {:?}", _0)]
    InvalidRepresentation(Representation),
}

/// Read a value from either Binary or XML LLSD representation.
///
/// The format will be detected automatically by checking the document header.
pub fn read_value(buf: &[u8]) -> Result<Value, ReadError> {
    let repr = determine_representation(buf);
    match repr {
        Representation::Binary => {
            use std::io::BufReader;

            let mut reader = BufReader::new(&buf[PREFIX_BINARY.len()..]);
            ::binary::read_value(&mut reader).map_err(|e| ReadError::ReadBinary(e))
        }
        Representation::Xml => ::xml::read_value(buf).map_err(|e| ReadError::ReadXml(e)),
        Representation::Notation | Representation::Unknown => {
            Err(ReadError::InvalidRepresentation(repr))
        }
    }
}