Struct File 

pub struct File {
    pub version: String,
    pub services: BTreeMap<String, Service>,
    pub volumes: BTreeMap<String, Volume>,
    pub networks: BTreeMap<String, Network>,
    /* private fields */
}

A docker-compose.yml file.

Fields

version: String

The version of the docker-compose.yml file format. Must be 2.

services: BTreeMap<String, Service>

The individual services which make up this app.

volumes: BTreeMap<String, Volume>

Named volumes used by this app.

TODO MED: Can we parse just volume names followed by a colon?

networks: BTreeMap<String, Network>

The networks used by this app.

Implementations

impl File

pub fn read<R>(r: R) -> Result<Self>

where R: Read,

Read a file from an input stream containing YAML.

pub fn write<W>(&self, w: &mut W) -> Result<()>

where W: Write,

Write a file to an output stream as YAML.

pub fn read_from_path<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Read a file from the specified path.

pub fn write_to_path<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Write a file to the specified path.

pub fn inline_all(&mut self, base: &Path) -> Result<()>

Inline all our external resources, such as env_files, looking up paths relative to base.

pub fn make_standalone(&mut self, base: &Path) -> Result<()>

Convert this file to a standalone file, with no dependencies on the current environment or any external files. This does not lock down the image versions used in this file.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for File

impl FromStr for File

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<File>

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

impl MergeOverride for File

Recursive merge all fields in the structure.

fn merge_override(&self, ovr: &Self) -> Self

Given this value and an override value, merge the override value into this one, producing a new value.

impl PartialEq for File

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for File