format_tools 0.6.0

Collection of mechanisms for formatting and serialization into string.
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
153
154
155
156
157
158
159
160

//!
//! Flexible ToString augmentation.
//!

/// Define a private namespace for all its items.
mod private
{

  use std::
  {
    fmt,
    borrow::Cow,
  };

  // ==

  /// Marker type for returning reference representing instance instead of allocating new string.
  #[ derive( Debug, Default, Clone, Copy ) ]
  pub struct WithRef;

  /// Marker type for using Debug formatting.
  #[ derive( Debug, Default, Clone, Copy ) ]
  pub struct WithDebug;

  /// Marker type for using Debug multiline formatting.
  #[ derive( Debug, Default, Clone, Copy ) ]
  pub struct WithDebugMultiline;

  /// Marker type for using Display formatting.
  #[ derive( Debug, Default, Clone, Copy ) ]
  pub struct WithDisplay;

  /// Marker type for usign Well formatting.
  #[ derive( Debug, Default, Clone, Copy ) ]
  pub struct WithWell;

  // ==

  /// Trait to convert a type to a string using a specified formatting method.
  pub trait ToStringWith< How >
  {
    /// Converts the type to a string using the specified formatting method.
    fn to_string_with< 's >( &'s self ) -> Cow< 's, str >;
  }

  impl< 'a, T > ToStringWith< WithRef > for T
  where
    T : 'a,
    T : AsRef< str >,
    T : ?Sized,
  {
    /// Converts the type to a string using Display formatting.
    #[ inline ]
    fn to_string_with< 's >( &'s self ) -> Cow< 's, str >
    {
      // println!( " - WithRef" );
      Cow::Borrowed( self.as_ref() )
    }
  }

  impl< 'a, T > ToStringWith< WithDebug > for T
  where
    T : fmt::Debug,
    T : ?Sized,
  {
    /// Converts the type to a string using Debug formatting.
    #[ inline ]
    fn to_string_with< 's >( &'s self ) -> Cow< 's, str >
    {
      // println!( " - WithDebug {:?}", self );
      Cow::Owned( format!( "{:?}", self ) )
    }
  }

  impl< 'a, T > ToStringWith< WithDebugMultiline > for T
  where
    T : fmt::Debug,
    T : ?Sized,
  {
    /// Converts the type to a string using Debug formatting.
    #[ inline ]
    fn to_string_with< 's >( &'s self ) -> Cow< 's, str >
    {
      // println!( " - WithDebugMultiline {:#?}", self );
      Cow::Owned( format!( "{:#?}", self ) )
    }
  }

  impl< 'a, T > ToStringWith< WithDisplay > for T
  where
    T : 'a,
    T : fmt::Display,
    T : ?Sized,
  {
    /// Converts the type to a string using Display formatting.
    #[ inline ]
    fn to_string_with< 's >( &'s self ) -> Cow< 's, str >
    {
      // println!( " - WithDisplay {}", self );
      Cow::Owned( format!( "{}", self ) )
    }
  }

}

mod aref;

#[ doc( inline ) ]
#[ allow( unused_imports ) ]
pub use own::*;

/// Own namespace of the module.
#[ allow( unused_imports ) ]
pub mod own
{
  use super::*;

  #[ doc( inline ) ]
  pub use orphan::*;

}

/// Orphan namespace of the module.
#[ allow( unused_imports ) ]
pub mod orphan
{
  use super::*;
  pub use super::super::to_string;

  #[ doc( inline ) ]
  pub use exposed::*;

  #[ doc( inline ) ]
  pub use private::
  {
    WithDebug,
    WithDebugMultiline,
    WithDisplay,
    WithRef,
    WithWell,
    ToStringWith,
  };

}

/// Exposed namespace of the module.
#[ allow( unused_imports ) ]
pub mod exposed
{
  use super::*;
  #[ doc( inline ) ]
  pub use prelude::*;
}

/// Prelude to use essentials: `use my_module::prelude::*`.
#[ allow( unused_imports ) ]
pub mod prelude
{
  use super::*;
}