#[non_exhaustive]pub struct Volume {Show 19 fields
pub outpost_arn: Option<String>,
pub iops: Option<i32>,
pub tags: Option<Vec<Tag>>,
pub volume_type: Option<VolumeType>,
pub fast_restored: Option<bool>,
pub multi_attach_enabled: Option<bool>,
pub throughput: Option<i32>,
pub sse_type: Option<SseType>,
pub operator: Option<OperatorResponse>,
pub volume_initialization_rate: Option<i32>,
pub volume_id: Option<String>,
pub size: Option<i32>,
pub snapshot_id: Option<String>,
pub availability_zone: Option<String>,
pub state: Option<VolumeState>,
pub create_time: Option<DateTime>,
pub attachments: Option<Vec<VolumeAttachment>>,
pub encrypted: Option<bool>,
pub kms_key_id: Option<String>,
}
Expand description
Describes a volume.
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.outpost_arn: Option<String>
The Amazon Resource Name (ARN) of the Outpost.
iops: Option<i32>
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Any tags assigned to the volume.
volume_type: Option<VolumeType>
The volume type.
fast_restored: Option<bool>
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
multi_attach_enabled: Option<bool>
Indicates whether Amazon EBS Multi-Attach is enabled.
throughput: Option<i32>
The throughput that the volume supports, in MiB/s.
sse_type: Option<SseType>
This parameter is not returned by CreateVolume.
Reserved for future use.
operator: Option<OperatorResponse>
The service provider that manages the volume.
volume_initialization_rate: Option<i32>
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null
.
volume_id: Option<String>
The ID of the volume.
size: Option<i32>
The size of the volume, in GiBs.
snapshot_id: Option<String>
The snapshot from which the volume was created, if applicable.
availability_zone: Option<String>
The Availability Zone for the volume.
state: Option<VolumeState>
The volume state.
create_time: Option<DateTime>
The time stamp when volume creation was initiated.
attachments: Option<Vec<VolumeAttachment>>
This parameter is not returned by CreateVolume.
Information about the volume attachments.
encrypted: Option<bool>
Indicates whether the volume is encrypted.
kms_key_id: Option<String>
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
Implementations§
Source§impl Volume
impl Volume
Sourcepub fn outpost_arn(&self) -> Option<&str>
pub fn outpost_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Outpost.
Sourcepub fn iops(&self) -> Option<i32>
pub fn iops(&self) -> Option<i32>
The number of I/O operations per second (IOPS). For gp3
, io1
, and io2
volumes, this represents the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Any tags assigned to the volume.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn volume_type(&self) -> Option<&VolumeType>
pub fn volume_type(&self) -> Option<&VolumeType>
The volume type.
Sourcepub fn fast_restored(&self) -> Option<bool>
pub fn fast_restored(&self) -> Option<bool>
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
Sourcepub fn multi_attach_enabled(&self) -> Option<bool>
pub fn multi_attach_enabled(&self) -> Option<bool>
Indicates whether Amazon EBS Multi-Attach is enabled.
Sourcepub fn throughput(&self) -> Option<i32>
pub fn throughput(&self) -> Option<i32>
The throughput that the volume supports, in MiB/s.
Sourcepub fn sse_type(&self) -> Option<&SseType>
pub fn sse_type(&self) -> Option<&SseType>
This parameter is not returned by CreateVolume.
Reserved for future use.
Sourcepub fn operator(&self) -> Option<&OperatorResponse>
pub fn operator(&self) -> Option<&OperatorResponse>
The service provider that manages the volume.
Sourcepub fn volume_initialization_rate(&self) -> Option<i32>
pub fn volume_initialization_rate(&self) -> Option<i32>
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null
.
Sourcepub fn snapshot_id(&self) -> Option<&str>
pub fn snapshot_id(&self) -> Option<&str>
The snapshot from which the volume was created, if applicable.
Sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The Availability Zone for the volume.
Sourcepub fn state(&self) -> Option<&VolumeState>
pub fn state(&self) -> Option<&VolumeState>
The volume state.
Sourcepub fn create_time(&self) -> Option<&DateTime>
pub fn create_time(&self) -> Option<&DateTime>
The time stamp when volume creation was initiated.
Sourcepub fn attachments(&self) -> &[VolumeAttachment]
pub fn attachments(&self) -> &[VolumeAttachment]
This parameter is not returned by CreateVolume.
Information about the volume attachments.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments.is_none()
.
Sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
Trait Implementations§
impl StructuralPartialEq for Volume
Auto Trait Implementations§
impl Freeze for Volume
impl RefUnwindSafe for Volume
impl Send for Volume
impl Sync for Volume
impl Unpin for Volume
impl UnwindSafe for Volume
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);