pub struct Store<T> { /* private fields */ }Implementations§
Source§impl<P: 'static> Store<P>
impl<P: 'static> Store<P>
pub fn new(path: impl AsRef<Path>, provider: P) -> Self
pub fn provider(&self) -> &P
Sourcepub fn barrier(&mut self)
pub fn barrier(&mut self)
Adds a barrier after which all resources will be run after those defined before.
Sourcepub fn resource<T>(
&mut self,
id: impl AsRef<str>,
local_definition: T,
) -> Result<StoreResource<T, T::Output>, Error>where
T: Resource<Provider = P>,
pub fn resource<T>(
&mut self,
id: impl AsRef<str>,
local_definition: T,
) -> Result<StoreResource<T, T::Output>, Error>where
T: Resource<Provider = P>,
Defines a resource.
Produces two graph nodes:
- Depending on the result of compairing
local_definitionto the one on file (if it exists), either:- creates the resource on the platform
- updates the resource on the platform
- loads the resource from a file
- Stores the resource to a file
To import an existing resource from a platform, use Store::import.
Sourcepub fn import<T>(
&mut self,
id: impl AsRef<str>,
local_definition: T,
) -> Result<StoreResource<T, T::Output>, Error>where
T: Resource<Provider = P>,
pub fn import<T>(
&mut self,
id: impl AsRef<str>,
local_definition: T,
) -> Result<StoreResource<T, T::Output>, Error>where
T: Resource<Provider = P>,
Defines a pre-existing resource, importing it from the platform.
Produces two graph nodes:
- Import the resource from the platform, resulting in the resource
- Store the value to a file
This only needs to be used once in your infrastructure command.
After the resource is imported and stored to a file it is recommended
you make a code change to use Store::resource.
Sourcepub fn load<T>(
&mut self,
id: impl AsRef<str>,
local_definition: T,
remote_definition: T::Output,
force_overwrite: bool,
) -> Result<StoreResource<T, T::Output>, Error>where
T: Resource<Provider = P>,
pub fn load<T>(
&mut self,
id: impl AsRef<str>,
local_definition: T,
remote_definition: T::Output,
force_overwrite: bool,
) -> Result<StoreResource<T, T::Output>, Error>where
T: Resource<Provider = P>,
Defines a pre-existing resource, directly writing it to file, without querying the platform.
Produces two graph nodes:
- Load the value (noop)
- Store the value
§Errors
Errs if force_overwrite is false and a stored resource already
exists. This is done to prevent accidental clobbering.
Sourcepub fn destroy<T>(
&mut self,
id: impl AsRef<str>,
) -> Result<DestroyResource<T>, Error>where
T: Resource<Provider = P>,
pub fn destroy<T>(
&mut self,
id: impl AsRef<str>,
) -> Result<DestroyResource<T>, Error>where
T: Resource<Provider = P>,
Destroys a resource.
pub fn after<T: Resource>(&mut self, resource: &StoreResource<T, T::Output>)
pub fn get_schedule_string(&self) -> Result<String, Error>
pub fn save_apply_graph(&self, path: impl AsRef<Path>) -> Result<(), Error>
pub async fn apply(&mut self) -> Result<(), Error>
Auto Trait Implementations§
impl<T> Freeze for Store<T>where
T: Freeze,
impl<T> !RefUnwindSafe for Store<T>
impl<T> !Send for Store<T>
impl<T> !Sync for Store<T>
impl<T> Unpin for Store<T>where
T: Unpin,
impl<T> !UnwindSafe for Store<T>
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> 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);