Struct GeneratedVolumeDefinition 

pub struct GeneratedVolumeDefinition { /* private fields */ }

A top-level application-owned volume definition with optional driver configuration.

This type is intentionally distinct from GeneratedResource, which remains the compatible basic/external lifecycle API shared by top-level networks and volumes. External volumes cannot use this driver-configured API.

Implementations

impl GeneratedVolumeDefinition

pub fn application(name: impl Into<String>) -> Result<Self, GenerationError>

Creates an application-owned volume definition.

Errors

Rejects an empty or NUL-bearing name.

pub fn set_custom_name( &mut self, name: impl Into<String>, ) -> Result<(), GenerationError>

Sets the exact platform-level volume name once.

Errors

Rejects an empty/NUL-bearing name and duplicate configuration.

pub fn set_driver( &mut self, driver: GeneratedString, ) -> Result<(), GenerationError>

Sets one opaque volume driver exactly once.

No driver, plugin, provider, runtime, default, or image semantics validation is applied.

Errors

Returns GenerationError::DuplicateField when already configured.

pub fn set_driver_opts( &mut self, driver_opts: Vec<GeneratedVolumeDriverOption>, ) -> Result<(), GenerationError>

Sets the complete ordered unique volume driver-options mapping exactly once.

An empty mapping remains explicit. String and number YAML scalar identities are selected by GeneratedVolumeDriverOptionValue and are never inferred from their text.

Errors

Rejects duplicate option names and duplicate field configuration. No driver-specific option, plugin, provider, runtime, default, or image semantics are validated.

pub fn set_labels( &mut self, labels: Vec<GeneratedLabel>, ) -> Result<(), GenerationError>

Sets the complete ordered unique volume-label mapping exactly once.

An empty mapping remains explicit. Labels use the same explicit string-value contract as generated service labels, so neither key-only nor non-string label forms are generated.

Errors

Rejects duplicate label names and duplicate field configuration. No provider, runtime, or injected-label equivalence is inferred.

pub fn name(&self) -> &str

Returns the generated volume name.

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

Returns the optional exact platform-level volume name.

pub const fn driver(&self) -> Option<&GeneratedString>

Returns the optional opaque volume driver.

pub fn driver_opts(&self) -> Option<&[GeneratedVolumeDriverOption]>

Returns the optional ordered driver-options mapping, including an explicit empty map.

pub fn labels(&self) -> Option<&[GeneratedLabel]>

Returns the optional ordered volume-label mapping, including an explicit empty map.

Trait Implementations

impl Clone for GeneratedVolumeDefinition

fn clone(&self) -> GeneratedVolumeDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratedVolumeDefinition

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

Formats the value using the given formatter.

impl Eq for GeneratedVolumeDefinition

impl PartialEq for GeneratedVolumeDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GeneratedVolumeDefinition