Struct Volume 

pub struct Volume {
    pub volume_id: String,
    pub name: String,
    pub token: Option<String>,
    /* private fields */
}

Persistent volume that can be mounted into sandboxes and edited while detached.

Fields

volume_id: String

Volume id.

name: String

Volume name.

token: Option<String>

Volume access token returned by the API.

Implementations

impl Volume

pub async fn create( name: impl Into<String>, opts: VolumeCreateOptions, ) -> Result<Self>

Create a persistent volume and return a connected SDK object.

pub async fn connect( volume_id: impl ToString, connection: ConnectionOptions, ) -> Result<Self>

Connect to an existing volume by id or name.

pub async fn get_info_by_id( volume_id: impl ToString, connection: ConnectionOptions, ) -> Result<VolumeInfo>

Fetch metadata for an existing volume by id or name.

pub async fn list(opts: VolumeListOptions) -> Result<Vec<VolumeInfo>>

List volumes visible to the configured API key.

pub async fn destroy_by_id( volume_id: impl ToString, connection: ConnectionOptions, ) -> Result<bool>

Destroy a volume by id or name. Returns false when it does not exist.

pub async fn get_info(&self) -> Result<VolumeInfo>

Fetch this volume metadata.

pub async fn get_path_info( &self, path: impl AsRef<str>, ) -> Result<VolumeEntryStat>

Fetch metadata for a path inside this volume.

pub async fn list_files( &self, path: impl AsRef<str>, depth: Option<u64>, ) -> Result<Vec<VolumeEntryStat>>

List files and directories under path.

pub async fn make_dir( &self, path: impl Into<String>, opts: VolumeWriteOptions, ) -> Result<VolumeEntryStat>

Create a directory inside the detached volume.

pub async fn exists(&self, path: impl AsRef<str>) -> Result<bool>

Return whether a path exists inside the detached volume.

pub async fn update_metadata( &self, path: impl Into<String>, opts: VolumeWriteOptions, ) -> Result<VolumeEntryStat>

Update ownership or mode metadata for a path.

pub async fn read_file(&self, path: impl AsRef<str>) -> Result<Vec<u8>>

Read a file from the detached volume as bytes.

pub async fn write_file( &self, path: impl Into<String>, data: impl AsRef<[u8]>, opts: VolumeWriteOptions, ) -> Result<VolumeEntryStat>

Write a file into the detached volume.

pub async fn remove(&self, path: impl AsRef<str>) -> Result<bool>

Remove a file or directory from the detached volume.

pub async fn destroy(&self) -> Result<bool>

Destroy this volume.

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.