Struct Machine 

pub struct Machine {

    pub os: Option<OsRef>,
    pub kind: Kind,
    pub networks: IndexMap<String, Octets>,
    pub aliases: Vec<String>,
    pub access: bool,
    pub ports: IndexMap<PortName, Port>,
    pub command: Option<Command>,
    pub setup: Vec<String>,
    pub healthcheck: Option<Healthcheck>,
    pub depends_on: Vec<String>,
    pub environment: IndexMap<String, EnvValue>,
    pub files: Vec<File>,
    pub volumes: IndexMap<String, Mount>,
    pub disks: IndexMap<String, Disk>,
    pub tmpfs: Vec<Tmpfs>,
    pub resources: Option<Resources>,
    pub hardware: Hardware,
    pub dns: Option<Dns>,
    pub privileged: bool,
    pub read_only: bool,
    pub shm_size: Option<String>,
    pub sysctls: IndexMap<String, String>,
    pub ulimits: IndexMap<String, Ulimit>,
    pub rate_limit: Option<String>,
}

A machine of the environment.

Fields

os: Option<OsRef>

Its OS (None: a container-only app, or an access machine the runner supplies).

kind: Kind

What it is.

networks: IndexMap<String, Octets>

Network name → its address on it.

aliases: Vec<String>

More DNS names it answers to.

access: bool

The machine the user lands on.

ports: IndexMap<PortName, Port>

Its ports, by name.

command: Option<Command>

Its own command.

setup: Vec<String>

Project scripts run once it is up.

healthcheck: Option<Healthcheck>

When it counts as healthy beyond its ports.

depends_on: Vec<String>

Machines that must be ready first.

environment: IndexMap<String, EnvValue>

Its environment variables.

files: Vec<File>

Files placed on it.

volumes: IndexMap<String, Mount>

Its volumes: name → where it mounts it.

disks: IndexMap<String, Disk>

Its data disks.

tmpfs: Vec<Tmpfs>

Its memory-backed mounts.

resources: Option<Resources>

Its CPUs, memory and disk.

hardware: Hardware

The hardware it asks for.

dns: Option<Dns>

How it resolves names.

privileged: bool

Kernel-level access.

read_only: bool

A read-only root filesystem.

shm_size: Option<String>

The size of /dev/shm.

sysctls: IndexMap<String, String>

Kernel parameters.

ulimits: IndexMap<String, Ulimit>

Process limits.

rate_limit: Option<String>

A bandwidth cap on each of its links.

Implementations

impl Machine

pub fn app(&self) -> Option<&App>

Its custom app, when it is one.

Trait Implementations

impl Clone for Machine

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Machine

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Machine

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Machine

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(g: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for Machine

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Machine