Enum Vtl2SettingsErrorCode

pub enum Vtl2SettingsErrorCode {
    InternalFailure,
    JsonFormatError,
    NoVmbusServer,
    UnsupportedSchemaVersion,
    InvalidInstanceId,
    ProtobufFormatError,
    UnsupportedSchemaNamespace,
    EmptyNamespaceChunk,
    StorageCannotAddRemoveControllerAtRuntime,
    StorageLunLocationExceedsMaxLimits,
    StorageLunLocationDuplicated,
    StorageUnsupportedDeviceType,
    StorageCannotFindVtl2Device,
    EmptyDriveNotAllowed,
    StorageCannotOpenVtl2Device,
    StorageScsiControllerNotFound,
    StorageAttachDiskFailed,
    StorageRmDiskFailed,
    StorageControllerGuidAlreadyExists,
    StorageScsiControllerExceedsMaxLimits,
    StorageInvalidVendorId,
    StorageInvalidProductId,
    StorageInvalidProductRevisionLevel,
    StorageIdeChannelNotProvided,
    StorageIdeChannelExceedsMaxLimits,
    StorageIdeLocationExceedsMaxLimits,
    StorageIdeChannelInvalidConfiguration,
    StripedStorageCannotChangeControllerAtRuntime,
    StorageInvalidPhysicalDiskCount,
    StorageCannotModifyIdeAtRuntime,
    StorageInvalidControllerType,
    StorageInvalidDeviceId,
    StorageChangeMediaFailed,
    StorageInvalidNtfsFormatGuid,
    NetworkingModifyNicFailed,
    NetworkingAddNicFailed,
    NetworkingRemoveNicFailed,
}

The error codes used for failures when parsing or acting on a VTL2 settings document from the host.

These are used to provide an identifier that the host can match on, as well as some error categorization. Additional (string) error context can be provided in Vtl2SettingsErrorInfo.

This table is in the form name => (component, category). component and category must be elements in the Component and EscalationCategory enums, respectively.

Note that the values of name, component, and category are encoded into a form sent to the host, and so changing them for an error may be a breaking change.

Specifically, they are encoded into a string as category.name. The astute reader will note that the component is not actually used in the error message, or anywhere. FUTURE: remove the component, or include it as a separate field in the JSON.

In any case, the Rust-assigned discriminant values are not used in error messages and do not need to be stable.

Variants

InternalFailure

Underhill internal failure

JsonFormatError

Invalid JSON format

NoVmbusServer

VM Bus server is not configured

UnsupportedSchemaVersion

Unsupported schema version

InvalidInstanceId

Invalid vmbus instance ID

ProtobufFormatError

Invalid protobuf format

UnsupportedSchemaNamespace

Unsupported schema namespace

EmptyNamespaceChunk

Empty namespace chunk

StorageCannotAddRemoveControllerAtRuntime

Change storage controller at runtime

StorageLunLocationExceedsMaxLimits

SCSI LUN exceeds max limits (64)

StorageLunLocationDuplicated

SCSI LUN location duplicated in configuration

StorageUnsupportedDeviceType

Unsupported device type in configuration

StorageCannotFindVtl2Device

Cannot find NVMe device namespace /dev/nvmen

EmptyDriveNotAllowed

Hard drive cannot be empty

StorageCannotOpenVtl2Device

Cannot open VTL2 block device

StorageScsiControllerNotFound

Cannot find a given SCSI controller

StorageAttachDiskFailed

Failed to attack a disk to a controller

StorageRmDiskFailed

Failed to remove a disk from a controller

StorageControllerGuidAlreadyExists

Storage controller already exists

StorageScsiControllerExceedsMaxLimits

SCSI controller exceeds max limits (4)

StorageInvalidVendorId

Invalid vendor ID

StorageInvalidProductId

Invalid product ID

StorageInvalidProductRevisionLevel

Invalid product revision level

StorageIdeChannelNotProvided

IDE channel is not provided

StorageIdeChannelExceedsMaxLimits

IDE channel exceeds max limits (0 or 1)

StorageIdeLocationExceedsMaxLimits

IDE location exceeds max limits (0 or 1)

StorageIdeChannelInvalidConfiguration

IDE configuration is invalid

StripedStorageCannotChangeControllerAtRuntime

Cannot change storage controller with striped devices at runtime

StorageInvalidPhysicalDiskCount

Invalid physical disk count

StorageCannotModifyIdeAtRuntime

Cannot modify IDE devices at runtime

StorageInvalidControllerType

Invalid controller type

StorageInvalidDeviceId

Invalid vendor ID

StorageChangeMediaFailed

Failed to change media on a controller

StorageInvalidNtfsFormatGuid

Invalid NTFS format guid

NetworkingModifyNicFailed

Failed to modify NIC

NetworkingAddNicFailed

Failed to add NIC

NetworkingRemoveNicFailed

Failed to remove NIC

Trait Implementations

impl Clone for Vtl2SettingsErrorCode

fn clone(&self) -> Vtl2SettingsErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vtl2SettingsErrorCode

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

Formats the value using the given formatter.

impl PartialEq for Vtl2SettingsErrorCode

fn eq(&self, other: &Vtl2SettingsErrorCode) -> 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 Serialize for Vtl2SettingsErrorCode

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Vtl2SettingsErrorCode

impl StructuralPartialEq for Vtl2SettingsErrorCode