Struct grafbase_local_common::environment::Environment

pub struct Environment {
    pub project_path: PathBuf,
    pub project_dot_grafbase_path: PathBuf,
    pub project_grafbase_path: PathBuf,
    pub project_grafbase_schema_path: PathBuf,
    pub user_dot_grafbase_path: PathBuf,
    pub project_grafbase_registry_path: PathBuf,
}

a static representation of the current environment

must be initialized before use

Fields

project_path: PathBuf

the path of the (assumed) user project root ($PROJECT), the nearest ancestor directory with a grafbase/schema.graphql file

project_dot_grafbase_path: PathBuf

the path of $PROJECT/.grafbase/, the Grafbase local developer tool cache and database directory, in the nearest ancestor directory with grafbase/schema.graphql

project_grafbase_path: PathBuf

the path of $PROJECT/grafbase/, the Grafbase schema directory in the nearest ancestor directory with grafbase/schema.graphql

project_grafbase_schema_path: PathBuf

the path of $PROJECT/grafbase/schema.graphql, the Grafbase schema, in the nearest ancestor directory with said directory and file

user_dot_grafbase_path: PathBuf

the path of $HOME/.grafbase, the user level local developer tool cache directory

project_grafbase_registry_path: PathBuf

the path of $PROJECT/.grafbase/registry.json, the registry derived from schema.graphql, in the nearest ancestor directory with a grabase/schema.graphql file

Implementations

impl Environment

pub fn try_init() -> Result<(), CommonError>

initializes the static Environment instance

Errors

returns CommonError::ReadCurrentDirectory if the current directory path cannot be read

returns CommonError::FindGrafbaseDirectory if the grafbase directory is not found

pub fn get() -> &'static Self

returns a reference to the static Environment instance

Panics

panics if the Environment object was not previously initialized using Environment::try_init()

Trait Implementations

impl Debug for Environment

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

Formats the value using the given formatter.