Struct ApplicationContext

pub struct ApplicationContext {
    pub options: MainOptions,
    /* private fields */
}

Fields

options: MainOptions

Implementations

impl ApplicationContext

pub fn new(options: MainOptions) -> Self

Construct an empty ApplicationContext. Initialization must be performed post-construction.

pub fn from_options(options: &MainOptions) -> Result<Self, GardenError>

Initialize an ApplicationContext and Configuration from cli::MainOptions.

pub fn from_path_and_root( path: &dyn AsRef<Path>, root: Option<&Path>, ) -> Result<Self, GardenError>

Construct an ApplicationContext from a path and root using default MainOptions.

pub fn from_path(path: &dyn AsRef<Path>) -> Result<Self, GardenError>

Construct an ApplicationContext from a path using default MainOptions.

pub fn from_path_string(path: &str) -> Result<Self, GardenError>

Construct an ApplicationContext from a path using default MainOptions.

pub fn from_string(string: &str) -> Result<Self, GardenError>

Construct an ApplicationContext from a string using default MainOptions.

pub fn get_config(&self, id: ConfigId) -> &Configuration

pub fn get_root_id(&self) -> ConfigId

pub fn get_root_config(&self) -> &Configuration

pub fn get_root_config_mut(&self) -> &mut Configuration

Trait Implementations

impl Clone for ApplicationContext

ApplicationContext performs a deepcopy of its internal arena to ensure that none of its internally-mutable data is shared between threads.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApplicationContext

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

Formats the value using the given formatter.

impl Sync for ApplicationContext

Safety: ApplicationContext is not thread-safe due to its use of internal mutability. Furthermore, we cannot use mutexes internally due to our use of Rayon and fundamental issues. that lead to deadlocks when performing parallel computations.

ApplicationContext is designed to be cloned whenever operations are performed across multiple threads. The RefCells stored inside of the Variable struct are used to provider interior mutability. Even though the methods are const, the methods mutate interior data in a non-thread-safe manner.

Likewise, even if we were able to hold mutexes when using Rayon, our access pattern is not logically sound were we to attempt to evaluate data in parallel. The evaluation machinery is context-specific and can lead to different results dependending on which TreeContext initiated the eval. This is the core reason why cloning is required in order to evaluate variables across multiple threads.