Struct ModuleDirectory 

pub struct ModuleDirectory { /* private fields */ }

Available on crate feature fs only.

A module directory stored on a file system (e.g., $HOME/.asimov/modules/).

Implementations

impl ModuleDirectory

pub fn home() -> Result<Self>

Opens the default module directory in the user’s home directory.

On Unix platforms, including macOS and Linux, this is $HOME/.asimov/modules/.

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Opens a module directory from a file system path.

pub async fn iter_enabled(&self) -> Result<ModuleNameIterator>

pub async fn iter_installed(&self) -> Result<ModuleNameIterator>

pub async fn iter_manifests(&self) -> Result<ModuleManifestIterator>

pub fn join(&self, path: impl AsRef<Utf8Path>) -> Utf8PathBuf

pub fn as_str(&self) -> &str

Trait Implementations

impl AsRef<Path> for ModuleDirectory

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Utf8Path> for ModuleDirectory

Available on crate feature camino only.

fn as_ref(&self) -> &Utf8Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Utf8PathBuf> for ModuleDirectory

fn as_ref(&self) -> &Utf8PathBuf

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for ModuleDirectory

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for ModuleDirectory

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

Formats the value using the given formatter.

impl Display for ModuleDirectory

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

Formats the value using the given formatter.

impl ModuleDirectory for ModuleDirectory

fn is_installed(&self, _module_name: impl AsRef<str>) -> bool

Checks if a module is installed.

fn is_enabled(&self, _module_name: impl AsRef<str>) -> bool

Checks if a module is installed and enabled.