Struct SpawnNodeOptions

pub struct SpawnNodeOptions {
    pub name: String,
    pub image: Option<String>,
    pub resources: Option<Resources>,
    pub program: String,
    pub args: Vec<String>,
    pub env: Vec<(String, String)>,
    pub injected_files: Vec<TransferedFile>,
    pub created_paths: Vec<PathBuf>,
    pub db_snapshot: Option<AssetLocation>,
    pub port_mapping: Option<HashMap<Port, Port>>,
}

Fields

name: String

Name of the node

image: Option<String>

Image of the node (IFF is supported by the provider)

resources: Option<Resources>

Resources to apply to the node (IFF is supported by the provider)

program: String

Main command to execute

args: Vec<String>

Arguments to pass to the main command

env: Vec<(String, String)>

Environment to set when running the program

injected_files: Vec<TransferedFile>

Files to inject at startup

created_paths: Vec<PathBuf>

Paths to create before start the node (e.g keystore) should be created with create_dir_all in order to create the full path even when we have missing parts

db_snapshot: Option<AssetLocation>

Database snapshot to be injected (should be a tgz file) Could be a local or remote asset

port_mapping: Option<HashMap<Port, Port>>

Implementations

impl SpawnNodeOptions

pub fn new<S>(name: S, program: S) -> Self

where S: AsRef<str>,

pub fn image<S>(self, image: S) -> Self

where S: AsRef<str>,

pub fn resources(self, resources: Resources) -> Self

pub fn db_snapshot(self, db_snap: Option<AssetLocation>) -> Self

pub fn args<S, I>(self, args: I) -> Self

where S: AsRef<str>, I: IntoIterator<Item = S>,

pub fn env<S, I>(self, env: I) -> Self

where S: AsRef<str>, I: IntoIterator<Item = (S, S)>,

pub fn injected_files<I>(self, injected_files: I) -> Self

where I: IntoIterator<Item = TransferedFile>,

pub fn created_paths<P, I>(self, created_paths: I) -> Self

where P: AsRef<Path>, I: IntoIterator<Item = P>,

pub fn port_mapping(self, ports: HashMap<Port, Port>) -> Self

Trait Implementations

impl Clone for SpawnNodeOptions

fn clone(&self) -> SpawnNodeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpawnNodeOptions

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

Formats the value using the given formatter.