#[non_exhaustive]pub struct WorkflowStep {
pub type: Option<WorkflowStepType>,
pub copy_step_details: Option<CopyStepDetails>,
pub custom_step_details: Option<CustomStepDetails>,
pub delete_step_details: Option<DeleteStepDetails>,
pub tag_step_details: Option<TagStepDetails>,
pub decrypt_step_details: Option<DecryptStepDetails>,
}
Expand description
The basic building block of a workflow.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.type: Option<WorkflowStepType>
Currently, the following step types are supported.
-
COPY
- Copy the file to another location. -
CUSTOM
- Perform a custom step with an Lambda function target. -
DECRYPT
- Decrypt a file that was encrypted before it was uploaded. -
DELETE
- Delete the file. -
TAG
- Add a tag to the file.
copy_step_details: Option<CopyStepDetails>
Details for a step that performs a file copy.
Consists of the following values:
-
A description
-
An Amazon S3 location for the destination of the file copy.
-
A flag that indicates whether to overwrite an existing file of the same name. The default is
FALSE
.
custom_step_details: Option<CustomStepDetails>
Details for a step that invokes an Lambda function.
Consists of the Lambda function's name, target, and timeout (in seconds).
delete_step_details: Option<DeleteStepDetails>
Details for a step that deletes the file.
tag_step_details: Option<TagStepDetails>
Details for a step that creates one or more tags.
You specify one or more tags. Each tag contains a key-value pair.
decrypt_step_details: Option<DecryptStepDetails>
Details for a step that decrypts an encrypted file.
Consists of the following values:
-
A descriptive name
-
An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
-
An S3 or Amazon EFS location for the destination of the file decryption.
-
A flag that indicates whether to overwrite an existing file of the same name. The default is
FALSE
. -
The type of encryption that's used. Currently, only PGP encryption is supported.
Implementations§
Source§impl WorkflowStep
impl WorkflowStep
Sourcepub fn type(&self) -> Option<&WorkflowStepType>
pub fn type(&self) -> Option<&WorkflowStepType>
Currently, the following step types are supported.
-
COPY
- Copy the file to another location. -
CUSTOM
- Perform a custom step with an Lambda function target. -
DECRYPT
- Decrypt a file that was encrypted before it was uploaded. -
DELETE
- Delete the file. -
TAG
- Add a tag to the file.
Sourcepub fn copy_step_details(&self) -> Option<&CopyStepDetails>
pub fn copy_step_details(&self) -> Option<&CopyStepDetails>
Details for a step that performs a file copy.
Consists of the following values:
-
A description
-
An Amazon S3 location for the destination of the file copy.
-
A flag that indicates whether to overwrite an existing file of the same name. The default is
FALSE
.
Sourcepub fn custom_step_details(&self) -> Option<&CustomStepDetails>
pub fn custom_step_details(&self) -> Option<&CustomStepDetails>
Details for a step that invokes an Lambda function.
Consists of the Lambda function's name, target, and timeout (in seconds).
Sourcepub fn delete_step_details(&self) -> Option<&DeleteStepDetails>
pub fn delete_step_details(&self) -> Option<&DeleteStepDetails>
Details for a step that deletes the file.
Sourcepub fn tag_step_details(&self) -> Option<&TagStepDetails>
pub fn tag_step_details(&self) -> Option<&TagStepDetails>
Details for a step that creates one or more tags.
You specify one or more tags. Each tag contains a key-value pair.
Sourcepub fn decrypt_step_details(&self) -> Option<&DecryptStepDetails>
pub fn decrypt_step_details(&self) -> Option<&DecryptStepDetails>
Details for a step that decrypts an encrypted file.
Consists of the following values:
-
A descriptive name
-
An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
-
An S3 or Amazon EFS location for the destination of the file decryption.
-
A flag that indicates whether to overwrite an existing file of the same name. The default is
FALSE
. -
The type of encryption that's used. Currently, only PGP encryption is supported.
Source§impl WorkflowStep
impl WorkflowStep
Sourcepub fn builder() -> WorkflowStepBuilder
pub fn builder() -> WorkflowStepBuilder
Creates a new builder-style object to manufacture WorkflowStep
.
Trait Implementations§
Source§impl Clone for WorkflowStep
impl Clone for WorkflowStep
Source§fn clone(&self) -> WorkflowStep
fn clone(&self) -> WorkflowStep
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for WorkflowStep
impl Debug for WorkflowStep
Source§impl PartialEq for WorkflowStep
impl PartialEq for WorkflowStep
impl StructuralPartialEq for WorkflowStep
Auto Trait Implementations§
impl Freeze for WorkflowStep
impl RefUnwindSafe for WorkflowStep
impl Send for WorkflowStep
impl Sync for WorkflowStep
impl Unpin for WorkflowStep
impl UnwindSafe for WorkflowStep
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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> 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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);