#[non_exhaustive]pub struct StatementOutputBuilder { /* private fields */ }
Expand description
A builder for StatementOutput
.
Implementations§
Source§impl StatementOutputBuilder
impl StatementOutputBuilder
Sourcepub fn data(self, input: StatementOutputData) -> Self
pub fn data(self, input: StatementOutputData) -> Self
The code execution output.
Sourcepub fn set_data(self, input: Option<StatementOutputData>) -> Self
pub fn set_data(self, input: Option<StatementOutputData>) -> Self
The code execution output.
Sourcepub fn get_data(&self) -> &Option<StatementOutputData>
pub fn get_data(&self) -> &Option<StatementOutputData>
The code execution output.
Sourcepub fn execution_count(self, input: i32) -> Self
pub fn execution_count(self, input: i32) -> Self
The execution count of the output.
Sourcepub fn set_execution_count(self, input: Option<i32>) -> Self
pub fn set_execution_count(self, input: Option<i32>) -> Self
The execution count of the output.
Sourcepub fn get_execution_count(&self) -> &Option<i32>
pub fn get_execution_count(&self) -> &Option<i32>
The execution count of the output.
Sourcepub fn status(self, input: StatementState) -> Self
pub fn status(self, input: StatementState) -> Self
The status of the code execution output.
Sourcepub fn set_status(self, input: Option<StatementState>) -> Self
pub fn set_status(self, input: Option<StatementState>) -> Self
The status of the code execution output.
Sourcepub fn get_status(&self) -> &Option<StatementState>
pub fn get_status(&self) -> &Option<StatementState>
The status of the code execution output.
Sourcepub fn error_name(self, input: impl Into<String>) -> Self
pub fn error_name(self, input: impl Into<String>) -> Self
The name of the error in the output.
Sourcepub fn set_error_name(self, input: Option<String>) -> Self
pub fn set_error_name(self, input: Option<String>) -> Self
The name of the error in the output.
Sourcepub fn get_error_name(&self) -> &Option<String>
pub fn get_error_name(&self) -> &Option<String>
The name of the error in the output.
Sourcepub fn error_value(self, input: impl Into<String>) -> Self
pub fn error_value(self, input: impl Into<String>) -> Self
The error value of the output.
Sourcepub fn set_error_value(self, input: Option<String>) -> Self
pub fn set_error_value(self, input: Option<String>) -> Self
The error value of the output.
Sourcepub fn get_error_value(&self) -> &Option<String>
pub fn get_error_value(&self) -> &Option<String>
The error value of the output.
Sourcepub fn traceback(self, input: impl Into<String>) -> Self
pub fn traceback(self, input: impl Into<String>) -> Self
Appends an item to traceback
.
To override the contents of this collection use set_traceback
.
The traceback of the output.
Sourcepub fn set_traceback(self, input: Option<Vec<String>>) -> Self
pub fn set_traceback(self, input: Option<Vec<String>>) -> Self
The traceback of the output.
Sourcepub fn get_traceback(&self) -> &Option<Vec<String>>
pub fn get_traceback(&self) -> &Option<Vec<String>>
The traceback of the output.
Sourcepub fn build(self) -> StatementOutput
pub fn build(self) -> StatementOutput
Consumes the builder and constructs a StatementOutput
.
Trait Implementations§
Source§impl Clone for StatementOutputBuilder
impl Clone for StatementOutputBuilder
Source§fn clone(&self) -> StatementOutputBuilder
fn clone(&self) -> StatementOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StatementOutputBuilder
impl Debug for StatementOutputBuilder
Source§impl Default for StatementOutputBuilder
impl Default for StatementOutputBuilder
Source§fn default() -> StatementOutputBuilder
fn default() -> StatementOutputBuilder
Source§impl PartialEq for StatementOutputBuilder
impl PartialEq for StatementOutputBuilder
impl StructuralPartialEq for StatementOutputBuilder
Auto Trait Implementations§
impl Freeze for StatementOutputBuilder
impl RefUnwindSafe for StatementOutputBuilder
impl Send for StatementOutputBuilder
impl Sync for StatementOutputBuilder
impl Unpin for StatementOutputBuilder
impl UnwindSafe for StatementOutputBuilder
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);