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, Strategy};
let config = RuntimeConfig::default().set_strategy(Strategy::Random);

Implementations

impl RuntimeConfig

pub fn new() -> Self

Create a new default config.

pub fn strategy(&self) -> Strategy

Get the current strategy.

See Strategy for more information about choosing a strategy.

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) -> bool

Get if a global redis will be enabled.

pub fn postgres(&self) -> bool

Get if a global postgres will be enabled.

pub fn redis_pool_size(&self) -> u32

Get if a global redis will be enabled.

pub fn postgres_pool_size(&self) -> u32

Get if a global postgres will be enabled.

pub fn pubsub(&self) -> bool

Get if a global pubsub will be enabled.

pub fn http_client_builder(&self) -> ClientBuilder

Get if a global pubsub will be enabled.

pub fn task_queue(&self) -> bool

Get if a global task_queue will be enabled.

pub fn task_queue_max_concurrent_tasks(&self) -> usize

Get maximum number of concurrent tasks to pull from queue.

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_module(&self) -> Option<Text>

Get the gql module 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_strategy(self, strategy: Strategy) -> Self

Sets the strategy for distributing tasks onto a coroutine thread.

Default: Strategy::RoundRobin

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

Sets whether to start with python.

Default: true

pub fn set_redis(self, redis: bool) -> Self

Sets whether to start with a global Redis pool.

Default: false

pub fn set_postgres(self, postgres: bool) -> Self

Sets whether to start with a global Postgres pool.

Default: false

pub fn set_postgres_pool_size(self, pool_size: u32) -> Self

Sets the max size of postgres pool. Also enables postgres if not enabled already.

Default: 10

pub fn set_redis_pool_size(self, pool_size: u32) -> Self

Sets the max size of redis pool. Also enables redis if not enabled already.

Default: 10

pub fn set_pubsub(self, pubsub: bool) -> Self

Sets whether to start with a global PubSubClient.

Default: false

pub fn set_http_client_builder_fn<F: Fn() -> ClientBuilder + 'static>(
    self,
    builder: F
) -> Self

Set a constructor function for the HTTP ClientBuilder

Default: ClientBuilder::new

pub fn set_task_queue(self, task_queue: bool) -> Self

Sets whether to start with a global TaskQueue.

Default: false

pub fn set_task_queue_concurrent_tasks(self, max_workers: usize) -> Self

Sets the number of tasks to run concurrently from the queue. Sets task_queue to true.

Default: num_cpu * 4

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 set_gql_schema_class<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 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.