rfham-core 0.1.1

Core data types for RF-Ham libraries.
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

//! Custom formatting trait for rfham types.
//!
//! [`Formatter`] is implemented by types that support configurable text rendering beyond what
//! [`std::fmt::Display`] provides. [`FormatterOptions`] currently carries an optional decimal
//! precision specifier.

// use statements here

// ------------------------------------------------------------------------------------------------
// Public Macros
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

pub trait Formatter {
    fn fmt(&self) -> String {
        self.fmt_with(&FormatterOptions::default())
    }

    fn fmt_with(&self, options: &FormatterOptions) -> String;
}

#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct FormatterOptions {
    precision: Option<usize>,
}

// ------------------------------------------------------------------------------------------------
// Public Functions
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Private Macros
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Private Types
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Implementations
// ------------------------------------------------------------------------------------------------

impl FormatterOptions {
    pub const fn with_precision(mut self, precision: usize) -> Self {
        self.precision = Some(precision);
        self
    }
    pub const fn precision(&self) -> Option<usize> {
        self.precision
    }
}
// ------------------------------------------------------------------------------------------------
// Private Functions
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Sub-Modules
// ------------------------------------------------------------------------------------------------