Struct colored_json::PrettyFormatter
source · pub struct PrettyFormatter<'a> { /* private fields */ }
Expand description
This structure pretty prints a JSON value to make it human readable.
Implementations§
source§impl<'a> PrettyFormatter<'a>
impl<'a> PrettyFormatter<'a>
sourcepub fn new() -> PrettyFormatter<'a>
pub fn new() -> PrettyFormatter<'a>
Construct a pretty printer formatter that defaults to using two spaces for indentation.
sourcepub fn with_indent(indent: &'a [u8]) -> PrettyFormatter<'a>
pub fn with_indent(indent: &'a [u8]) -> PrettyFormatter<'a>
Construct a pretty printer formatter that uses the indent
string for indentation.
Trait Implementations§
source§impl<'a> Clone for PrettyFormatter<'a>
impl<'a> Clone for PrettyFormatter<'a>
source§fn clone(&self) -> PrettyFormatter<'a>
fn clone(&self) -> PrettyFormatter<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for PrettyFormatter<'a>
impl<'a> Debug for PrettyFormatter<'a>
source§impl<'a> Default for PrettyFormatter<'a>
impl<'a> Default for PrettyFormatter<'a>
source§fn default() -> PrettyFormatter<'a>
fn default() -> PrettyFormatter<'a>
source§impl<'a> Formatter for PrettyFormatter<'a>
impl<'a> Formatter for PrettyFormatter<'a>
source§fn begin_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
[
to the specified
writer.source§fn end_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn end_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
]
to the specified
writer.source§fn begin_array_value<W>(
&mut self,
writer: &mut W,
first: bool
) -> Result<(), Error>
fn begin_array_value<W>( &mut self, writer: &mut W, first: bool ) -> Result<(), Error>
,
if needed to
the specified writer.source§fn end_array_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
fn end_array_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
source§fn begin_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
{
to the specified
writer.source§fn end_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn end_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
}
to the specified
writer.source§fn begin_object_key<W>(
&mut self,
writer: &mut W,
first: bool
) -> Result<(), Error>
fn begin_object_key<W>( &mut self, writer: &mut W, first: bool ) -> Result<(), Error>
source§fn begin_object_value<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_object_value<W>(&mut self, writer: &mut W) -> Result<(), Error>
:
should be written to
the specified writer by either this method or
end_object_key
.source§fn end_object_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
fn end_object_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
source§fn write_null<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn write_null<W>(&mut self, writer: &mut W) -> Result<(), Error>
null
value to the specified writer.source§fn write_bool<W>(&mut self, writer: &mut W, value: bool) -> Result<(), Error>
fn write_bool<W>(&mut self, writer: &mut W, value: bool) -> Result<(), Error>
true
or false
value to the specified writer.source§fn write_i8<W>(&mut self, writer: &mut W, value: i8) -> Result<(), Error>
fn write_i8<W>(&mut self, writer: &mut W, value: i8) -> Result<(), Error>
-123
to the specified writer.source§fn write_i16<W>(&mut self, writer: &mut W, value: i16) -> Result<(), Error>
fn write_i16<W>(&mut self, writer: &mut W, value: i16) -> Result<(), Error>
-123
to the specified writer.source§fn write_i32<W>(&mut self, writer: &mut W, value: i32) -> Result<(), Error>
fn write_i32<W>(&mut self, writer: &mut W, value: i32) -> Result<(), Error>
-123
to the specified writer.source§fn write_i64<W>(&mut self, writer: &mut W, value: i64) -> Result<(), Error>
fn write_i64<W>(&mut self, writer: &mut W, value: i64) -> Result<(), Error>
-123
to the specified writer.source§fn write_u8<W>(&mut self, writer: &mut W, value: u8) -> Result<(), Error>
fn write_u8<W>(&mut self, writer: &mut W, value: u8) -> Result<(), Error>
123
to the specified writer.source§fn write_u16<W>(&mut self, writer: &mut W, value: u16) -> Result<(), Error>
fn write_u16<W>(&mut self, writer: &mut W, value: u16) -> Result<(), Error>
123
to the specified writer.source§fn write_u32<W>(&mut self, writer: &mut W, value: u32) -> Result<(), Error>
fn write_u32<W>(&mut self, writer: &mut W, value: u32) -> Result<(), Error>
123
to the specified writer.source§fn write_u64<W>(&mut self, writer: &mut W, value: u64) -> Result<(), Error>
fn write_u64<W>(&mut self, writer: &mut W, value: u64) -> Result<(), Error>
123
to the specified writer.source§fn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<(), Error>
fn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<(), Error>
-31.26e+12
to the specified writer.source§fn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<(), Error>
fn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<(), Error>
-31.26e+12
to the specified writer.source§fn write_number_str<W>(
&mut self,
writer: &mut W,
value: &str
) -> Result<(), Error>
fn write_number_str<W>( &mut self, writer: &mut W, value: &str ) -> Result<(), Error>
source§fn begin_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
write_string_fragment
and
write_char_escape
. Writes a "
to the specified writer.source§fn end_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn end_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
write_string_fragment
and
write_char_escape
. Writes a "
to the specified writer.source§fn write_string_fragment<W>(
&mut self,
writer: &mut W,
fragment: &str
) -> Result<(), Error>
fn write_string_fragment<W>( &mut self, writer: &mut W, fragment: &str ) -> Result<(), Error>
source§fn write_char_escape<W>(
&mut self,
writer: &mut W,
char_escape: CharEscape
) -> Result<(), Error>
fn write_char_escape<W>( &mut self, writer: &mut W, char_escape: CharEscape ) -> Result<(), Error>
Auto Trait Implementations§
impl<'a> Freeze for PrettyFormatter<'a>
impl<'a> RefUnwindSafe for PrettyFormatter<'a>
impl<'a> Send for PrettyFormatter<'a>
impl<'a> Sync for PrettyFormatter<'a>
impl<'a> Unpin for PrettyFormatter<'a>
impl<'a> UnwindSafe for PrettyFormatter<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);