Enum Reference 

#[non_exhaustive]
pub enum Reference {
    MachineName,
    OwnAddress {
        network: String,
    },
    Address {
        machine: String,
        network: String,
    },
    Port {
        machine: String,
        port: PortName,
        field: PortField,
    },
    CloudOutput(String),
    Version,
    Os(OsField),
    Var(String),
    Setting {
        name: String,
        field: SettingField,
    },
    Item(String),
    ItemPath(String),
}

What a placeholder names.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MachineName

machine.name: the machine the template is for.

OwnAddress

machine.addresses.<network>: its address on that network.

Fields

network: String

The network.

Address

machines.<m>.addresses.<network>: another machine’s address on a network.

Fields

machine: String

The machine.

network: String

The network.

Port

machines.<m>.ports.<name>.port|published|url: a machine’s port.

Fields

machine: String

The machine.

port: PortName

The port, by name.

field: PortField

What of it.

CloudOutput(String)

cloud.outputs.<name>: an output of the cloud module.

Version

version: a catalogue entry’s resolved release.

Os(OsField)

os.family, os.version, os.codename: the machine’s OS.

Var(String)

vars.<x>: a variable of the entry’s release.

Setting

with.<setting>, or with.<setting>.path for a password given as a secret or an input.

Fields

name: String

The setting.

field: SettingField

Its value, or its value file’s path.

Item(String)

item.<field>: a field of the list item a for_each step is repeated for.

ItemPath(String)

item.<field>.path: the value file of a list item’s password field.

Implementations

impl Reference

pub fn is_run_time(&self) -> bool

Whether its value is only known once the lab runs (a published port, a URL).

pub fn allowed_in(&self, place: Place) -> Result<(), &'static str>

Whether place may name it, else why not.

Errors

Why the place can’t name it: a run-time value in a file, an entry’s path outside an entry.

Trait Implementations

impl Clone for Reference

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 Reference

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

Formats the value using the given formatter.

impl Display for Reference

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

Formats the value using the given formatter.

impl Eq for Reference

impl FromStr for Reference

fn from_str(path: &str) -> Result<Reference, Error>

The reference a placeholder’s path names (machines.web.ports.site.port).

Errors

Error::Placeholder for a path the grammar doesn’t have, with the paths it has there.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Reference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Reference

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Reference