igwn-ligolw 0.1.0

Rust-native reader and writer for the LIGO_LW XML format used by the International Gravitational-Wave Observatory Network.
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

use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("XML parse error: {0}")]
    Xml(#[from] quick_xml::Error),

    #[error("XML attribute error: {0}")]
    Attr(#[from] quick_xml::events::attributes::AttrError),

    #[error("UTF-8 error in element text: {0}")]
    Utf8(#[from] std::str::Utf8Error),

    #[error("invalid integer literal {literal:?} for column {column}: {source}")]
    BadInt {
        column: String,
        literal: String,
        #[source]
        source: std::num::ParseIntError,
    },

    #[error("invalid float literal {literal:?} for column {column}: {source}")]
    BadFloat {
        column: String,
        literal: String,
        #[source]
        source: std::num::ParseFloatError,
    },

    #[error("stream row in table {table:?} has {got} fields but {expected} columns are declared")]
    RowWidthMismatch {
        table: String,
        got: usize,
        expected: usize,
    },

    #[error("unterminated quoted string in stream for table {0:?}")]
    UnterminatedString(String),

    #[error("unknown LIGO_LW type {0:?}")]
    UnknownType(String),

    #[error("missing required attribute {attr:?} on element {element:?}")]
    MissingAttr { element: String, attr: String },

    #[error("LIGO_LW document does not contain table {0:?}")]
    MissingTable(String),

    #[error("LIGO_LW table {table:?} does not contain column {column:?}")]
    MissingColumn { table: String, column: String },

    #[error("value in {table:?}.{column:?} has type {actual} but {expected} was expected")]
    TypeMismatch {
        table: String,
        column: String,
        expected: &'static str,
        actual: &'static str,
    },

    #[error("invalid <Dim> size literal {literal:?}: {source}")]
    BadDim {
        literal: String,
        #[source]
        source: std::num::ParseIntError,
    },

    #[error("invalid base64 in <Array> stream: {0}")]
    ArrayBase64(#[from] base64::DecodeError),

    #[error("LIGO_LW document had no root <LIGO_LW> element")]
    NoRoot,

    #[error("I/O error: {0}")]
    Io(String),

    #[error("write error: {0}")]
    Write(String),
}

pub type Result<T> = std::result::Result<T, Error>;