Struct Volume

pub struct Volume { /* private fields */ }

Block Storage volumes provide expanded storage capacity for your Droplets and can be moved between Droplets within a specific region. Volumes function as raw block devices, meaning they appear to the operating system as locally attached storage which can be formatted using any file system supported by the OS. They may be created in sizes from 1GiB to 16TiB.

Digital Ocean Documentation.

Implementations

impl Volume

pub fn id(&self) -> &String

The unique identifier for the Block Storage volume.

pub fn region(&self) -> &Region

The region that the Block Storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a Block Storage volume, the entire region object will be returned.

pub fn droplet_ids(&self) -> &Vec<usize>

An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.

pub fn name(&self) -> &String

A human-readable name for the Block Storage volume. Must be lowercase and be composed only of numbers, letters and “-”, up to a limit of 64 characters.

pub fn description(&self) -> &String

An optional free-form text field to describe a Block Storage volume.

pub fn size_gigabytes(&self) -> &f32

The size of the Block Storage volume in GiB (1024^3).

pub fn created_at(&self) -> &DateTime<Utc>

A time value given in ISO8601 combined date and time format that represents when the Block Storage volume was created.

impl Volume

pub fn list() -> VolumeRequest<List, Vec<Volume>>

Digital Ocean Documentation.

pub fn create<S>( name: S, size_gigabytes: usize, ) -> VolumeRequest<Create, Volume>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn get<S: AsRef<str> + Serialize + Display>( id: S, ) -> VolumeRequest<Get, Volume>

Digital Ocean Documentation.

pub fn get_by_name<S>(name: S, region: S) -> VolumeRequest<Get, Volume>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn delete<S: AsRef<str> + Serialize + Display>( id: S, ) -> VolumeRequest<Delete, ()>

Digital Ocean Documentation.

pub fn delete_by_name<S>(name: S, region: S) -> VolumeRequest<Delete, ()>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

impl Volume

pub fn attach<S>( volume_name: S, droplet: usize, ) -> VolumeActionRequest<Create, Action>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

pub fn detach<S>( volume_name: S, droplet: usize, ) -> VolumeActionRequest<Create, Action>

where S: AsRef<str> + Serialize + Display,

Digital Ocean Documentation.

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Volume

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Volume

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasResponse for Volume

type Response = VolumeResponse

impl Serialize for Volume

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.