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

#![allow(unused_must_use)]

use hard_xml::{XmlRead, XmlWrite};
use std::borrow::Cow;

use crate::{__setter, __xml_test_suites, document::bidir::BidirectionalEmbedding, document::Run};

/// The root element of a hyperlink within the paragraph
#[derive(Debug, Default, XmlRead, XmlWrite, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[xml(tag = "w:hyperlink")]
pub struct Hyperlink<'a> {
    /// Specifies the ID of the relationship in the relationships part for an external link.
    #[xml(attr = "r:id")]
    pub id: Option<Cow<'a, str>>,
    /// Specifies the name of a bookmark within the document.
    #[xml(attr = "w:anchor")]
    pub anchor: Option<Cow<'a, str>>,
    #[xml(child = "w:r")]
    /// Link content
    pub content: Option<Run<'a>>,
    #[xml(child = "w:dir")]
    // Link can contain a bi-directional embedding layer
    pub bidirectional_embedding: Option<BidirectionalEmbedding<'a>>,
}

impl<'a> Hyperlink<'a> {
    __setter!(id: Option<Cow<'a, str>>);
    __setter!(anchor: Option<Cow<'a, str>>);
    __setter!(content: Option<Run<'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().flat_map(|run| run.iter_text()).chain(
                self.bidirectional_embedding
                    .iter()
                    .flat_map(|bidi| bidi.iter_text()),
            ),
        )
    }

    pub fn iter_text_mut(&mut self) -> Box<dyn Iterator<Item = &mut Cow<'a, str>> + '_> {
        Box::new(
            self.content
                .iter_mut()
                .flat_map(|run| run.iter_text_mut())
                .chain(
                    self.bidirectional_embedding
                        .iter_mut()
                        .flat_map(|bidi| bidi.iter_text_mut()),
                ),
        )
    }
}

__xml_test_suites!(
    Hyperlink,
    Hyperlink::default(),
    r#"<w:hyperlink/>"#,
    Hyperlink::default().id("id"),
    r#"<w:hyperlink r:id="id"/>"#,
    Hyperlink::default().anchor("anchor"),
    r#"<w:hyperlink w:anchor="anchor"/>"#,
    Hyperlink::default().content(Run::default()),
    r#"<w:hyperlink><w:r/></w:hyperlink>"#,
);