betteroffice-docx 0.3.0

Typed native Rust facade for DOCX parsing, editing, layout, and serialization.
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
123
124
125
126
127
128
129
130
131
132
133

use std::fmt;

#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
    Parse(docx_parse::ParseError),
    Edit(docx_edit::EditError),
    Operation(docx_edit::OpError),
    Layout(docx_layout::LayoutError),
    DisplayList(String),
    ParagraphNotFound(String),
    /// More than one body paragraph has the ID.
    AmbiguousParagraph(String),
    UnsupportedParagraphEdit(String),
    Font(String),
    Image(String),
    ResourceLimit(String),
    RenderTooLarge {
        width: u32,
        height: u32,
        max: u32,
    },
    RenderAreaTooLarge {
        width: u32,
        height: u32,
        max_pixels: u64,
    },
    Render(String),
    /// A structured export refused its options.
    Export(docx_edit::structured::ExportFailure),
}

impl fmt::Display for Error {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Parse(error) => error.fmt(formatter),
            Self::Edit(error) => error.fmt(formatter),
            Self::Operation(error) => error.fmt(formatter),
            Self::Layout(error) => error.fmt(formatter),
            Self::DisplayList(error) => formatter.write_str(error),
            Self::ParagraphNotFound(id) => write!(formatter, "paragraph {id:?} was not found"),
            Self::AmbiguousParagraph(id) => {
                write!(formatter, "more than one paragraph has the ID {id:?}")
            }
            Self::UnsupportedParagraphEdit(id) => {
                write!(
                    formatter,
                    "paragraph {id:?} is not a plain single-run paragraph"
                )
            }
            Self::Font(error) => formatter.write_str(error),
            Self::Image(error) => formatter.write_str(error),
            Self::ResourceLimit(error) => formatter.write_str(error),
            Self::RenderTooLarge { width, height, max } => write!(
                formatter,
                "requested render is {width}x{height}px, exceeds the {max}px per-side cap; lower the page dimensions"
            ),
            Self::RenderAreaTooLarge {
                width,
                height,
                max_pixels,
            } => write!(
                formatter,
                "requested render is {width}x{height}px, exceeds the {max_pixels}-pixel allocation cap; lower the page dimensions"
            ),
            Self::Render(error) => formatter.write_str(error),
            Self::Export(failure) => failure.fmt(formatter),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Parse(error) => Some(error),
            Self::Edit(error) => Some(error),
            Self::Operation(error) => Some(error),
            Self::Layout(error) => Some(error),
            Self::Export(failure) => Some(failure),
            Self::DisplayList(_)
            | Self::ParagraphNotFound(_)
            | Self::AmbiguousParagraph(_)
            | Self::UnsupportedParagraphEdit(_)
            | Self::Font(_)
            | Self::Image(_)
            | Self::ResourceLimit(_)
            | Self::RenderTooLarge { .. }
            | Self::RenderAreaTooLarge { .. }
            | Self::Render(_) => None,
        }
    }
}

impl From<docx_parse::ParseError> for Error {
    fn from(error: docx_parse::ParseError) -> Self {
        Self::Parse(error)
    }
}

impl From<docx_edit::EditError> for Error {
    fn from(error: docx_edit::EditError) -> Self {
        Self::Edit(error)
    }
}

impl From<docx_edit::OpError> for Error {
    fn from(error: docx_edit::OpError) -> Self {
        Self::Operation(error)
    }
}

impl From<docx_layout::LayoutError> for Error {
    fn from(error: docx_layout::LayoutError) -> Self {
        Self::Layout(error)
    }
}

impl From<docx_edit::structured::ExportFailure> for Error {
    fn from(failure: docx_edit::structured::ExportFailure) -> Self {
        Self::Export(failure)
    }
}

impl From<docx_edit::structured::ExportError> for Error {
    fn from(error: docx_edit::structured::ExportError) -> Self {
        match error {
            docx_edit::structured::ExportError::Parse(message) => {
                Self::Edit(docx_edit::EditError::InvalidUpdate(message))
            }
            docx_edit::structured::ExportError::Refused(failure) => Self::Export(failure),
        }
    }
}