#[non_exhaustive]pub struct CsvBuilder { /* private fields */ }
Expand description
A builder for Csv
.
Implementations§
Source§impl CsvBuilder
impl CsvBuilder
Sourcepub fn quote_character(self, input: impl Into<String>) -> Self
pub fn quote_character(self, input: impl Into<String>) -> Self
The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark "
character is used.
Sourcepub fn set_quote_character(self, input: Option<String>) -> Self
pub fn set_quote_character(self, input: Option<String>) -> Self
The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark "
character is used.
Sourcepub fn get_quote_character(&self) -> &Option<String>
pub fn get_quote_character(&self) -> &Option<String>
The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark "
character is used.
Sourcepub fn delimiter(self, input: impl Into<String>) -> Self
pub fn delimiter(self, input: impl Into<String>) -> Self
The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma ,
character as the delimiter.
Sourcepub fn set_delimiter(self, input: Option<String>) -> Self
pub fn set_delimiter(self, input: Option<String>) -> Self
The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma ,
character as the delimiter.
Sourcepub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &Option<String>
The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma ,
character as the delimiter.
Sourcepub fn columns(self, input: impl Into<String>) -> Self
pub fn columns(self, input: impl Into<String>) -> Self
Appends an item to columns
.
To override the contents of this collection use set_columns
.
An array of names to use for the columns in the transformed log event.
If you omit this, default column names (\[column_1, column_2 ...\]
) are used.
Sourcepub fn set_columns(self, input: Option<Vec<String>>) -> Self
pub fn set_columns(self, input: Option<Vec<String>>) -> Self
An array of names to use for the columns in the transformed log event.
If you omit this, default column names (\[column_1, column_2 ...\]
) are used.
Sourcepub fn get_columns(&self) -> &Option<Vec<String>>
pub fn get_columns(&self) -> &Option<Vec<String>>
An array of names to use for the columns in the transformed log event.
If you omit this, default column names (\[column_1, column_2 ...\]
) are used.
Sourcepub fn source(self, input: impl Into<String>) -> Self
pub fn source(self, input: impl Into<String>) -> Self
The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.
Sourcepub fn set_source(self, input: Option<String>) -> Self
pub fn set_source(self, input: Option<String>) -> Self
The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.
Sourcepub fn get_source(&self) -> &Option<String>
pub fn get_source(&self) -> &Option<String>
The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.
Trait Implementations§
Source§impl Clone for CsvBuilder
impl Clone for CsvBuilder
Source§fn clone(&self) -> CsvBuilder
fn clone(&self) -> CsvBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CsvBuilder
impl Debug for CsvBuilder
Source§impl Default for CsvBuilder
impl Default for CsvBuilder
Source§fn default() -> CsvBuilder
fn default() -> CsvBuilder
Source§impl PartialEq for CsvBuilder
impl PartialEq for CsvBuilder
impl StructuralPartialEq for CsvBuilder
Auto Trait Implementations§
impl Freeze for CsvBuilder
impl RefUnwindSafe for CsvBuilder
impl Send for CsvBuilder
impl Sync for CsvBuilder
impl Unpin for CsvBuilder
impl UnwindSafe for CsvBuilder
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);