Struct puff_rs::runtime::RuntimeConfig

pub struct RuntimeConfig { /* private fields */ }

Controls options for running puff tasks.

See the Readme’s Architecture Section for more information about the multi-threaded tokio runtime, coroutine threads, and blocking threads to get a better understanding of these options. The default options should be sane for most applications.

Examples

use puff_rs::runtime::RuntimeConfig;
let config = RuntimeConfig::default();

Implementations

impl RuntimeConfig

pub fn new() -> Self

Create a new default config.

pub fn max_blocking_threads(&self) -> usize

Get the current max_blocking_threads

This is the number of threads that can be spawned for blocking tasks.

pub fn tokio_worker_threads(&self) -> usize

Get the current tokio_worker_threads

This is the number of threads that Tokio will use to execute things like DB queries, HTTP Servers, and IO. These threads can share and distribute tasks amongst themselves.

pub fn blocking_task_keep_alive(&self) -> Duration

Get the current blocking_task_keep_alive

The maximum time a blocking thread can keep executing before being killed.

pub fn python(&self) -> bool

pub fn redis(&self) -> &HashMap<Text, RedisOpts>

Get if a global redis will be enabled.

pub fn postgres(&self) -> &HashMap<Text, PostgresOpts>

Get if a global postgres will be enabled.

pub fn pubsub(&self) -> &HashMap<Text, PubSubOpts>

Get if a global pubsub will be enabled.

pub fn http_client_builder(&self) -> &HashMap<Text, HttpClientOpts>

Get if a global pubsub will be enabled.

pub fn task_queue(&self) -> &HashMap<Text, TaskQueueOpts>

Get if a global task_queue will be enabled.

pub fn greenlets(&self) -> bool

Get if greenlets will be enabled.

pub fn asyncio(&self) -> bool

Get if asyncio will be enabled.

pub fn gql_modules(&self) -> &HashMap<Text, GqlOpts>

Get the gql modules that will be enabled.

pub fn python_paths(&self) -> Vec<Text>

Get all python paths to add to environment.

pub fn env_vars(&self) -> Vec<(Text, Text)>

Get all env vars to add to environment.

pub fn apply_env_vars(&self)

Apply env vars to add to environment.

pub fn global_state(&self) -> PyResult<PyObject>

Get the global Python object

pub fn set_tokio_worker_threads(self, tokio_worker_threads: usize) -> Self

Set the tokio_worker_threads for coroutines.

Default: num_cpus

pub fn set_blocking_task_keep_alive(
    self,
    blocking_task_keep_alive: Duration
) -> Self

Set the blocking_task_keep_alive.

Default: 30 seconds

pub fn set_max_blocking_threads(self, max_blocking_threads: usize) -> Self

Set the max_blocking_threads.

Default: 1024

pub fn set_python(self, python: bool) -> Self

Sets whether to start with python.

Default: true

pub fn add_default_redis(self) -> Self

Sets whether to start with a global Redis pool.

pub fn add_named_redis<N: Into<Text>>(self, name: N, opts: RedisOpts) -> Self

Configure an additional named redis pool.

pub fn add_default_postgres(self) -> Self

Sets whether to start with a global Postgres pool.

pub fn add_named_postgres<N: Into<Text>>(
    self,
    name: N,
    opts: PostgresOpts
) -> Self

Configure an additional named Postgres pool.

pub fn add_default_pubsub(self) -> Self

Sets whether to start with a global PubSubClient.

pub fn add_named_pubsub<N: Into<Text>>(self, name: N, config: PubSubOpts) -> Self

Sets whether to start with a global PubSubClient.

pub fn add_http_client(self) -> Self

Add global HTTP Client

pub fn add_named_http_client<N: Into<Text>>(
    self,
    name: N,
    opts: HttpClientOpts
) -> Self

Add named HTTP Client

pub fn add_default_task_queue(self) -> Self

Sets whether to start with a global TaskQueue.

pub fn add_named_task_queue<N: Into<Text>>(
    self,
    name: N,
    opts: TaskQueueOpts
) -> Self

Sets whether to start with a global TaskQueue.

pub fn set_greenlets(self, greenlets: bool) -> Self

Sets whether to use greenlets when executing python.

Default: true

pub fn set_asyncio(self, asyncio: bool) -> Self

Sets whether to use greenlets when executing python.

Default: false

pub fn add_gql_schema<T: Into<Text>>(self, schema_module_path: T) -> Self

If provided, will load the GraphQl configuration from the module path to the Schema.

Default: None

pub fn add_gql_schema_named<N: Into<Text>>(self, name: N, opts: GqlOpts) -> Self

If provided, will load an additional GraphQl configuration from the path to the Schema.

Default: None

pub fn set_global_state_fn<F: Fn(Python<'_>) -> PyResult<PyObject> + Send + Sync + 'static>(
    self,
    f: F
) -> Self

Run a function in a python context and set the result as the global state for Python.

Default: None

pub fn add_env<K: Into<Text>, V: Into<Text>>(self, k: K, v: V) -> Self

Add the current directory to the PYTHONPATH

pub fn add_cwd_to_python_path(self) -> Self

Add the current directory to the PYTHONPATH

pub fn add_python_path<T: Into<Text>>(self, path: T) -> Self

Add the relative directory to the PYTHONPATH

Trait Implementations

impl Clone for RuntimeConfig

fn clone(&self) -> RuntimeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RuntimeConfig

fn default() -> Self

Returns the “default value” for a type.