color-span 0.2.1

Color shared definition
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

use std::fmt::{Debug, Formatter};

use internship::IStr;
use serde::{Deserialize, Serialize};

use code_span::CodeView;

mod convert;
mod der;
pub mod iter;
mod ser;

/// Write color palette into html
///
/// **Support 255 color at most**.
///
/// # Arguments
///
/// * `w`:
///
/// returns: Result<(), Error>
///
/// # Examples
///
/// ```
/// use color_span::ColorClass;
/// ```
#[derive(Clone, Eq, PartialEq)]
pub struct ColorView {
    span: CodeView<IStr>,
}

/// # Arguments
///
/// * `text`:
///
/// returns: TextColorView
///
/// # Examples
///
/// ```
/// use color_span::ColorView;
/// ```
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Serialize, Deserialize)]
pub struct ColorSpan {
    /// content of the code span
    pub text: String,
    /// color class of the code span
    pub color: IStr,
}

impl ColorView {
    /// # Arguments
    ///
    /// * `text`:
    ///
    /// returns: TextColorView
    ///
    /// # Examples
    ///
    /// ```
    /// use color_span::ColorView;
    /// ```
    #[inline]
    pub fn new(text: impl Into<String>) -> ColorView {
        Self { span: CodeView::blank(text) }
    }
    /// Color the text in the range of `start`..`end` to given color name
    ///
    /// # Arguments
    ///
    /// * `start`: start offset
    /// * `end`: end offset
    /// * `color`: color name
    ///
    /// # Examples
    ///
    /// ```
    /// use color_span::ColorView;
    /// ```
    pub fn text(&self) -> &str {
        self.span.get_text()
    }
    /// Color the text in the range of `start`..`end` to given color name
    ///
    /// # Arguments
    ///
    /// * `start`: start offset
    /// * `end`: end offset
    /// * `color`: color name
    ///
    /// # Examples
    ///
    /// ```
    /// use color_span::ColorView;
    /// ```
    pub fn dye_position(&mut self, start: usize, end: usize, color: &str) {
        let color = match color {
            "" => None,
            _ => Some(IStr::new(color)),
        };
        self.span.mark_position(start, end, color)
    }
    /// Color the text in the range of `start`..`end` to given color name
    ///
    /// # Arguments
    ///
    /// * `start`: start offset
    /// * `end`: end offset
    /// * `color`: color name
    ///
    /// # Examples
    ///
    /// ```
    /// use color_span::ColorView;
    /// ```
    pub fn dye_offset(&mut self, start: usize, end: usize, color: &str) {
        let color = match color {
            "" => None,
            _ => Some(IStr::new(color)),
        };
        self.span.mark_offset(start, end, color)
    }
}