Struct Volume 

pub struct Volume {
    pub metadata: MetaData,
    pub separation_context: SclName,
    pub size_mib: u64,
    pub status: VolumeStatus,
    pub url: Option<Url>,
}

Fields

metadata: MetaData

separation_context: SclName

Separation context which the volume is belonging to.

size_mib: u64

Size in mebibyte reserved for the volume.

status: VolumeStatus

Latest status of the volume. Does not need to be specified by the user when creating (POST), as it is initialized with the default values.

url: Option<Url>

Optional URL pointing to initial data that should be copied into the new volume. Make sure that the size_mib is at least as large as the required disk space.

Implementations

impl Volume

pub fn file_path(&self, root: &Path) -> PathBuf

Returns the path where the volume file should be stored.

Convenience wrapper around derive_volume_file_path, see its documentation for more information.

Example

use crate::scl_lib::api_objects::{MetaData, SclName, Volume, derive_volume_file_path};
use std::path::Path;
use scl_lib::api_objects::SclObject;

let vol = Volume {
    separation_context: SclName::try_from("sc01".to_string()).unwrap(),
    metadata: MetaData::new(SclName::try_from("vol01".to_string()).unwrap()),
    size_mib: 100,
    status: Default::default(),
    url: None,
};
let root = Path::new("/tmp/scl");
assert_eq!(vol.file_path(&root).as_path(), Path::new("/tmp/scl/sc01/volumes/vol01"));
assert_eq!(vol.file_path(&root), derive_volume_file_path(&root, &vol.separation_context, vol.name()))

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 Ord for Volume

fn cmp(&self, other: &Volume) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Volume

fn eq(&self, other: &Volume) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Volume

fn partial_cmp(&self, other: &Volume) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SclObject for Volume

const PREFIX: &'static str = "/volumes"

Prefix for all Volumes ("/volumes").

fn name(&self) -> &SclName

Returns the SclName of the SclObject.

fn separation_context(&self) -> Option<&SclName>

Returns the SclName of the separation context if the SclObject is connected to one, otherwise default None.

fn metadata(&self) -> &MetaData

Providing access to MetaData is essential for our optimistic concurrency control.

fn metadata_mut(&mut self) -> &mut MetaData

Providing access to MetaData is essential for our optimistic concurrency control.

fn referenced_db_keys(&self) -> Vec<String>

Returns all DB keys the object is referencing / depending on.

fn validate_fields_before_create(&self) -> Result<()>

Checks if all fields (except references to other SclObjects) are legal initial fields. Should be called before a create operation.

fn validate_fields_before_update( current_db_state: &Self, proposed_new_state: &Self, ) -> Result<()>

Checks if a proposed updated is valid. Should be called before a regular (not related to finalizers / deletion) update operation.

fn uuid(&self) -> Uuid

fn api_endpoint<'a>( sc: impl Into<Option<&'a str>>, name: impl Into<Option<&'a str>>, ) -> String

Returns the API endpoint for a SclObject.

fn get_api_endpoint(&self) -> String

Returns the API endpoint of the SclObject.

fn db_key<'a>( sc: impl Into<Option<&'a str>>, name: impl Into<Option<&'a str>>, ) -> String

Returns the database key for a SclObject.

fn get_db_key(&self) -> String

Returns the database key of the SclObject.

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.

impl Eq for Volume

impl StructuralPartialEq for Volume