#[non_exhaustive]pub struct Disk {Show 18 fields
pub name: Option<String>,
pub arn: Option<String>,
pub support_code: Option<String>,
pub created_at: Option<DateTime>,
pub location: Option<ResourceLocation>,
pub resource_type: Option<ResourceType>,
pub tags: Option<Vec<Tag>>,
pub add_ons: Option<Vec<AddOn>>,
pub size_in_gb: Option<i32>,
pub is_system_disk: Option<bool>,
pub iops: Option<i32>,
pub path: Option<String>,
pub state: Option<DiskState>,
pub attached_to: Option<String>,
pub is_attached: Option<bool>,
pub attachment_state: Option<String>,
pub gb_in_use: Option<i32>,
pub auto_mount_status: Option<AutoMountStatus>,
}Expand description
Describes a block storage disk.
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.name: Option<String>The unique name of the disk.
arn: Option<String>The Amazon Resource Name (ARN) of the disk.
support_code: Option<String>The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
created_at: Option<DateTime>The date when the disk was created.
location: Option<ResourceLocation>The AWS Region and Availability Zone where the disk is located.
resource_type: Option<ResourceType>The Lightsail resource type (Disk).
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
add_ons: Option<Vec<AddOn>>An array of objects representing the add-ons enabled on the disk.
size_in_gb: Option<i32>The size of the disk in GB.
is_system_disk: Option<bool>A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
iops: Option<i32>The input/output operations per second (IOPS) of the disk.
path: Option<String>The disk path.
state: Option<DiskState>Describes the status of the disk.
attached_to: Option<String>The resources to which the disk is attached.
is_attached: Option<bool>A Boolean value indicating whether the disk is attached.
attachment_state: Option<String>(Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.
gb_in_use: Option<i32>(Discontinued) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
auto_mount_status: Option<AutoMountStatus>The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
Implementations§
Source§impl Disk
impl Disk
Sourcepub fn support_code(&self) -> Option<&str>
pub fn support_code(&self) -> Option<&str>
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The date when the disk was created.
Sourcepub fn location(&self) -> Option<&ResourceLocation>
pub fn location(&self) -> Option<&ResourceLocation>
The AWS Region and Availability Zone where the disk is located.
Sourcepub fn resource_type(&self) -> Option<&ResourceType>
pub fn resource_type(&self) -> Option<&ResourceType>
The Lightsail resource type (Disk).
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
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 add_ons(&self) -> &[AddOn]
pub fn add_ons(&self) -> &[AddOn]
An array of objects representing the add-ons enabled on the disk.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .add_ons.is_none().
Sourcepub fn size_in_gb(&self) -> Option<i32>
pub fn size_in_gb(&self) -> Option<i32>
The size of the disk in GB.
Sourcepub fn is_system_disk(&self) -> Option<bool>
pub fn is_system_disk(&self) -> Option<bool>
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
Sourcepub fn attached_to(&self) -> Option<&str>
pub fn attached_to(&self) -> Option<&str>
The resources to which the disk is attached.
Sourcepub fn is_attached(&self) -> Option<bool>
pub fn is_attached(&self) -> Option<bool>
A Boolean value indicating whether the disk is attached.
Sourcepub fn attachment_state(&self) -> Option<&str>
👎Deprecated
pub fn attachment_state(&self) -> Option<&str>
(Discontinued) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.
Sourcepub fn gb_in_use(&self) -> Option<i32>
👎Deprecated
pub fn gb_in_use(&self) -> Option<i32>
(Discontinued) The number of GB in use by the disk.
In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
Sourcepub fn auto_mount_status(&self) -> Option<&AutoMountStatus>
pub fn auto_mount_status(&self) -> Option<&AutoMountStatus>
The status of automatically mounting a storage disk to a virtual computer.
This parameter only applies to Lightsail for Research resources.
Trait Implementations§
impl StructuralPartialEq for Disk
Auto Trait Implementations§
impl Freeze for Disk
impl RefUnwindSafe for Disk
impl Send for Disk
impl Sync for Disk
impl Unpin for Disk
impl UnwindSafe for Disk
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);