readstor 0.6.0

A CLI for Apple Books annotations
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

//! Defines the post-processor type.
//!
//! Post-processors are used mutate fields within a [`Render`].

use crate::render::template::Render;
use crate::strings;

/// A struct for post-processing [`Render`]s.
#[derive(Debug, Clone, Copy)]
pub struct PostProcessor;

impl PostProcessor {
    /// Runs all post-strings on an [`Render`].
    ///
    /// # Arguments
    ///
    /// * `renders` - The [`Render`]s to process.
    /// * `options` - The post-process options.
    pub fn run<O>(renders: Vec<&mut Render>, options: O)
    where
        O: Into<PostProcessOptions>,
    {
        let options: PostProcessOptions = options.into();

        for render in renders {
            if options.trim_blocks {
                Self::trim_blocks(render);
            }

            if let Some(width) = options.wrap_text {
                Self::wrap_text(render, width);
            }
        }
    }

    /// Trims any blocks left after rendering.
    ///
    /// # Arguments
    ///
    /// * `render` - The [`Render`] to process.
    fn trim_blocks(render: &mut Render) {
        render.contents = strings::trim_blocks(&render.contents);
    }

    /// Wraps text to a maximum character width.
    ///
    /// Maximum line length is not guaranteed as long words are not broken if
    /// their length exceeds the maximum. Hyphenation is not used, however,
    /// an existing hyphen can be split on to insert a line-break.
    ///
    /// # Arguments
    ///
    /// * `render` - The [`Render`] to process.
    /// * `width` - The maximum character width.
    fn wrap_text(render: &mut Render, width: usize) {
        let options = textwrap::Options::new(width).break_words(false);
        render.contents = textwrap::fill(&render.contents, options);
    }
}

/// A struct representing options for the [`PostProcessor`] struct.
#[derive(Debug, Default, Clone, Copy)]
pub struct PostProcessOptions {
    /// Toggles trimming blocks left after rendering.
    pub trim_blocks: bool,

    /// Toggles wrapping text to a maximum character width.
    pub wrap_text: Option<usize>,
}