Enum Bootstrap

pub enum Bootstrap {
    Proc {
        proc_id: ProcId,
        backend_addr: ChannelAddr,
        callback_addr: ChannelAddr,
        config: Option<Attrs>,
    },
    Host {
        addr: ChannelAddr,
        command: Option<BootstrapCommand>,
        config: Option<Attrs>,
    },
    V0ProcMesh,
}

Bootstrap configures how a mesh process starts up.

Both Proc and Host variants may include an optional configuration snapshot (hyperactor::config::Attrs). This snapshot is serialized into the bootstrap payload and made available to the child. Interpretation and application of that snapshot is up to the child process; if omitted, the child falls back to environment/default values.

Variants

Proc

“v1” proc bootstrap

Fields

proc_id: ProcId

The ProcId of the proc to be bootstrapped.

backend_addr: ChannelAddr

The backend address to which messages are forwarded. See hyperactor::host for channel topology details.

callback_addr: ChannelAddr

The callback address used to indicate successful spawning.

config: Option<Attrs>

Optional config snapshot (hyperactor::config::Attrs) captured by the parent. If present, the child installs it as the Runtime layer so the parent’s effective config takes precedence over Env/File/Defaults.

Host

Host bootstrap. This sets up a new Host, managed by a crate::v1::host_mesh::mesh_agent::HostMeshAgent.

Fields

addr: ChannelAddr

The address on which to serve the host.

command: Option<BootstrapCommand>

If specified, use the provided command instead of BootstrapCommand::current.

config: Option<Attrs>

Optional config snapshot (hyperactor::config::Attrs) captured by the parent. If present, the child installs it as the Runtime layer so the parent’s effective config takes precedence over Env/File/Defaults.

V0ProcMesh

Implementations

impl Bootstrap

pub fn get_from_env() -> Result<Option<Self>>

Get a bootstrap configuration from the environment; returns None if the environment does not specify a boostrap config.

pub fn to_env(&self, cmd: &mut Command)

Inject this bootstrap configuration into the environment of the provided command.

pub async fn bootstrap(self) -> Error

Bootstrap this binary according to this configuration. This either runs forever, or returns an error.

pub async fn bootstrap_or_die(self) -> !

A variant of bootstrap that logs the error and exits the process if bootstrapping fails.

Trait Implementations

impl Clone for Bootstrap

fn clone(&self) -> Bootstrap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bootstrap

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

Formats the value using the given formatter.

impl Default for Bootstrap

fn default() -> Bootstrap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bootstrap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Bootstrap

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

where __S: Serializer,

Serialize this value into the given Serde serializer.