devela 0.27.0

A development layer of coherence.
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

// devela::text::fmt::num::shape
//
//! Defines [`FmtNumShape`].
//

use crate::is;

#[doc = crate::_tags!(fmt num)]
/// Describes the structural shape of a formatted number.
#[doc = crate::_doc_location!("text/fmt")]
///
/// The shape captures the lengths of the numeric regions and prefixes,
/// independent of padding, alignment, or styling.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FmtNumShape {
    /// Number of prefix glyphs (e.g. sign or base prefix).
    pub prefix: u16,

    /// Number of digits in the integral (left) part.
    pub left: u16,

    /// Number of digits in the fractional (right) part.
    pub right: u16,
}

impl FmtNumShape {
    /// Creates a numeric shape from prefix and digit counts.
    ///
    /// - `prefix` counts leading non-digit glyphs (e.g. sign or base prefix).
    /// - `left` counts digits in the integral (left) part.
    /// - `right` counts digits in the fractional (right) part.
    #[inline(always)]
    pub const fn new(prefix: u16, left: u16, right: u16) -> Self {
        Self { prefix, left, right }
    }

    /// Returns whether the number has a radix separator.
    ///
    /// This is true when there is a fractional part (`right > 0`).
    #[inline(always)]
    pub const fn has_radix(&self) -> bool {
        self.right > 0
    }

    /// Returns the total number of glyphs required to render the number.
    ///
    /// This includes:
    /// - the prefix (e.g. sign),
    /// - integral digits,
    /// - the radix separator (if present),
    /// - fractional digits.
    #[inline(always)]
    pub const fn total(&self) -> usize {
        self.prefix as usize
            + self.left as usize
            + is![self.has_radix(), 1, 0]
            + self.right as usize
    }

    /// Returns the size of the left alignment block.
    ///
    /// This includes the prefix and all integral digits, but excludes
    /// the radix separator and fractional digits.
    #[inline(always)]
    pub const fn left_block(self) -> usize {
        (self.prefix + self.left) as usize
    }
}