docx-rust 0.1.11

A Rust library for parsing and generating docx 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
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
137
138
139
140
141
142
143
144
145

#![allow(unused_must_use)]
use std::borrow::Cow;

use hard_xml::{XmlRead, XmlWrite};

use crate::{__setter, __xml_test_suites};

use super::BodyContent;

/// SDT
///
// /// ```rust
// /// use docx_rust::document::*;
// /// use docx_rust::formatting::*;
// ///
// /// let tbl = SDT::default()
// ///     .property(SDTProperty::default())
// ///     .push_grid(vec![1, 2, 3])
// ///     .push_grid(SDTGrid::default())
// ///     .push_row(SDTRow::default());
// /// ```
#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:sdt")]
pub struct SDT<'a> {
    #[xml(child = "w:sdtPr")]
    pub property: Option<SDTProperty<'a>>,
    #[xml(child = "w:sdtEndPr")]
    pub end_property: Option<SDTEndProperty>,
    #[xml(child = "w:sdtContent")]
    pub content: Option<SDTContent<'a>>,
}

impl<'a> SDT<'a> {
    __setter!(property: Option<SDTProperty<'a>>);
    __setter!(end_property: Option<SDTEndProperty>);
    __setter!(content: Option<SDTContent<'a>>);

    pub fn iter_text(&self) -> Box<dyn Iterator<Item = &Cow<'a, str>> + '_> {
        Box::new(
            self.content
                .as_ref()
                .map(|content| content.iter_text())
                .into_iter()
                .flatten(),
        )
    }

    pub fn text(&self) -> String {
        self.iter_text()
            .map(|c| c.to_string())
            .collect::<Vec<_>>()
            .join("")
    }
}

/// Section Property
///
#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:sdtPr")]
pub struct SDTProperty<'a> {
    #[xml(child = "w:id")]
    pub id: Option<STDId>,
    #[xml(child = "w:docPartObj")]
    pub doc_part_obj: Option<DocPartObj<'a>>,
}

#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:id")]
pub struct STDId {
    #[xml(attr = "w:val", with = "crate::rounded_float")]
    pub id: Option<isize>,
}

#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:docPartObj")]
pub struct DocPartObj<'a> {
    #[xml(child = "w:docPartGallery")]
    pub doc_part_gallery: Option<DocPartGallery<'a>>,
    #[xml(child = "w:docPartUnique")]
    pub doc_part_unique: Option<DocPartUnique>,
}

#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:docPartGallery")]
pub struct DocPartGallery<'a> {
    #[xml(attr = "w:val")]
    pub name: Option<Cow<'a, str>>,
}

#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:docPartUnique")]
pub struct DocPartUnique {}

#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:sdtEndPr")]
pub struct SDTEndProperty {}

#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:sdtContent")]
pub struct SDTContent<'a> {
    #[xml(
        child = "w:p",
        child = "w:tc",
        child = "w:tbl",
        child = "w:sectPr",
        child = "w:sdt",
        child = "w:r"
    )]
    pub content: Vec<BodyContent<'a>>,
}

impl<'a> SDTContent<'a> {
    pub fn text(&self) -> String {
        self.iter_text()
            .map(|c| c.to_string())
            .collect::<Vec<_>>()
            .join("")
    }

    pub fn iter_text(&self) -> Box<dyn Iterator<Item = &Cow<'a, str>> + '_> {
        Box::new(
            self.content
                .iter()
                .filter_map(|content| match content {
                    BodyContent::Paragraph(para) => Some(para.iter_text()),
                    BodyContent::Table(_) => None,
                    BodyContent::SectionProperty(_) => None,
                    BodyContent::Sdt(sdt) => Some(sdt.iter_text()),
                    BodyContent::TableCell(_) => None,
                    BodyContent::Run(run) => Some(run.iter_text()),
                })
                .flatten(),
        )
    }
}

__xml_test_suites!(SDT, SDT::default(), "<w:sdt/>",);