Struct ComposeService 

pub struct ComposeService { /* private fields */ }

Docker Compose service metadata.

Implementations

impl ComposeService

pub fn new(name: impl AsRef<str>) -> ComposeService

Creates a service with trusted static text.

pub fn try_new( name: impl AsRef<str>, ) -> Result<ComposeService, ComposeTextError>

Creates a service with validated dynamic text.

pub fn with_image(self, image: impl Into<String>) -> ComposeService

Adds an image reference string.

pub fn with_build(self, build: ComposeBuild) -> ComposeService

Adds build metadata.

pub fn with_port(self, port: impl Into<String>) -> ComposeService

Adds a port mapping string.

pub fn with_volume(self, volume: impl Into<String>) -> ComposeService

Adds a volume string.

pub fn with_environment( self, key: impl AsRef<str>, value: impl Into<String>, ) -> Result<ComposeService, ComposeTextError>

Adds an environment key/value pair.

pub fn with_dependency( self, name: impl AsRef<str>, ) -> Result<ComposeService, ComposeTextError>

Adds a service dependency.

pub fn with_network( self, name: impl AsRef<str>, ) -> Result<ComposeService, ComposeTextError>

Adds a named network.

pub fn with_profile( self, name: impl AsRef<str>, ) -> Result<ComposeService, ComposeTextError>

Adds a profile.

pub fn name(&self) -> &str

Returns the service name.

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

Returns the optional image reference string.

pub const fn build(&self) -> Option<&ComposeBuild>

Returns the optional build metadata.

pub fn ports(&self) -> &[String]

Returns port mapping strings.

pub fn volumes(&self) -> &[String]

Returns volume strings.

pub fn environment(&self) -> &[(String, String)]

Returns environment key/value pairs.

pub fn depends_on(&self) -> &[String]

Returns dependencies.

pub fn networks(&self) -> &[String]

Returns network names.

pub fn profiles(&self) -> &[String]

Returns profiles.

Trait Implementations

impl Clone for ComposeService

fn clone(&self) -> ComposeService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComposeService

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

Formats the value using the given formatter.

impl PartialEq for ComposeService

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

impl StructuralPartialEq for ComposeService