#[non_exhaustive]pub struct CsvOutputBuilder { /* private fields */ }
Expand description
A builder for CsvOutput
.
Implementations§
Source§impl CsvOutputBuilder
impl CsvOutputBuilder
Sourcepub fn quote_fields(self, input: QuoteFields) -> Self
pub fn quote_fields(self, input: QuoteFields) -> Self
Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
Sourcepub fn set_quote_fields(self, input: Option<QuoteFields>) -> Self
pub fn set_quote_fields(self, input: Option<QuoteFields>) -> Self
Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
Sourcepub fn get_quote_fields(&self) -> &Option<QuoteFields>
pub fn get_quote_fields(&self) -> &Option<QuoteFields>
Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
Sourcepub fn quote_escape_character(self, input: impl Into<String>) -> Self
pub fn quote_escape_character(self, input: impl Into<String>) -> Self
The single character used for escaping the quote character inside an already escaped value.
Sourcepub fn set_quote_escape_character(self, input: Option<String>) -> Self
pub fn set_quote_escape_character(self, input: Option<String>) -> Self
The single character used for escaping the quote character inside an already escaped value.
Sourcepub fn get_quote_escape_character(&self) -> &Option<String>
pub fn get_quote_escape_character(&self) -> &Option<String>
The single character used for escaping the quote character inside an already escaped value.
Sourcepub fn record_delimiter(self, input: impl Into<String>) -> Self
pub fn record_delimiter(self, input: impl Into<String>) -> Self
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
Sourcepub fn set_record_delimiter(self, input: Option<String>) -> Self
pub fn set_record_delimiter(self, input: Option<String>) -> Self
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
Sourcepub fn get_record_delimiter(&self) -> &Option<String>
pub fn get_record_delimiter(&self) -> &Option<String>
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
Sourcepub fn field_delimiter(self, input: impl Into<String>) -> Self
pub fn field_delimiter(self, input: impl Into<String>) -> Self
The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
Sourcepub fn set_field_delimiter(self, input: Option<String>) -> Self
pub fn set_field_delimiter(self, input: Option<String>) -> Self
The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
Sourcepub fn get_field_delimiter(&self) -> &Option<String>
pub fn get_field_delimiter(&self) -> &Option<String>
The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
Sourcepub fn quote_character(self, input: impl Into<String>) -> Self
pub fn quote_character(self, input: impl Into<String>) -> Self
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b
, Amazon S3 wraps this field value in quotation marks, as follows: " a , b "
.
Sourcepub fn set_quote_character(self, input: Option<String>) -> Self
pub fn set_quote_character(self, input: Option<String>) -> Self
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b
, Amazon S3 wraps this field value in quotation marks, as follows: " a , b "
.
Sourcepub fn get_quote_character(&self) -> &Option<String>
pub fn get_quote_character(&self) -> &Option<String>
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b
, Amazon S3 wraps this field value in quotation marks, as follows: " a , b "
.
Trait Implementations§
Source§impl Clone for CsvOutputBuilder
impl Clone for CsvOutputBuilder
Source§fn clone(&self) -> CsvOutputBuilder
fn clone(&self) -> CsvOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CsvOutputBuilder
impl Debug for CsvOutputBuilder
Source§impl Default for CsvOutputBuilder
impl Default for CsvOutputBuilder
Source§fn default() -> CsvOutputBuilder
fn default() -> CsvOutputBuilder
Source§impl PartialEq for CsvOutputBuilder
impl PartialEq for CsvOutputBuilder
impl StructuralPartialEq for CsvOutputBuilder
Auto Trait Implementations§
impl Freeze for CsvOutputBuilder
impl RefUnwindSafe for CsvOutputBuilder
impl Send for CsvOutputBuilder
impl Sync for CsvOutputBuilder
impl Unpin for CsvOutputBuilder
impl UnwindSafe for CsvOutputBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§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);