img-gen-spec 0.2.1

An API to create image generator specifications
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

#[cfg(feature = "pyo3")]
use pyo3::prelude::*;

use serde::{Deserialize, Serialize};

/// Font-related validators used by [`Typography`].
pub mod font;
/// Line-related validators used by [`Typography`].
pub mod line;

use super::{Border, ColorKind};
pub use font::{Font, Weight};
pub use line::{Line, LineHeight};

/// A enumeration of the possible alignment options for the text in a [`Typography`] attribute.
#[cfg_attr(
    feature = "pyo3",
    pyclass(eq, eq_int, module = "img_gen", from_py_object)
)]
#[derive(Debug, PartialEq, Clone, Default, Serialize, Deserialize)]
pub enum TypographyAlign {
    /// Aligns text to the top-left corner.
    #[serde(alias = "start top")]
    #[default]
    StartTop,

    /// Aligns text to the vertical center of the left edge.
    #[serde(alias = "start center")]
    StartCenter,

    /// Aligns text to the bottom-left corner.
    #[serde(alias = "start bottom")]
    StartBottom,

    /// Aligns text to the horizontal center of the top edge.
    #[serde(alias = "center top")]
    CenterTop,

    /// Centers text horizontally and vertically.
    #[serde(alias = "center")]
    Center,

    /// Centers text horizontally and vertically.
    #[serde(alias = "center center")]
    CenterCenter,

    /// Aligns text to the horizontal center of the bottom edge.
    #[serde(alias = "center bottom")]
    CenterBottom,

    /// Aligns text to the top-right corner.
    #[serde(alias = "end top")]
    EndTop,

    /// Aligns text to the vertical center of the right edge.
    #[serde(alias = "end center")]
    EndCenter,

    /// Aligns text to the bottom-right corner.
    #[serde(alias = "end bottom")]
    EndBottom,
}

/// An attribute to represent a [`Layer`](struct@crate::Layer)'s rendered text.
#[cfg_attr(
    feature = "pyo3",
    pyclass(module = "img_gen", get_all, set_all, from_py_object)
)]
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Typography {
    /// The text content.
    pub content: String,

    /// The alignment of the text.
    #[serde(default = "TypographyAlign::default")]
    pub align: TypographyAlign,

    /// The color used to fill the rendered text.
    #[serde(default)]
    pub color: ColorKind,

    /// The `Line` property used to describe the text's size.
    #[serde(default = "Line::default")]
    pub line: Line,

    /// Controls how text that doesn't fit within the layer's bounds is handled.
    ///
    /// - `true`: the font size is progressively reduced until all text fits within the layer.
    /// - `false`: text wraps within the layer's horizontal boundary; any text that still
    ///   overflows is replaced with a trailing ellipsis (`…`).
    #[serde(default)]
    pub overflow: bool,

    /// The `Font` property used to describe the font used to render the text.
    #[serde(default = "Font::default")]
    pub font: Font,

    /// The border (if specified) to draw around the rendered glyphs of the `content`.
    #[serde(default)]
    pub border: Option<Border>,
}