Enum PathPair

pub enum PathPair {
    Distinct {
        host: Utf8UnixPathBuf,
        guest: Utf8UnixPathBuf,
    },
    Same(Utf8UnixPathBuf),
}

Represents a path mapping between host and guest systems, following Docker’s volume mapping convention.

Format

The path pair can be specified in two formats:

• host:guest - Maps a host path to a different guest path (e.g., “/host/path:/container/path”)
• path or path:path - Maps the same path on both host and guest (e.g., “/data” or “/data:/data”)

Examples

Creating path pairs:

use microsandbox_core::config::PathPair;
use typed_path::Utf8UnixPathBuf;

// Same path on host and guest (/data:/data)
let same_path = PathPair::with_same("/data".into());

// Different paths (host /host/data maps to guest /container/data)
let distinct_paths = PathPair::with_distinct(
    "/host/data".into(),
    "/container/data".into()
);

// Parse from string
let from_str = "/host/data:/container/data".parse::<PathPair>().unwrap();
assert_eq!(from_str, distinct_paths);

Variants

Distinct

The guest path and host path are distinct.

Fields

host: Utf8UnixPathBuf

The host path.

guest: Utf8UnixPathBuf

The guest path.

Same(Utf8UnixPathBuf)

The guest path and host path are the same.

Implementations

impl PathPair

pub fn with_same(path: Utf8UnixPathBuf) -> Self

Creates a new PathPair with the same host and guest path.

pub fn with_distinct(host: Utf8UnixPathBuf, guest: Utf8UnixPathBuf) -> Self

Creates a new PathPair with distinct host and guest paths.

pub fn get_host(&self) -> &Utf8UnixPathBuf

Returns the host path.

pub fn get_guest(&self) -> &Utf8UnixPathBuf

Returns the guest path.

Trait Implementations

impl Clone for PathPair

fn clone(&self) -> PathPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathPair

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathPair

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PathPair

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

Formats the path pair following the format “host:guest”.

impl FromStr for PathPair

type Err = MicrosandboxError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for PathPair

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PathPair

impl StructuralPartialEq for PathPair