Environment

Struct Environment 

Source
pub struct Environment { /* private fields */ }
Expand description

Contains state and host platform interfaces shared by all MeTTa runners. This includes config settings and logger

Generally there will be only one environment object needed, and it can be accessed by calling the Self::common_env method

Implementations§

Source§

impl Environment

Source

pub fn common_env() -> &'static Self

Returns a reference to the shared common Environment

Source

pub fn config_dir(&self) -> Option<&Path>

Returns the Path to the config dir, in an OS-specific location

Source

pub fn caches_dir(&self) -> Option<&Path>

Returns the Path to a directory where the MeTTa runner can put persistent caches

NOTE: The default location of the caches_dir dir is within cfg_dir, but if may be overridden with EnvBuilder::set_caches_dir.

Source

pub fn working_dir(&self) -> Option<&Path>

Returns the Path to the environment’s working_dir

NOTE: The Environment’s working_dir is not the same as the process working directory, and changing the process’s working directory will not affect the environment

Source

pub fn initialization_metta_file_path(&self) -> Option<&Path>

Returns the path to the init.metta file, that is run to initialize a MeTTa runner and customize the MeTTa environment

Source

pub fn catalogs(&self) -> impl Iterator<Item = &dyn ModuleCatalog> + '_

Returns the ModuleCatalogs from the Environment, in search priority order

Source

pub fn fs_mod_formats(&self) -> impl Iterator<Item = &dyn FsModuleFormat> + '_

Returns the FsModuleFormats from the Environment, in priority order

Trait Implementations§

Source§

impl Debug for Environment

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> RefOrMove<T> for T

§

fn as_value(self) -> T

§

fn as_ref(&self) -> &T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more