jamjam 0.3.0

Handles JAM, PCBOARD message bases & QWK packets.
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

use std::fmt;

use thiserror::Error;

/// The message base format a low level parse error originated from.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum Format {
    Jam,
    PCBoard,
    Qwk,
}

impl fmt::Display for Format {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Format::Jam => write!(f, "JAM"),
            Format::PCBoard => write!(f, "PCBoard"),
            Format::Qwk => write!(f, "QWK"),
        }
    }
}

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum Error {
    #[error("i/o error: {0}")]
    Io(#[from] std::io::Error),

    #[error(transparent)]
    Jam(#[from] crate::jam::JamError),

    #[error(transparent)]
    PCBoard(#[from] crate::pcboard::PCBoardError),

    #[error(transparent)]
    Qwk(#[from] crate::qwk::QwkError),

    /// A record did not match the format specification.
    #[error("invalid {format} data at offset {offset}: {reason}")]
    InvalidData {
        format: Format,
        offset: u64,
        reason: String,
    },

    #[error("invalid utf-8: {0}")]
    Utf8(#[from] bstr::Utf8Error),

    #[error("system time is before the unix epoch: {0}")]
    SystemTime(#[from] std::time::SystemTimeError),
}

impl Error {
    pub(crate) fn invalid(format: Format, offset: u64, reason: impl Into<String>) -> Self {
        Self::InvalidData {
            format,
            offset,
            reason: reason.into(),
        }
    }

    pub(crate) fn jam(offset: u64, reason: impl Into<String>) -> Self {
        Self::invalid(Format::Jam, offset, reason)
    }

    pub(crate) fn pcboard(offset: u64, reason: impl Into<String>) -> Self {
        Self::invalid(Format::PCBoard, offset, reason)
    }

    pub(crate) fn qwk(offset: u64, reason: impl Into<String>) -> Self {
        Self::invalid(Format::Qwk, offset, reason)
    }
}

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