Struct CustomProcess 

pub struct CustomProcess { /* private fields */ }

A custom process to spawn next to the nodes: its command, args, env, image (provider specific), named ports, resources (provider specific), and its lifecycle: ready_check, depends_on, one_shot and timeout.

Implementations

impl CustomProcess

pub fn name(&self) -> &str

Node name.

pub fn image(&self) -> Option<&Image>

Image to run (only podman/k8s).

pub fn command(&self) -> &Command

Command to run the node.

pub fn args(&self) -> Vec<&Arg>

Arguments to use for node.

pub fn env(&self) -> Vec<&EnvVar>

Environment variables to set (inside pod for podman/k8s, inside shell for native).

pub fn ports(&self) -> &[NamedPort]

Named ports the process listens on.

pub fn resources(&self) -> Option<&Resources>

Resources to apply to the process (only k8s).

pub fn ready_check(&self) -> Option<&ReadyCheck>

How the process is known to be ready, if declared. Without one, a process with ports is ready when its first port accepts a connection, and a process without ports is ready once started.

pub fn depends_on(&self) -> &[Dependency]

The processes this one starts after.

pub fn one_shot(&self) -> bool

Whether the process runs to completion (exit 0 is success) instead of staying up.

pub fn timeout(&self) -> Option<u32>

Seconds to wait for the process to meet its condition (the ready check to pass, or a one-shot to exit); the global node_spawn_timeout when absent.

pub fn effective_check(&self) -> Option<ReadyTarget>

What the process is waited on: the ready_check, or a TCP connect on the first declared port when there is none. None for a one-shot (waited on to exit) and for a process with nothing to check (ready once started).

pub fn natural_condition(&self) -> DependencyCondition

The condition a dependency on this process means when it names none: completed for a one-shot, healthy when there is something to check, started otherwise.

pub fn validate(&self) -> Result<(), Vec<Error>>

The field rules shared by the builder and the TOML loader. What is checked at spawn follows from them, see Self::effective_check.

Trait Implementations

impl Clone for CustomProcess

fn clone(&self) -> CustomProcess

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomProcess

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

Formats the value using the given formatter.

impl Default for CustomProcess

fn default() -> CustomProcess

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomProcess

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CustomProcess

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CustomProcess

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 CustomProcess