#[non_exhaustive]pub struct DescribeArchiveOutput {
pub archive_arn: Option<String>,
pub archive_name: Option<String>,
pub event_source_arn: Option<String>,
pub description: Option<String>,
pub event_pattern: Option<String>,
pub state: Option<ArchiveState>,
pub state_reason: Option<String>,
pub kms_key_identifier: Option<String>,
pub retention_days: Option<i32>,
pub size_bytes: i64,
pub event_count: i64,
pub creation_time: Option<DateTime>,
/* private fields */
}
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.archive_arn: Option<String>
The ARN of the archive.
archive_name: Option<String>
The name of the archive.
event_source_arn: Option<String>
The ARN of the event source associated with the archive.
description: Option<String>
The description of the archive.
event_pattern: Option<String>
The event pattern used to filter events sent to the archive.
state: Option<ArchiveState>
The state of the archive.
state_reason: Option<String>
The reason that the archive is in the state.
kms_key_identifier: Option<String>
The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
retention_days: Option<i32>
The number of days to retain events for in the archive.
size_bytes: i64
The size of the archive in bytes.
event_count: i64
The number of events in the archive.
creation_time: Option<DateTime>
The time at which the archive was created.
Implementations§
Source§impl DescribeArchiveOutput
impl DescribeArchiveOutput
Sourcepub fn archive_arn(&self) -> Option<&str>
pub fn archive_arn(&self) -> Option<&str>
The ARN of the archive.
Sourcepub fn archive_name(&self) -> Option<&str>
pub fn archive_name(&self) -> Option<&str>
The name of the archive.
Sourcepub fn event_source_arn(&self) -> Option<&str>
pub fn event_source_arn(&self) -> Option<&str>
The ARN of the event source associated with the archive.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the archive.
Sourcepub fn event_pattern(&self) -> Option<&str>
pub fn event_pattern(&self) -> Option<&str>
The event pattern used to filter events sent to the archive.
Sourcepub fn state(&self) -> Option<&ArchiveState>
pub fn state(&self) -> Option<&ArchiveState>
The state of the archive.
Sourcepub fn state_reason(&self) -> Option<&str>
pub fn state_reason(&self) -> Option<&str>
The reason that the archive is in the state.
Sourcepub fn kms_key_identifier(&self) -> Option<&str>
pub fn kms_key_identifier(&self) -> Option<&str>
The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
Sourcepub fn retention_days(&self) -> Option<i32>
pub fn retention_days(&self) -> Option<i32>
The number of days to retain events for in the archive.
Sourcepub fn size_bytes(&self) -> i64
pub fn size_bytes(&self) -> i64
The size of the archive in bytes.
Sourcepub fn event_count(&self) -> i64
pub fn event_count(&self) -> i64
The number of events in the archive.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The time at which the archive was created.
Source§impl DescribeArchiveOutput
impl DescribeArchiveOutput
Sourcepub fn builder() -> DescribeArchiveOutputBuilder
pub fn builder() -> DescribeArchiveOutputBuilder
Creates a new builder-style object to manufacture DescribeArchiveOutput
.
Trait Implementations§
Source§impl Clone for DescribeArchiveOutput
impl Clone for DescribeArchiveOutput
Source§fn clone(&self) -> DescribeArchiveOutput
fn clone(&self) -> DescribeArchiveOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribeArchiveOutput
impl Debug for DescribeArchiveOutput
Source§impl PartialEq for DescribeArchiveOutput
impl PartialEq for DescribeArchiveOutput
Source§impl RequestId for DescribeArchiveOutput
impl RequestId for DescribeArchiveOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeArchiveOutput
Auto Trait Implementations§
impl Freeze for DescribeArchiveOutput
impl RefUnwindSafe for DescribeArchiveOutput
impl Send for DescribeArchiveOutput
impl Sync for DescribeArchiveOutput
impl Unpin for DescribeArchiveOutput
impl UnwindSafe for DescribeArchiveOutput
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> 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>
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);