bwrap 1.3.0

A fast, lightweight, embedded systems-friendly library for wrapping text.
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
146
147
148
149
150
151
152

// Copyright (C) 2023 Michael Lee <micl2e2@proton.me>
//
// Licensed under the MIT License <LICENSE-MIT or
// https://opensource.org/license/mit> or the GNU General Public License,
// Version 3.0 or any later version <LICENSE-GPL or
// https://www.gnu.org/licenses/gpl-3.0.txt>, at your option.
//
// This file may not be copied, modified, or distributed except except in
// compliance with either of the licenses.
//

#[cfg_attr(doc_cfg, doc(cfg(feature = "use_std")))]
#[cfg(feature = "use_std")]
mod stdonly {
    ///
    /// Wrap text in default style.
    ///
    /// The default style is `WrapStyle::NoBrk`, with no
    /// appending or prepending, and width limit defaults to 80 if second
    /// argument is omitted.
    ///
    /// [`Non-Break`]: crate::WrapStyle::NoBrk
    ///
    /// # Panics
    ///
    /// Panics if input string consists of invalid UTF8 bytes.
    #[macro_export]
    macro_rules! wrap {
        ($s:expr) => {{
            use bwrap::EasyWrapper;
            let mut wrapper = EasyWrapper::new($s, 80).expect("bwrap init");
            let w = wrapper.wrap().expect("bwrap wrap");
            String::from(w)
        }};
        ($s:expr, $mw:expr) => {{
            use bwrap::EasyWrapper;
            let mut wrapper = EasyWrapper::new($s, $mw).expect("bwrap init");
            let w = wrapper.wrap().expect("bwrap wrap");
            String::from(w)
        }};
    }

    ///
    /// Wrap text in [`Non-Break`] style.
    ///
    /// [`Non-Break`]: crate::WrapStyle::NoBrk
    ///
    /// This macro has three forms:
    ///
    /// - `wrap_nobrk(A)`
    ///   - `A` is input string, assuming no appending.
    ///
    /// - `wrap_nobrk(A,B)`
    ///   - `A` is input string, `B` is width limit, assuming no appending.
    ///
    /// - `wrap_nobrk(A,B,C)`
    ///   - `A` is input string, `B` is width limit, `C` is appended string.
    ///
    /// # Panics
    ///
    /// Panics if input string consists of invalid UTF8 bytes.
    #[macro_export]
    macro_rules! wrap_nobrk {
        ($s:expr) => {{
            use bwrap::{EasyWrapper, ExistNlPref::KeepTrailSpc, WrapStyle::NoBrk};
            let mut wrapper = EasyWrapper::new($s, 80).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(bwrap::WrapStyle::NoBrk(None, KeepTrailSpc))
                .expect("bwrap wrap");
            String::from(w)
        }};

        ($s:expr, $mw:expr) => {{
            use bwrap::{EasyWrapper, ExistNlPref::KeepTrailSpc, WrapStyle::NoBrk};
            let mut wrapper = EasyWrapper::new($s, $mw).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(bwrap::WrapStyle::NoBrk(None, KeepTrailSpc))
                .expect("bwrap wrap");
            String::from(w)
        }};

        ($s:expr, $mw:expr, $appd:expr) => {{
            use bwrap::{EasyWrapper, ExistNlPref::KeepTrailSpc, WrapStyle::NoBrk};
            let mut wrapper = EasyWrapper::new($s, $mw).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(bwrap::WrapStyle::NoBrk(Some($appd), KeepTrailSpc))
                .expect("bwrap wrap");
            String::from(w)
        }};
    }

    ///
    /// Wrap text in [`May-Break`] style.
    ///
    /// [`May-Break`]: crate::WrapStyle::MayBrk
    ///
    /// This macro has three forms:
    ///
    /// - `wrap_maybrk(A)`
    ///   - `A` is input string, assuming 80-width limit and no prepending or appending.
    ///
    /// - `wrap_maybrk(A,B)`
    ///   - `A` is input string, `B` is width limit, assuming no prepending or appending.
    ///
    /// - `wrap_maybrk(A,B,C)`
    ///   - `A` is input string, `B` is width limit, `C` is prepended string, assuming no appending.
    ///
    /// - `wrap_maybrk(A,B,C,D)`
    ///   - `A` is input string, `B` is width limit, `C` is prepended string, `D` is appended string.
    ///
    /// # Panics
    ///
    /// Panics if input string consists of invalid UTF8 bytes.
    #[macro_export]
    macro_rules! wrap_maybrk {
        ($s:expr) => {{
            use bwrap::{EasyWrapper, WrapStyle};
            let mut wrapper = EasyWrapper::new($s, 80).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(WrapStyle::MayBrk(None, None))
                .expect("bwrap wrap");
            String::from(w)
        }};

        ($s:expr, $mw:expr) => {{
            use bwrap::{EasyWrapper, WrapStyle};
            let mut wrapper = EasyWrapper::new($s, $mw).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(WrapStyle::MayBrk(None, None))
                .expect("bwrap wrap");
            String::from(w)
        }};

        ($s:expr, $mw:expr, $prep:expr) => {{
            use bwrap::{EasyWrapper, WrapStyle};
            let mut wrapper = EasyWrapper::new($s, $mw).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(WrapStyle::MayBrk(Some($prep), None))
                .expect("bwrap wrap");
            String::from(w)
        }};

        ($s:expr, $mw:expr, $prep:expr, $appd:expr) => {{
            use bwrap::{EasyWrapper, WrapStyle};
            let mut wrapper = EasyWrapper::new($s, $mw).expect("bwrap init");
            let w = wrapper
                .wrap_use_style(WrapStyle::MayBrk(Some($prep), Some($appd)))
                .expect("bwrap wrap");
            String::from(w)
        }};
    }
}