Struct specifications::container::VolumeBind

pub struct VolumeBind {
    pub host: PathBuf,
    pub container: PathBuf,
    pub options: Vec<VolumeBindOption>,
}

Defines a single Docker volume binding.

Fields

host: PathBuf

The source location, on the host.

container: PathBuf

The target location, on the container.

options: Vec<VolumeBindOption>

Any options for the bind.

Implementations

impl VolumeBind

pub fn new( host: impl Into<PathBuf>, container: impl Into<PathBuf>, options: Vec<VolumeBindOption>, ) -> Result<Self, VolumeBindError>

Constructor for VolumeBind that does not initialize it with special options.

Arguments

• host: The path to the host folder. Note that this path must be absolute.
• container: The path to the container folder. Note that this path must be absolute.
• options: The VolumeBindOptions that further customize the bind(s).

Returns

A new VolumeBind instance.

Errors

This function may error if either of the given paths is not actually absolute.

pub fn new_readonly( host: impl Into<PathBuf>, container: impl Into<PathBuf>, ) -> Result<Self, VolumeBindError>

Constructor for VolumeBind that initializes it as a read-only bind.

Arguments

• host: The path to the host folder. Note that this path must be absolute.
• container: The path to the container folder. Note that this path must be absolute.

Returns

A new VolumeBind instance.

Errors

This function may error if either of the given paths is not actually absolute.

pub fn new_readwrite( host: impl Into<PathBuf>, container: impl Into<PathBuf>, ) -> Result<Self, VolumeBindError>

Constructor for VolumeBind that initializes it as a read/write bind.

Arguments

• host: The path to the host folder. Note that this path must be absolute.
• container: The path to the container folder. Note that this path must be absolute.

Returns

A new VolumeBind instance.

Errors

This function may error if either of the given paths is not actually absolute.

pub fn docker(&self) -> VolumeBindDockerDisplay<'_>

Returns a formatter that writes a Docker-compatible version of this VolumeBindOption.

Trait Implementations

impl Clone for VolumeBind

fn clone(&self) -> VolumeBind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeBind

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

Formats the value using the given formatter.