Struct MlxClosure 

pub struct MlxClosure(/* private fields */);

Owned MLX closure handle released exactly once through the C API.

Implementations

impl MlxClosure

pub fn compiled(&self, shapeless: bool) -> Result<Self, MlxCError>

Wraps the closure so every call is compiled and cached by MLX.

pub fn checkpointed(&self) -> Result<Self, MlxCError>

Wraps the closure so calls stop at the traced boundary, matching MLX’s checkpoint transform.

pub fn with_custom_vjp( &self, backward: &MlxClosureCustom, ) -> Result<Self, MlxCError>

Wraps the closure with a custom vector-Jacobian product.

pub fn with_custom_rules( &self, backward: &MlxClosureCustom, forward: &MlxClosureCustomJvp, linearize: &MlxClosureCustomVmap, ) -> Result<Self, MlxCError>

Wraps the closure with custom VJP, JVP, and VMAP rules.

impl MlxClosure

pub fn compile_detailed( &self, function_identity: usize, shapeless: bool, constants: &[u64], ) -> Result<Self, MlxCError>

Compiles the closure with explicit tracing details into the process compile cache.

The constants array is the identity MLX uses for compile-time constant folding.

Errors

Returns the captured MLX-C description when compilation fails.

impl MlxClosure

pub fn from_fn<F>(callback: F) -> Result<Self, MlxCError>

where F: FnMut(&[MlxArray]) -> Result<Vec<MlxArray>, MlxCError> + 'static,

Builds an owned closure from a Rust callable mapping input arrays to output arrays.

pub fn empty() -> Self

Creates an empty closure handle.

pub fn set(&mut self, source: &Self) -> Result<(), MlxCError>

Copies the source closure handle into this handle.

pub fn apply(&self, input: &MlxArrayVector) -> Result<MlxArrayVector, MlxCError>

Applies the closure to the input arrays on the caller’s behalf.

Errors

Returns the captured MLX-C description when application fails.

Trait Implementations

impl Debug for MlxClosure

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

Formats the value using the given formatter.

impl Drop for MlxClosure

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.