Struct ComposeDocumentBuilder 

pub struct ComposeDocumentBuilder { /* private fields */ }

Builder for one new deterministic Compose document.

Implementations

impl ComposeDocumentBuilder

pub const fn new() -> Self

Creates an empty generated project.

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

Sets the optional top-level Compose project name exactly once.

Errors

Rejects empty/NUL-bearing names and duplicate configuration.

pub fn add_service( &mut self, service: GeneratedService, ) -> Result<(), GenerationError>

Adds one uniquely named service in output order.

Errors

Returns GenerationError::DuplicateName for a duplicate service name.

pub fn add_network( &mut self, network: GeneratedResource, ) -> Result<(), GenerationError>

Adds one uniquely named top-level network in output order.

Errors

Returns GenerationError::DuplicateName for a duplicate network name.

pub fn add_network_definition( &mut self, network: GeneratedNetworkDefinition, ) -> Result<(), GenerationError>

Adds one uniquely named top-level network definition in output order.

This is additive to Self::add_network, which retains the existing basic/external GeneratedResource API for compatibility.

Errors

Returns GenerationError::DuplicateName for a duplicate network name across basic and driver-configured network definitions.

pub fn add_volume( &mut self, volume: GeneratedResource, ) -> Result<(), GenerationError>

Adds one uniquely named top-level volume in output order.

Errors

Returns GenerationError::DuplicateName for a duplicate volume name.

pub fn add_volume_definition( &mut self, volume: GeneratedVolumeDefinition, ) -> Result<(), GenerationError>

Adds one uniquely named top-level application-owned volume definition in output order.

This is additive to Self::add_volume, which retains the existing basic/external GeneratedResource API for compatibility. Driver-configured external volumes are not representable: use GeneratedResource::external for that lifecycle.

Errors

Returns GenerationError::DuplicateName for a duplicate volume name across basic and driver-configured volume definitions.

pub fn add_config_file( &mut self, config: GeneratedConfigFileDefinition, ) -> Result<(), GenerationError>

Adds one uniquely named top-level config file definition in output order.

Errors

Returns GenerationError::DuplicateName for a duplicate config name.

pub fn add_secret_file( &mut self, secret: GeneratedSecretFileDefinition, ) -> Result<(), GenerationError>

Adds one uniquely named top-level secret file definition in output order.

Errors

Returns GenerationError::DuplicateName for a duplicate secret name.

pub fn build( self, source_id: SourceId, ) -> Result<GeneratedComposeDocument, GenerationError>

Generates YAML and parses it back through ComposeLens’s syntax and typed-model boundaries.

Errors

Returns GenerationError::MissingService for an empty project or GenerationError::InternalInvariant if ComposeLens cannot parse its own output.

Trait Implementations

impl Clone for ComposeDocumentBuilder

fn clone(&self) -> ComposeDocumentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComposeDocumentBuilder

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

Formats the value using the given formatter.

impl Default for ComposeDocumentBuilder

fn default() -> ComposeDocumentBuilder

Returns the “default value” for a type.

impl Eq for ComposeDocumentBuilder

impl PartialEq for ComposeDocumentBuilder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ComposeDocumentBuilder