pub struct ScaffoldConfig { /* private fields */ }Expand description
Validated scaffolding configuration for all five built-in targets.
Parse with ScaffoldConfig::from_project_toml; look a target up with
ScaffoldConfig::target.
Implementations§
Source§impl ScaffoldConfig
impl ScaffoldConfig
Sourcepub fn target(&self, target: &str) -> Option<&TargetScaffoldConfig>
pub fn target(&self, target: &str) -> Option<&TargetScaffoldConfig>
Returns the validated config for target ("js", "ts", "python",
"rust", "go"; aliases "javascript"/"typescript"/"py"/"rs"/
"golang" accepted), or None for an unknown target id.
Sourcepub fn from_project_toml(source: &str) -> Result<Self, ScaffoldError>
pub fn from_project_toml(source: &str) -> Result<Self, ScaffoldError>
Parses + validates the per-target tables in a bock.project document.
Recognizes [targets.<T>] (deep) and [targets.<T>.scaffolding]
(shallow) for the five built-in targets and validates each supplied
value against the §20.6.2 matrix. A missing [targets] table (or a
missing per-target table) yields all-None config — defaults are
applied later, not here.
§Errors
ScaffoldError::Parsewhen the document is not valid TOML or a field has the wrong type.ScaffoldError::UnknownValuewhen a field is set to a value outside the documented options for that target.ScaffoldError::NotConfigurablewhen a universal field (Rust/Goformatter/test_framework) is supplied.
Sourcepub fn from_project_toml_with_name(
source: &str,
) -> Result<(Self, Option<String>), ScaffoldError>
pub fn from_project_toml_with_name( source: &str, ) -> Result<(Self, Option<String>), ScaffoldError>
Like Self::from_project_toml but also returns the [project] name
from the same document, if present. Saves callers (the build driver) a
second TOML parse and keeps the toml/serde dependency in this crate.
§Errors
Same as Self::from_project_toml.
Trait Implementations§
Source§impl Clone for ScaffoldConfig
impl Clone for ScaffoldConfig
Source§fn clone(&self) -> ScaffoldConfig
fn clone(&self) -> ScaffoldConfig
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ScaffoldConfig
impl Debug for ScaffoldConfig
Source§impl Default for ScaffoldConfig
impl Default for ScaffoldConfig
Source§fn default() -> ScaffoldConfig
fn default() -> ScaffoldConfig
impl Eq for ScaffoldConfig
Source§impl PartialEq for ScaffoldConfig
impl PartialEq for ScaffoldConfig
Source§fn eq(&self, other: &ScaffoldConfig) -> bool
fn eq(&self, other: &ScaffoldConfig) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for ScaffoldConfig
Auto Trait Implementations§
impl Freeze for ScaffoldConfig
impl RefUnwindSafe for ScaffoldConfig
impl Send for ScaffoldConfig
impl Sync for ScaffoldConfig
impl Unpin for ScaffoldConfig
impl UnsafeUnpin for ScaffoldConfig
impl UnwindSafe for ScaffoldConfig
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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.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> 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);