docx-rs 0.4.20

A .docx file writer with Rust/WebAssembly.
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
134
135
136

use serde::Serialize;
use std::io::Write;

use super::*;
use crate::documents::BuildXML;
use crate::{escape::*, xml_builder::*};

#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct DocumentRels {
    pub has_comments: bool,
    pub has_numberings: bool,
    pub has_footnotes: bool,
    pub images: Vec<(String, String)>,
    pub hyperlinks: Vec<(String, String, String)>,
    pub custom_xml_count: usize,
    pub header_count: usize,
    pub footer_count: usize,
}

impl DocumentRels {
    pub fn new() -> DocumentRels {
        Default::default()
    }

    pub fn add_custom_item(mut self) -> Self {
        self.custom_xml_count += 1;
        self
    }

    pub fn add_image(mut self, id: impl Into<String>, path: impl Into<String>) -> Self {
        self.images.push((id.into(), path.into()));
        self
    }

    pub fn add_hyperlinks(
        mut self,
        id: impl Into<String>,
        path: impl Into<String>,
        r#type: impl Into<String>,
    ) -> Self {
        self.hyperlinks
            .push((id.into(), escape(&path.into()), r#type.into()));
        self
    }
}

impl BuildXML for DocumentRels {
    fn build_to<W: Write>(
        &self,
        stream: crate::xml::writer::EventWriter<W>,
    ) -> crate::xml::writer::Result<crate::xml::writer::EventWriter<W>> {
        XMLBuilder::from(stream)
            .declaration(None)?
            .open_relationships("http://schemas.openxmlformats.org/package/2006/relationships")?
            .relationship(
                "rId1",
                "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
                "styles.xml",
            )?
            .relationship(
                "rId2",
                "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable",
                "fontTable.xml",
            )?
            .relationship(
                "rId3",
                "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings",
                "settings.xml",
            )?
            .relationship(
                "rId5",
                "http://schemas.microsoft.com/office/2011/relationships/commentsExtended",
                "commentsExtended.xml",
            )?
            .apply_if(self.has_comments, |b| {
                b.relationship(
                    "rId6",
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments",
                    "comments.xml",
                )
            })?
            .apply_if(self.has_numberings, |b| {
                b.relationship(
                    "rId7",
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering",
                    "numbering.xml",
                )
            })?
            .apply_if(self.has_footnotes, |b| {
                b.relationship(
                    "rId8",
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes",
                    "footnotes.xml",
                )
            })?
            .apply_each(0..self.header_count, |i, b| {
                b.relationship(
                    &create_header_rid(i + 1),
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header",
                    &format!("header{}.xml", i + 1),
                )
            })?
            .apply_each(0..self.footer_count, |i, b| {
                b.relationship(
                    &create_footer_rid(i + 1),
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer",
                    &format!("footer{}.xml", i + 1),
                )
            })?
            .apply_each(0..self.custom_xml_count, |i, b| {
                b.relationship(
                    &format!("rId{}", i + 8),
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml",
                    &format!("../customXml/item{}.xml", i + 1),
                )
            })?
            .apply_each(self.images.iter(), |(id, path), b| {
                b.relationship(
                    id,
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
                    path,
                )
            })?
            .apply_each(self.hyperlinks.iter(), |(id, path, r#type), b| {
                b.relationship_with_mode(
                    id,
                    "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
                    path,
                    r#type,
                )
            })?
            .close()?
            .into_inner()
    }
}