pub struct JSONGetTextBuilder<'a> { /* private fields */ }Expand description
To build a JSONGetText instance, this struct can help you do that step by step.
Implementations§
Source§impl<'a> JSONGetTextBuilder<'a>
impl<'a> JSONGetTextBuilder<'a>
Sourcepub fn new<K: IntoKey>(default_key: K) -> JSONGetTextBuilder<'a>
pub fn new<K: IntoKey>(default_key: K) -> JSONGetTextBuilder<'a>
Create a new JSONGetTextBuilder instance. You need to decide your default key at this stage.
Sourcepub fn allow_extra_texts(&mut self, allow: bool) -> &mut Self
pub fn allow_extra_texts(&mut self, allow: bool) -> &mut Self
Set whether a non-default key may contain texts that the default key does not define.
When enabled, such texts are dropped while building instead of causing a TextInKeyNotInDefaultKey error.
Sourcepub fn add_json<K: IntoKey, J: AsRef<str> + ?Sized>(
&mut self,
key: K,
json: &'a J,
) -> Result<&mut Self, JSONGetTextBuildError>
pub fn add_json<K: IntoKey, J: AsRef<str> + ?Sized>( &mut self, key: K, json: &'a J, ) -> Result<&mut Self, JSONGetTextBuildError>
Add a JSON string to the context for a specific key. The JSON string must represent a map object (key-value).
Sourcepub fn add_json_owned<K: IntoKey, J: AsRef<str>>(
&mut self,
key: K,
json: J,
) -> Result<&mut Self, JSONGetTextBuildError>
pub fn add_json_owned<K: IntoKey, J: AsRef<str>>( &mut self, key: K, json: J, ) -> Result<&mut Self, JSONGetTextBuildError>
Add a JSON string to the context for a specific key. The JSON string must represent a map object (key-value).
Sourcepub fn add_json_file<K: IntoKey, P: AsRef<Path>>(
&mut self,
key: K,
path: P,
) -> Result<&mut Self, JSONGetTextBuildError>
pub fn add_json_file<K: IntoKey, P: AsRef<Path>>( &mut self, key: K, path: P, ) -> Result<&mut Self, JSONGetTextBuildError>
Add a JSON file to the context for a specific key. The JSON file must represent a map object (key-value).
Sourcepub fn add_serialize<K: IntoKey, S: Serialize>(
&mut self,
key: K,
value: S,
) -> Result<&mut Self, JSONGetTextBuildError>
pub fn add_serialize<K: IntoKey, S: Serialize>( &mut self, key: K, value: S, ) -> Result<&mut Self, JSONGetTextBuildError>
Add any serializable value to the context for a specific key. The value must represent a map object (key-value).
Sourcepub fn add_map<K: IntoKey>(
&mut self,
key: K,
map: HashMap<String, JSONGetTextValue<'a>>,
) -> Result<&mut Self, JSONGetTextBuildError>
pub fn add_map<K: IntoKey>( &mut self, key: K, map: HashMap<String, JSONGetTextValue<'a>>, ) -> Result<&mut Self, JSONGetTextBuildError>
Add a map to the context.
Sourcepub fn build(self) -> Result<JSONGetText<'a>, JSONGetTextBuildError>
pub fn build(self) -> Result<JSONGetText<'a>, JSONGetTextBuildError>
Build a JSONGetText instance.
Trait Implementations§
Source§impl<'a> Clone for JSONGetTextBuilder<'a>
impl<'a> Clone for JSONGetTextBuilder<'a>
Source§fn clone(&self) -> JSONGetTextBuilder<'a>
fn clone(&self) -> JSONGetTextBuilder<'a>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'a> Debug for JSONGetTextBuilder<'a>
impl<'a> Debug for JSONGetTextBuilder<'a>
Source§impl<'a> From<Key> for JSONGetTextBuilder<'a>
impl<'a> From<Key> for JSONGetTextBuilder<'a>
Source§fn from(v: Key) -> JSONGetTextBuilder<'a>
fn from(v: Key) -> JSONGetTextBuilder<'a>
Auto Trait Implementations§
impl<'a> Freeze for JSONGetTextBuilder<'a>
impl<'a> RefUnwindSafe for JSONGetTextBuilder<'a>
impl<'a> Send for JSONGetTextBuilder<'a>
impl<'a> Sync for JSONGetTextBuilder<'a>
impl<'a> Unpin for JSONGetTextBuilder<'a>
impl<'a> UnsafeUnpin for JSONGetTextBuilder<'a>
impl<'a> UnwindSafe for JSONGetTextBuilder<'a>
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> 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>
renamed to 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);