#[non_exhaustive]pub struct ReadOptionsBuilder { /* private fields */ }
Expand description
A builder for ReadOptions
.
Implementations§
Source§impl ReadOptionsBuilder
impl ReadOptionsBuilder
Sourcepub fn set_encoding(self, input: Option<String>) -> Self
pub fn set_encoding(self, input: Option<String>) -> Self
The file's encoding.
Sourcepub fn get_encoding(&self) -> &Option<String>
pub fn get_encoding(&self) -> &Option<String>
The file's encoding.
Sourcepub fn quote_all(self, input: bool) -> Self
pub fn quote_all(self, input: bool) -> Self
Whether all values need to be quoted, or just those that contain quotes.
Sourcepub fn set_quote_all(self, input: Option<bool>) -> Self
pub fn set_quote_all(self, input: Option<bool>) -> Self
Whether all values need to be quoted, or just those that contain quotes.
Sourcepub fn get_quote_all(&self) -> &Option<bool>
pub fn get_quote_all(&self) -> &Option<bool>
Whether all values need to be quoted, or just those that contain quotes.
Sourcepub fn escape(self, input: impl Into<String>) -> Self
pub fn escape(self, input: impl Into<String>) -> Self
A character for escaping quotes in the file.
Sourcepub fn set_escape(self, input: Option<String>) -> Self
pub fn set_escape(self, input: Option<String>) -> Self
A character for escaping quotes in the file.
Sourcepub fn get_escape(&self) -> &Option<String>
pub fn get_escape(&self) -> &Option<String>
A character for escaping quotes in the file.
Sourcepub fn escape_quotes(self, input: bool) -> Self
pub fn escape_quotes(self, input: bool) -> Self
Whether quotes need to be escaped in the file.
Sourcepub fn set_escape_quotes(self, input: Option<bool>) -> Self
pub fn set_escape_quotes(self, input: Option<bool>) -> Self
Whether quotes need to be escaped in the file.
Sourcepub fn get_escape_quotes(&self) -> &Option<bool>
pub fn get_escape_quotes(&self) -> &Option<bool>
Whether quotes need to be escaped in the file.
Sourcepub fn set_comment(self, input: Option<String>) -> Self
pub fn set_comment(self, input: Option<String>) -> Self
The file's comment character.
Sourcepub fn get_comment(&self) -> &Option<String>
pub fn get_comment(&self) -> &Option<String>
The file's comment character.
Sourcepub fn set_header(self, input: Option<bool>) -> Self
pub fn set_header(self, input: Option<bool>) -> Self
Whether the file has a header row.
Sourcepub fn get_header(&self) -> &Option<bool>
pub fn get_header(&self) -> &Option<bool>
Whether the file has a header row.
Sourcepub fn set_line_sep(self, input: Option<String>) -> Self
pub fn set_line_sep(self, input: Option<String>) -> Self
A line separator for the file.
Sourcepub fn get_line_sep(&self) -> &Option<String>
pub fn get_line_sep(&self) -> &Option<String>
A line separator for the file.
Sourcepub fn build(self) -> ReadOptions
pub fn build(self) -> ReadOptions
Consumes the builder and constructs a ReadOptions
.
Trait Implementations§
Source§impl Clone for ReadOptionsBuilder
impl Clone for ReadOptionsBuilder
Source§fn clone(&self) -> ReadOptionsBuilder
fn clone(&self) -> ReadOptionsBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ReadOptionsBuilder
impl Debug for ReadOptionsBuilder
Source§impl Default for ReadOptionsBuilder
impl Default for ReadOptionsBuilder
Source§fn default() -> ReadOptionsBuilder
fn default() -> ReadOptionsBuilder
Source§impl PartialEq for ReadOptionsBuilder
impl PartialEq for ReadOptionsBuilder
impl StructuralPartialEq for ReadOptionsBuilder
Auto Trait Implementations§
impl Freeze for ReadOptionsBuilder
impl RefUnwindSafe for ReadOptionsBuilder
impl Send for ReadOptionsBuilder
impl Sync for ReadOptionsBuilder
impl Unpin for ReadOptionsBuilder
impl UnwindSafe for ReadOptionsBuilder
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);