Skip to main content

GuestCompose

Struct GuestCompose 

Source
pub struct GuestCompose {
    pub machines: Vec<Machine>,
    pub networks: Vec<Network>,
    pub slots: Vec<SecretSlot>,
    pub params: Vec<Param>,
    pub start: Vec<GuestCommand>,
    pub ready: Vec<Condition>,
    pub check_setup: Vec<GuestCommand>,
    pub runners: Vec<GuestRunner>,
    pub status: GuestCommand,
}
Expand description

The lab’s containers in a VM, and the commands that run them there.

Fields§

§machines: Vec<Machine>

The containers and Compose’s own services, as the docker target’s manifest has them, each published port fixed at its publish number (the VM’s backend says where it answers).

§networks: Vec<Network>

The lab’s networks, named as Compose makes them in the VM.

§slots: Vec<SecretSlot>

What the containers read at start (inputs, secrets), each delivered as an environment variable to the start steps creating the containers that read it: the VM’s way in forwards it (GuestCompose::forwarded).

§params: Vec<Param>

Non-secret values the commands read (whether derived checks run).

§start: Vec<GuestCommand>

Everything up and healthy, then each leaf job attached.

§ready: Vec<Condition>

When the containers count as ready: each start step succeeded.

§check_setup: Vec<GuestCommand>

Before the check runners (the access machine’s stand-in).

§runners: Vec<GuestRunner>

The check runners.

§status: GuestCommand

Reads the containers: docker compose ps --all --format json, nothing before Docker is in.

Implementations§

Source§

impl GuestCompose

Source

pub fn forwarded(&self) -> Vec<String>

The variables the start steps read from their environment, which the VM’s way in must forward into it (SSH’s SendEnv, accepted by the VM’s AcceptEnv): sorted, each once.

Source

pub fn machines_at(&self, address: &Template) -> Vec<Machine>

The machines, each published port answering at address (this computer’s loopback, the VM’s address).

Trait Implementations§

Source§

impl Clone for GuestCompose

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GuestCompose

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for GuestCompose

Source§

impl PartialEq for GuestCompose

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GuestCompose

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.