ftml 1.41.0

Foundation Text Markup Language - a library to render Wikidot text as HTML
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

/*
 * tree/clone.rs
 *
 * ftml - Library to parse Wikidot text
 * Copyright (C) 2019-2026 Wikijump Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

//! Utilities to help convert tree structures into owned versions.
//!
//! `SyntaxTree` and its child structures use `Cow` to enable both
//! serialization and deserialization.
//!
//! However if you need to convert a referenced version into an owned
//! version, that requires traversing all the child structures and
//! using `to_owned()`.
//!
//! This module has helpers to make this process easier.

use super::element::Element;
use super::list::ListItem;
use ref_map::*;
use std::borrow::Cow;
use std::collections::HashMap;

#[inline]
pub fn option_string_to_owned(
    option_string: &Option<Cow<'_, str>>,
) -> Option<Cow<'static, str>> {
    option_string.ref_map(|s| string_to_owned(s))
}

#[inline]
pub fn string_to_owned(string: &str) -> Cow<'static, str> {
    Cow::Owned(str!(string))
}

pub fn elements_to_owned(elements: &[Element<'_>]) -> Vec<Element<'static>> {
    elements.iter().map(|element| element.to_owned()).collect()
}

pub fn elements_lists_to_owned(
    element_lists: &[Vec<Element<'_>>],
) -> Vec<Vec<Element<'static>>> {
    element_lists
        .iter()
        .map(|elements| elements_to_owned(elements.as_slice()))
        .collect()
}

pub fn list_items_to_owned(list_items: &[ListItem<'_>]) -> Vec<ListItem<'static>> {
    list_items
        .iter()
        .map(|list_item| list_item.to_owned())
        .collect()
}

pub fn string_map_to_owned(
    map: &HashMap<Cow<'_, str>, Cow<'_, str>>,
) -> HashMap<Cow<'static, str>, Cow<'static, str>> {
    map.iter()
        .map(|(key, value)| {
            let key = string_to_owned(key);
            let value = string_to_owned(value);

            (key, value)
        })
        .collect()
}