Enum Volume

pub enum Volume {
    ContainerVolume {
        name: VolumeName,
        container: PathBuf,
        readonly: bool,
    },
    BindMount {
        container: PathBuf,
        host: PathBuf,
        readonly: bool,
    },
    Tmpfs {
        container: PathBuf,
    },
}

A volume

See Docker reference

Examples

// Create a bind mount volumes
let v1 = Volume::from(("./data", "/etc/var/data"));
let v2 = Volume::bind_mount("./data", "/etc/var/data");
assert_eq!(v1, v2);

// Create a container volume
let name = "my-vol".parse::<VolumeName>().expect("a valid volume name");
let v1 = Volume::from((name.clone(), "/etc/var/data"));
let v2 = Volume::container_volume(name, "/etc/var/data");
assert_eq!(v1, v2);

// Create a tmpfs volume (in-memory)
let v = Volume::tmpfs("/etc/var/data");
assert!(matches!(v, Volume::Tmpfs{..}));

Variants

ContainerVolume

A containervolume

See https://docs.docker.com/storage/volumes/

Fields

name: VolumeName

The name

container: PathBuf

The container path (target)

readonly: bool

If read-only

BindMount

A bind mount

See https://docs.docker.com/storage/bind-mounts/

Fields

container: PathBuf

The container path (target)

host: PathBuf

The host path (source)

readonly: bool

If read-only

Tmpfs

In-Memory mount

⚠️ WARNING, this is not supported by all platform See https://docs.docker.com/storage/tmpfs

Fields

container: PathBuf

The container path (target)

Implementations

impl Volume

pub fn container_volume(name: VolumeName, container: impl Into<PathBuf>) -> Self

Create a container volume

pub fn bind_mount( host: impl Into<PathBuf>, container: impl Into<PathBuf>, ) -> Self

Create a bind mount volume

pub fn tmpfs(container: impl Into<PathBuf>) -> Self

Create a tmpfs volume

pub fn read_only(&mut self)

Make the volume readonly

⚠️ WARNING this is not supported by Tmpfs

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Volume

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

Formats the value using the given formatter.

impl<P, Q> From<(P, Q)> for Volume

where P: AsRef<Path>, Q: AsRef<Path>,

fn from(value: (P, Q)) -> Self

Converts to this type from the input type.

impl<P> From<(VolumeName, P)> for Volume

where P: AsRef<Path>,

fn from(value: (VolumeName, P)) -> Self

Converts to this type from the input type.

impl PartialEq for Volume

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

impl StructuralPartialEq for Volume