Struct GeneratedService 

pub struct GeneratedService { /* private fields */ }

A typed generated Compose service definition.

Implementations

impl GeneratedService

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

Creates an empty service with a validated name.

Errors

Rejects an empty or NUL-bearing name.

pub fn name(&self) -> &str

Returns the service name.

pub fn set_image( &mut self, image: GeneratedString, ) -> Result<(), GenerationError>

Sets the service image exactly once.

Errors

Returns GenerationError::EmptyValue for an empty image or GenerationError::DuplicateField when already configured.

pub fn set_command( &mut self, command: GeneratedCommand, ) -> Result<(), GenerationError>

Sets the Compose command form exactly once.

Errors

Returns GenerationError::DuplicateField when already configured.

pub fn add_environment(&mut self, environment: GeneratedEnvironment)

Adds one ordered environment entry.

pub fn add_label( &mut self, label: GeneratedLabel, ) -> Result<(), GenerationError>

Adds one uniquely named service metadata label.

Errors

Returns GenerationError::DuplicateName when the service already defines the label.

pub fn set_user(&mut self, user: GeneratedString) -> Result<(), GenerationError>

Sets the combined Compose user[:group] value exactly once.

Errors

Returns GenerationError::DuplicateField when already configured.

pub fn set_userns_mode( &mut self, mode: GeneratedString, ) -> Result<(), GenerationError>

Sets the user-namespace mode exactly once.

Errors

Returns GenerationError::EmptyValue for an empty mode or GenerationError::DuplicateField when already configured.

pub fn add_supplementary_group( &mut self, group: GeneratedString, ) -> Result<(), GenerationError>

Adds one ordered supplementary group.

Errors

Returns GenerationError::EmptyValue for an empty group.

pub fn set_working_dir( &mut self, directory: GeneratedString, ) -> Result<(), GenerationError>

Sets the container working directory exactly once.

Errors

Returns GenerationError::EmptyValue for an empty directory or GenerationError::DuplicateField when already configured.

pub fn set_read_only(&mut self, read_only: bool) -> Result<(), GenerationError>

Sets the read-only-root choice exactly once.

Errors

Returns GenerationError::DuplicateField when already configured.

pub fn add_extra_host(&mut self, host: GeneratedExtraHost)

Adds one ordered host mapping.

pub fn add_port(&mut self, port: GeneratedPort)

Adds one ordered published-port declaration.

pub fn add_mount(&mut self, mount: GeneratedMount)

Adds one ordered mount.

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

Adds one uniquely named network attachment.

Errors

Returns GenerationError::DuplicateName when the service already uses the network.

Trait Implementations

impl Clone for GeneratedService

fn clone(&self) -> GeneratedService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeneratedService

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

Formats the value using the given formatter.

impl Eq for GeneratedService

impl PartialEq for GeneratedService

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GeneratedService