Struct Options 

#[non_exhaustive]
pub struct Options {
    pub timeout: Duration,
    /* private fields */
}

Options of init_with.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

timeout: Duration

How long connecting and every transfer may wait for a peer before failing with an error naming it. Default 30 s (NUVEC_DISTRIBUTED_TIMEOUT, in seconds, for init).

Implementations

impl Options

pub fn timeout(self, timeout: Duration) -> Self

Sets the timeout.

pub fn key(self, secret: impl AsRef<[u8]>) -> Self

Authenticates the side channel’s connections with this pre-shared secret (at least 16 bytes, the same on every rank; NUVEC_DISTRIBUTED_KEY for init).

pub fn side_channel( self, all_gather: impl Fn(&[u8]) -> Result<Vec<u8>> + Send + Sync + 'static, ) -> Self

Exchanges the connection details through all_gather instead of the coordinator’s TCP star, as MLX’s all_gather_factory: it takes this rank’s bytes and returns every rank’s (equal lengths), concatenated in rank order.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.