pub struct ConfigSource<T> { /* private fields */ }Expand description
Value and includes returned by a config source loader.
§Type Parameters
T: Loaded source value type.
Implementations§
Source§impl<T> ConfigSource<T>
Constructors and accessors for values returned by source loaders.
impl<T> ConfigSource<T>
Constructors and accessors for values returned by source loaders.
Sourcepub fn new(value: T, includes: Vec<PathBuf>) -> Self
pub fn new(value: T, includes: Vec<PathBuf>) -> Self
Creates a source from a loaded value and its declared include paths.
§Arguments
value: Loaded source value.includes: Include paths declared by the source.
§Returns
Returns a new ConfigSource.
§Examples
use std::path::PathBuf;
use rust_config_tree::ConfigSource;
let source = ConfigSource::new("value", vec![PathBuf::from("child.yaml")]);
assert_eq!(source.value(), &"value");
assert_eq!(source.includes(), &[PathBuf::from("child.yaml")]);Sourcepub fn includes(&self) -> &[PathBuf]
pub fn includes(&self) -> &[PathBuf]
Returns include paths declared by the source.
§Arguments
self: Source value being inspected.
§Returns
Returns the include paths declared by the source.
§Examples
use std::path::PathBuf;
use rust_config_tree::ConfigSource;
let source = ConfigSource::new("value", vec![PathBuf::from("child.yaml")]);
assert_eq!(source.includes(), &[PathBuf::from("child.yaml")]);Sourcepub fn into_parts(self) -> (T, Vec<PathBuf>)
pub fn into_parts(self) -> (T, Vec<PathBuf>)
Decomposes the source into its value and include paths.
§Arguments
self: Source value to decompose.
§Returns
Returns (value, includes).
§Examples
use std::path::PathBuf;
use rust_config_tree::ConfigSource;
let source = ConfigSource::new("value", vec![PathBuf::from("child.yaml")]);
assert_eq!(source.into_parts(), ("value", vec![PathBuf::from("child.yaml")]));Trait Implementations§
Source§impl<T: Clone> Clone for ConfigSource<T>
impl<T: Clone> Clone for ConfigSource<T>
Source§fn clone(&self) -> ConfigSource<T>
fn clone(&self) -> ConfigSource<T>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<T: Debug> Debug for ConfigSource<T>
impl<T: Debug> Debug for ConfigSource<T>
Source§impl<T> From<(T, Vec<PathBuf>)> for ConfigSource<T>
Converts the common (value, includes) loader shape into a source value.
impl<T> From<(T, Vec<PathBuf>)> for ConfigSource<T>
Converts the common (value, includes) loader shape into a source value.
Source§impl<T: PartialEq> PartialEq for ConfigSource<T>
impl<T: PartialEq> PartialEq for ConfigSource<T>
impl<T: Eq> Eq for ConfigSource<T>
impl<T> StructuralPartialEq for ConfigSource<T>
Auto Trait Implementations§
impl<T> Freeze for ConfigSource<T>where
T: Freeze,
impl<T> RefUnwindSafe for ConfigSource<T>where
T: RefUnwindSafe,
impl<T> Send for ConfigSource<T>where
T: Send,
impl<T> Sync for ConfigSource<T>where
T: Sync,
impl<T> Unpin for ConfigSource<T>where
T: Unpin,
impl<T> UnsafeUnpin for ConfigSource<T>where
T: UnsafeUnpin,
impl<T> UnwindSafe for ConfigSource<T>where
T: UnwindSafe,
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);