pub struct ContextBuilder { /* private fields */ }Expand description
A Type that knows how to construct a Context.
Implementations§
Source§impl ContextBuilder
impl ContextBuilder
Sourcepub fn registration(self, val: &str) -> Result<Self, DataError>
pub fn registration(self, val: &str) -> Result<Self, DataError>
Set the registration field from an &str.
Raise DataError if the input string is empty.
Sourcepub fn registration_uuid(self, uuid: Uuid) -> Result<Self, DataError>
pub fn registration_uuid(self, uuid: Uuid) -> Result<Self, DataError>
Set the registration field from a UUID value.
Raise DataError if the input string is empty.
Sourcepub fn instructor(self, val: Actor) -> Result<Self, DataError>
pub fn instructor(self, val: Actor) -> Result<Self, DataError>
Sourcepub fn context_activities(
self,
val: ContextActivities,
) -> Result<Self, DataError>
pub fn context_activities( self, val: ContextActivities, ) -> Result<Self, DataError>
Set the context_activities field.
Raise DataError if the ContextActivities argument is invalid.
Sourcepub fn context_agent(self, val: ContextAgent) -> Result<Self, DataError>
pub fn context_agent(self, val: ContextAgent) -> Result<Self, DataError>
Add a ContextAgent to context_agents field.
Raise DataError if the ContextAgent argument is invalid.
Sourcepub fn context_group(self, val: ContextGroup) -> Result<Self, DataError>
pub fn context_group(self, val: ContextGroup) -> Result<Self, DataError>
Add a ContextGroup to context_groups field.
Raise DataError if the ContextGroup argument is invalid.
Sourcepub fn revision<S: Deref<Target = str>>(self, val: S) -> Result<Self, DataError>
pub fn revision<S: Deref<Target = str>>(self, val: S) -> Result<Self, DataError>
Set the revision field.
Raise DataError if the input string is empty.
Sourcepub fn platform<S: Deref<Target = str>>(self, val: S) -> Result<Self, DataError>
pub fn platform<S: Deref<Target = str>>(self, val: S) -> Result<Self, DataError>
Set the platform field.
Raise DataError if the input string is empty.
Sourcepub fn language<S: Deref<Target = str>>(self, val: S) -> Result<Self, DataError>
pub fn language<S: Deref<Target = str>>(self, val: S) -> Result<Self, DataError>
Set the language field.
Raise DataError if the input string is empty.
Sourcepub fn statement(self, val: StatementRef) -> Result<Self, DataError>
pub fn statement(self, val: StatementRef) -> Result<Self, DataError>
Set the statement field from given StatementRef instance.
Raise DataError if the argument is invalid.
Sourcepub fn statement_uuid(self, uuid: Uuid) -> Result<Self, DataError>
pub fn statement_uuid(self, uuid: Uuid) -> Result<Self, DataError>
Set the statement field from a Statement’s UUID.
Raise DataError if the argument is invalid.
Sourcepub fn extension(self, key: &str, value: &Value) -> Result<Self, DataError>
pub fn extension(self, key: &str, value: &Value) -> Result<Self, DataError>
Add to extensions an entry w/ (key, value) pair.
Raise DataError if the key is empty.
Sourcepub fn with_extensions(self, map: Extensions) -> Result<Self, DataError>
pub fn with_extensions(self, map: Extensions) -> Result<Self, DataError>
Set (as in replace) the extensions property of this instance w/ the
given argument.
Trait Implementations§
Source§impl Debug for ContextBuilder
impl Debug for ContextBuilder
Source§impl Default for ContextBuilder
impl Default for ContextBuilder
Source§fn default() -> ContextBuilder
fn default() -> ContextBuilder
Auto Trait Implementations§
impl Freeze for ContextBuilder
impl RefUnwindSafe for ContextBuilder
impl Send for ContextBuilder
impl Sync for ContextBuilder
impl Unpin for ContextBuilder
impl UnwindSafe for ContextBuilder
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> 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> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
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);