Enum CloudCreateSandboxRequest 

pub enum CloudCreateSandboxRequest {
    Oci {
        sandbox: CloudSandboxSpec,
        reference: String,
        resources: CloudSandboxResources,
        patches: Vec<CloudPatch>,
        pull_policy: CloudPullPolicy,
    },
    Bind {
        sandbox: CloudSandboxSpec,
        path: PathBuf,
        resources: CloudSandboxComputeResources,
        patches: Vec<CloudPatch>,
    },
    DiskImage {
        sandbox: CloudSandboxSpec,
        path: PathBuf,
        format: CloudDiskImageFormat,
        fstype: Option<String>,
        resources: CloudSandboxComputeResources,
        patches: Vec<CloudPatch>,
    },
    DiskSnapshot {
        sandbox: CloudSandboxSpec,
        disk_snapshot_ref: CloudSnapshotLocation,
        resources: CloudSandboxComputeResources,
        pull_policy: CloudPullPolicy,
    },
}

Wire shape of a cloud sandbox create request body.

Each root filesystem origin is a distinct source variant. The common sandbox settings remain flat beside the source-specific fields. Legacy requests carrying an image object are accepted during migration.

Variants

Oci

Create a sandbox from an OCI image.

Fields

sandbox: CloudSandboxSpec

Settings shared by every sandbox source.

reference: String

OCI image reference.

resources: CloudSandboxResources

CPU, memory, and writable-disk resources.

patches: Vec<CloudPatch>

Rootfs patches applied before VM start.

pull_policy: CloudPullPolicy

OCI image pull policy.

Bind

Create a sandbox from a host directory.

Fields

sandbox: CloudSandboxSpec

Settings shared by every sandbox source.

path: PathBuf

Host directory used as the root filesystem.

resources: CloudSandboxComputeResources

CPU and memory resources.

patches: Vec<CloudPatch>

Rootfs patches applied before VM start.

DiskImage

Create a sandbox from a disk image file.

Fields

sandbox: CloudSandboxSpec

Settings shared by every sandbox source.

path: PathBuf

Host path to the disk image.

format: CloudDiskImageFormat

Disk image format.

fstype: Option<String>

Inner filesystem type, when it cannot be detected automatically.

resources: CloudSandboxComputeResources

CPU and memory resources.

patches: Vec<CloudPatch>

Rootfs patches applied before VM start.

DiskSnapshot

Create a fresh-booted sandbox from a disk snapshot.

Fields

sandbox: CloudSandboxSpec

Settings shared by every sandbox source.

disk_snapshot_ref: CloudSnapshotLocation

Disk snapshot to restore.

resources: CloudSandboxComputeResources

CPU and memory resources.

pull_policy: CloudPullPolicy

Pull policy used if the snapshot’s pinned base image must be fetched.

Implementations

impl CloudCreateSandboxRequest

pub const fn sandbox_spec(&self) -> &CloudSandboxSpec

Return settings shared by every sandbox source.

pub const fn sandbox_spec_mut(&mut self) -> &mut CloudSandboxSpec

Return mutable settings shared by every sandbox source.

pub const fn disk_snapshot_ref(&self) -> Option<&CloudSnapshotLocation>

Return the disk snapshot reference, when restoring one.

pub fn oci_reference(&self) -> Option<&str>

Return the OCI image reference, when creating from OCI.

pub const fn compute_resources(&self) -> CloudSandboxComputeResources

Return the requested CPU and memory resources.

pub const fn oci_disk_size_mib(&self) -> Option<Option<u32>>

Return the requested OCI writable-disk size, if this is an OCI source.

pub fn set_oci_disk_size_mib(&mut self, disk_size_mib: u32) -> bool

Set the OCI writable-disk size, returning whether this is an OCI source.

Trait Implementations

impl Clone for CloudCreateSandboxRequest

fn clone(&self) -> CloudCreateSandboxRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloudCreateSandboxRequest

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

Formats the value using the given formatter.

impl Default for CloudCreateSandboxRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CloudCreateSandboxRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SandboxSpec> for CloudCreateSandboxRequest

fn from(spec: SandboxSpec) -> Self

Converts to this type from the input type.

impl Serialize for CloudCreateSandboxRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CloudCreateSandboxRequest> for SandboxSpec

type Error = TypesError

The type returned in the event of a conversion error.

fn try_from(req: CloudCreateSandboxRequest) -> TypesResult<Self>

Performs the conversion.