Struct EntryOptions 

pub struct EntryOptions {
    pub id: Option<String>,
    pub name: String,
    pub disabled: Disabled,
    pub inject: Vec<String>,
    pub group: Vec<EntryOptions>,
    pub config: Option<Node>,
}

One entry in a config file: a plugin instance plus its group position.

The declared field order is the serialization order (id and name first, config last), keeping files readable and diff-stable. Entries with a group array are groups; the array order is the child order.

config is stored raw: ${{ env.NAME }} templates stay intact in the entry tree and are only expanded when the config is handed to a plugin (see crate::Entry::resolved_config).

Fields

id: Option<String>

Stable identity of the entry. Missing ids are filled with a random 6-character base36 id when the entry enters a tree and persisted on the next write-back.

name: String

Plugin name used to resolve the plugin implementation.

disabled: Disabled

Whether the entry (and transitively its subtree) is disabled: a static flag, or a !!js expression evaluated at activation whose raw text round-trips through the file.

inject: Vec<String>

Names of services that must be active before this entry starts.

group: Vec<EntryOptions>

Child entries, in order. Non-empty only for group entries.

config: Option<Node>

Raw plugin configuration (templates unexpanded).

Implementations

impl EntryOptions

pub fn new(name: impl Into<String>) -> EntryOptions

Create options for a plugin with the given name.

pub fn with_id(self, id: impl Into<String>) -> EntryOptions

Set the explicit entry id.

pub fn with_config(self, config: Node) -> EntryOptions

Set the raw plugin configuration.

pub fn with_group(self, group: Vec<EntryOptions>) -> EntryOptions

Set the child entries (turning this entry into a group).

pub fn with_disabled(self, disabled: bool) -> EntryOptions

Set the static disable flag (see EntryOptions::disabled; use the field directly for a !!js expression).

pub fn import_url(&self) -> Option<&str>

The url this import entry mounts, when the entry is an import (name: import with a string config.url).

pub fn with_inject<I, S>(self, inject: I) -> EntryOptions

where I: IntoIterator<Item = S>, S: Into<String>,

Declare services that must be active before this entry starts.

Trait Implementations

impl Clone for EntryOptions

fn clone(&self) -> EntryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntryOptions

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

Formats the value using the given formatter.

impl Default for EntryOptions

fn default() -> EntryOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntryOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<EntryOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EntryOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EntryOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EntryOptions