mseed 0.7.1

Bindings to libmseed for interoperating with miniSEED records.
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
115
116
117
118
119
120
121
122

use std::error;
use std::ffi::{c_int, c_long, CStr};
use std::fmt;

use num_traits::cast::AsPrimitive;

use crate::{raw, MSErrorCode, MSResult};

const MS_NOERROR: c_long = raw::MS_NOERROR as c_long;
const MS_ENDOFFILE: c_long = raw::MS_ENDOFFILE as c_long;
const MS_NSTERROR: i64 = raw::NSTERROR as i64;

/// Utility function which turns a libmseed error into a result.
pub(crate) fn check<T: PartialOrd + AsPrimitive<c_long>>(code: T) -> MSResult<T> {
    let c = code.as_();
    if c >= MS_NOERROR {
        return Ok(code);
    }

    Err(MSError::from_raw(c as c_int))
}

/// Checks if the function's return code is `MS_ENDOFFILE`.
pub(crate) fn check_eof<T: PartialEq + AsPrimitive<c_long>>(code: T) -> bool {
    code.as_() == MS_ENDOFFILE
}

/// Turns the return code of libmseed functions which normally return a high precision time
/// into a result.
///
/// On error a ``MSError` with code `MSErrorCode::GenericError` is returned.
pub(crate) fn check_nst(code: i64) -> MSResult<i64> {
    if code > MS_NSTERROR {
        return Ok(code);
    }

    Err(MSError::from_str("time processing error"))
}

/// A structure representing libmseed errors.
#[derive(Debug, PartialEq)]
pub struct MSError {
    code: c_int,
    message: String,
}

pub(crate) const MS_GENERROR: c_int = raw::MS_GENERROR as c_int;
pub(crate) const MS_NOTSEED: c_int = raw::MS_NOTSEED as c_int;
pub(crate) const MS_WRONGLENGTH: c_int = raw::MS_WRONGLENGTH as c_int;
pub(crate) const MS_OUTOFRANGE: c_int = raw::MS_OUTOFRANGE as c_int;
pub(crate) const MS_UNKNOWNFORMAT: c_int = raw::MS_UNKNOWNFORMAT as c_int;
pub(crate) const MS_STBADCOMPFLAG: c_int = raw::MS_STBADCOMPFLAG as c_int;
pub(crate) const MS_INVALIDCRC: c_int = raw::MS_INVALIDCRC as c_int;

impl MSError {
    /// Creates a new error from a given raw error code.
    pub(crate) fn from_raw(code: c_int) -> Self {
        unsafe {
            let message = CStr::from_ptr(raw::ms_errorstr(code)).to_bytes();
            let message = String::from_utf8_lossy(message).into_owned();

            Self { code, message }
        }
    }

    /// Creates a new error from the given string as the error.
    ///
    /// The error returned will have the code `MS_GENERROR`.
    pub fn from_str(s: &str) -> Self {
        Self {
            code: MS_GENERROR,
            message: s.to_string(),
        }
    }

    /// Returns the error code associated with this error.
    pub fn code(&self) -> MSErrorCode {
        match self.raw_code() {
            MS_NOTSEED => MSErrorCode::NotSEED,
            MS_WRONGLENGTH => MSErrorCode::WrongLength,
            MS_OUTOFRANGE => MSErrorCode::OutOfRange,
            MS_UNKNOWNFORMAT => MSErrorCode::UnknownFormat,
            MS_STBADCOMPFLAG => MSErrorCode::SteimBadCompressionFlag,
            MS_INVALIDCRC => MSErrorCode::InvalidCRC,
            _ => MSErrorCode::GenericError,
        }
    }

    /// Returns the raw error code associated with this error.
    pub fn raw_code(&self) -> c_int {
        match self.code {
            MS_NOTSEED => MS_NOTSEED,
            MS_WRONGLENGTH => MS_WRONGLENGTH,
            MS_OUTOFRANGE => MS_OUTOFRANGE,
            MS_UNKNOWNFORMAT => MS_UNKNOWNFORMAT,
            MS_STBADCOMPFLAG => MS_STBADCOMPFLAG,
            MS_INVALIDCRC => MS_INVALIDCRC,
            _ => MS_GENERROR,
        }
    }

    /// Returns the message associated with this error.
    pub fn message(&self) -> &str {
        &self.message
    }
}

impl error::Error for MSError {}

impl fmt::Display for MSError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}; code={:?} ({})",
            self.message,
            self.code(),
            self.code
        )?;

        Ok(())
    }
}