Struct jlrs::runtime::builder::AsyncRuntimeBuilder

pub struct AsyncRuntimeBuilder<R>
where
    R: AsyncRuntime,
{ /* private fields */ }

Build the async runtime backed by some runtime R.

Implementations

impl<R> AsyncRuntimeBuilder<R>

where R: AsyncRuntime,

pub fn n_threads(self, n: usize) -> Self

Set the number of threads Julia can use.

If it’s set to 0, the default value, the number of threads is the number of CPU cores.

NB: When the nightly or beta feature is enabled, this sets the number of threads allocated to the :default pool.

pub fn n_interactive_threads(self, n: usize) -> Self

Set the number of threads allocated to the :interactive pool.

If it’s set to 0, the default value, no threads are allocated to this pool.

pub fn n_worker_threads(self, n: usize) -> Self

Set the number of worker threads jlrs creates in addition to the runtime thread.

If it’s set to 0, the default value, no worker threads are created.

pub fn channel_capacity(self, capacity: NonZeroUsize) -> Self

Set the capacity of the channel used to communicate with the async runtime.

The default value is 16.

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

Set the receive timeout of the channel used to communicate with the async runtime.

If no message is received before the timeout occurs, the async runtime yields control to Julia to ensure the scheduler and garbage collector can run, and events are processed periodically.

The default value is 1 millisecond.

pub fn image<P, Q>(self, julia_bindir: P, image_path: Q) -> Self

where P: AsRef<Path> + Send + 'static, Q: AsRef<Path> + Send + 'static,

Use a custom system image.

You must provide two arguments to use a custom system image, julia_bindir and image_path. The first is the absolute path to a directory that contains a compatible Julia binary (eg ${JULIA_DIR}/bin), the second is the path to a system image.

A custom system image can be created with PackageCompiler.

pub fn install_jlrs(self, install: InstallJlrsCore) -> Self

Enable or disable automatically installing JlrsCore.

In order to function correctly, jlrs requires that the JlrsCore package is installed. By default, this package is automatically installed if it hasn’t been installed yet.

pub unsafe fn start<const N: usize>( self ) -> JlrsResult<(AsyncJulia<R>, JoinHandle<JlrsResult<()>>)>

Initialize Julia on another thread.

You must set the maximum number of concurrent tasks with the N const generic.

pub unsafe fn start_async<const N: usize>( self ) -> JlrsResult<(AsyncJulia<R>, R::RuntimeHandle)>

Initialize Julia as a blocking task.

You must set the maximum number of concurrent tasks with the N const generic.