uuencoding-multi 0.1.0

Multi-part UUencoded Usenet/email post reassembly
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

/// Errors produced by multi-part UUencoding reassembly.
///
/// This enum is `#[non_exhaustive]`; new variants may be added in future
/// releases without a breaking change.
///
/// # Example
///
/// ```
/// use uuencoding_multi::MultiUuError;
///
/// let err = MultiUuError::EmptyCollection;
/// assert!(err.to_string().contains("empty"));
/// ```
#[derive(Debug)]
#[non_exhaustive]
pub enum MultiUuError {
    /// One or more part numbers in `1..=expected` are absent from the
    /// collection. `present` lists the part numbers that *were* provided, in
    /// ascending order.
    MissingParts { expected: u32, present: Vec<u32> },

    /// [`reassemble()`][crate::reassemble()] was called on a [`PartCollection`][crate::PartCollection]
    /// that contains no parts with `part_number >= 1`. A collection that holds
    /// only a TOC part (`part_number = 0`) triggers this error.
    EmptyCollection,

    /// A UUdecode error was returned by the `uuencoding` crate while decoding
    /// one of the part bodies. Reassembly stops at the first failing part.
    DecodeError(uuencoding::UuError),

    /// Two calls to [`PartCollection::add`][crate::PartCollection::add] provided
    /// entries with the same `part_number`. The duplicate entry is rejected and
    /// the collection is left unchanged.
    DuplicatePart { part_number: u32 },
}

impl std::fmt::Display for MultiUuError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            MultiUuError::MissingParts { expected, present } => write!(
                f,
                "missing parts: expected {} total, but only have parts {:?}",
                expected, present
            ),
            MultiUuError::EmptyCollection => {
                write!(f, "reassemble() called on empty PartCollection")
            }
            MultiUuError::DecodeError(e) => write!(f, "UUdecode error: {}", e),
            MultiUuError::DuplicatePart { part_number } => {
                write!(f, "duplicate part number: {}", part_number)
            }
        }
    }
}

impl std::error::Error for MultiUuError {}

impl From<uuencoding::UuError> for MultiUuError {
    fn from(e: uuencoding::UuError) -> Self {
        Self::DecodeError(e)
    }
}