sdocx 1.0.0

Reverse-engineered tooling and SDK for converting Samsung Notes (.sdocx) files
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

use std::io;

/// Errors that can occur when parsing an `.sdocx` file.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// An I/O error occurred while reading the file.
    #[error("I/O error: {0}")]
    Io(#[from] io::Error),

    /// The file is not a valid ZIP archive.
    #[error("ZIP error: {0}")]
    Zip(#[from] zip::result::ZipError),

    /// The file contents do not match the expected `.sdocx` format.
    #[error("format error: {0}")]
    Format(String),

    /// The file uses Samsung Notes document protection and must be unlocked first.
    #[error("protected Samsung Notes document; unlock or export it before parsing")]
    ProtectedDocument,

    /// A configurable parser resource limit was exceeded.
    #[error("{resource} limit exceeded: {actual} > {limit}")]
    LimitExceeded {
        /// Resource whose limit was exceeded.
        resource: &'static str,
        /// Configured maximum.
        limit: u64,
        /// Value found in the input.
        actual: u64,
    },
}

/// A specialized `Result` type for sdocx operations.
pub type Result<T> = std::result::Result<T, Error>;