Struct ibc_test_framework::relayer::driver::RelayerDriver

pub struct RelayerDriver {
    pub config_path: PathBuf,
    pub config: Config,
    pub registry: SharedRegistry<CountingAndCachingChainHandle>,
    pub hang_on_fail: bool,
}

Encapsulates the parameters needed to spawn the relayer supervisor.

In the future, other methods that correspond to the relayer CLI can also be added here.

Fields

config_path: PathBuf

The path to the relayer config saved on the filesystem.

This allows users to test the relayer manually with the config file while the test is suspended.

config: Config

The relayer Config. Use this config when spawning new supervisor using spawn_supervisor.

registry: SharedRegistry<CountingAndCachingChainHandle>

The relayer chain Registry that is shared with any running supervisor.

Use this shared registry when spawning new supervisor using spawn_supervisor.

hang_on_fail: bool

Whether the driver should hang the test when the continuation closure in with_supervisor fails.

Implementations

impl RelayerDriver

pub fn spawn_supervisor(&self) -> Result<SupervisorHandle, Error>

Spawns the relayer supervisor and return the SupervisorHandle.

pub fn with_supervisor<R>( &self, cont: impl FnOnce() -> Result<R, Error> ) -> Result<R, Error>

Spawns the relayer supervisor and then executes the provided continuation with the supervisor running.

The supervisor is stopped after the continuation returned. If hang_on_fail is set to true, the call will suspend if the continuation returns error.

Trait Implementations

impl Clone for RelayerDriver

fn clone(&self) -> RelayerDriver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ExportEnv for RelayerDriver

fn export_env(&self, writer: &mut impl EnvWriter)

Export the environment variables using the given EnvWriter.