Skip to main content

Recipe

Struct Recipe 

Source
#[non_exhaustive]
pub struct Recipe { pub os: OsRef, pub family: Family, pub install: Vec<Resource>, pub configure: Vec<Resource>, pub start: Vec<Resource>, pub daemons: Vec<Daemon>, pub files: BTreeMap<ProjectPath, String>, }
Expand description

A recipe resolved for one machine: its phases in order (install, configure, start), the daemons its container form runs, and the texts of its templates.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§os: OsRef

The OS it is resolved for.

§family: Family

The OS’s family.

§install: Vec<Resource>

Install: an app’s steps; a catalogue entry’s install (which its official image skips).

§configure: Vec<Resource>

Configure: a catalogue entry’s configure, run in every form.

§start: Vec<Resource>

Start: a catalogue entry’s per-start preparation (an app has none in 1.0).

§daemons: Vec<Daemon>

The foreground forms of its enabled services, in recipe order: the container’s daemons.

§files: BTreeMap<ProjectPath, String>

The text of each of its templates, by the template’s from, its lab placeholders not yet filled in (super::fill does, per machine and target). A template missing here wasn’t read: the renderers refuse it rather than install something else.

Implementations§

Source§

impl Recipe

Source

pub fn resources(&self) -> impl Iterator<Item = &Resource>

Its resources, phase after phase.

Source

pub fn of( c: &Configuration, ports: &[Port], daemons: &DaemonTable, ) -> Result<Recipe, Vec<Unportable>>

The recipe of configuration c, its firewall’s port names read in ports (the lowered machine’s), its services in daemons.

§Errors

Every step c’s family can’t carry (Unportable), in step order. Lowering refuses those first, so a lowered machine’s configuration always resolves.

Trait Implementations§

Source§

impl Clone for Recipe

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 Recipe

Source§

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

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

impl Eq for Recipe

Source§

impl PartialEq for Recipe

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 Recipe

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> 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.