Trait artichoke::prelude::LoadSources
source · [−]pub trait LoadSources {
type Artichoke;
type Error;
type Exception;
fn def_file_for_type<P, T>(&mut self, path: P) -> Result<(), Self::Error>
where
P: AsRef<Path>,
T: File<Artichoke = Self::Artichoke, Error = Self::Exception>;
fn def_rb_source_file<P, T>(
&mut self,
path: P,
contents: T
) -> Result<(), Self::Error>
where
P: AsRef<Path>,
T: Into<Cow<'static, [u8]>>;
fn resolve_source_path<P>(
&self,
path: P
) -> Result<Option<Vec<u8, Global>>, Self::Error>
where
P: AsRef<Path>;
fn source_is_file<P>(&self, path: P) -> Result<bool, Self::Error>
where
P: AsRef<Path>;
fn load_source<P>(&mut self, path: P) -> Result<Loaded, Self::Error>
where
P: AsRef<Path>;
fn require_source<P>(&mut self, path: P) -> Result<Required, Self::Error>
where
P: AsRef<Path>;
fn read_source_file_contents<P>(
&self,
path: P
) -> Result<Cow<'_, [u8]>, Self::Error>
where
P: AsRef<Path>;
}
Expand description
Load Ruby sources and Rust extensions into an interpreter.
Required Associated Types
Required Methods
Add a Rust extension hook to the virtual file system. A stub Ruby file is
added to the file system and File::require
will dynamically define
Ruby items when invoked via Kernel#require
.
If path
is a relative path, the Ruby source is added to the
file system relative to RUBY_LOAD_PATH
. If the path is absolute, the
file is placed directly on the file system. Ancestor directories are
created automatically.
Errors
If the underlying file system is inaccessible, an error is returned.
If writes to the underlying file system fail, an error is returned.
Add a Ruby source to the virtual file system.
If path
is a relative path, the Ruby source is added to the
file system relative to RUBY_LOAD_PATH
. If the path is absolute, the
file is placed directly on the file system. Ancestor directories are
created automatically.
Errors
If the underlying file system is inaccessible, an error is returned.
If writes to the underlying file system fail, an error is returned.
Test for a source file at a path and return the absolute path of the resolved file.
Query the underlying virtual file system to check if path
points to a
source file.
This function returns None
if path
does not exist in the virtual
file system.
Errors
If the underlying file system is inaccessible, an error is returned.
Test for a source file at a path.
Query the underlying virtual file system to check if path
points to a
source file.
This function returns false
if path
does not exist in the virtual
file system.
Errors
If the underlying file system is inaccessible, an error is returned.
Load source located at the given path.
Query the underlying virtual file system for a source file and load it onto the interpreter. This loads files with the following steps:
- Retrieve and execute the extension hook, if any.
- Read file contents and
eval
them.
If this function returns without error, the feature specified by path
is loaded, but is not added to $LOADED_FEATURES
. This function is
equivalent to Kernel#load
.
Errors
If the underlying file system is inaccessible, an error is returned.
If reads to the underlying file system fail, an error is returned.
If path
does not point to a source file, an error is returned.
If the source file at path
has no contents, an error is returned.
Require source located at the given path.
Query the underlying virtual file system for a source file and require it onto the interpreter. This requires files with the following steps:
- Retrieve and execute the extension hook, if any.
- Read file contents and
eval
them. - Mark file as required and add to
$LOADED_FEATURES
.
If this function returns without error, the feature specified by path
is loaded and added to $LOADED_FEATURES
. This function is equivalent
to Kernel#require
.
Implementations should ensure that this method returns
Ok(Required::Success)
at most once. Subsequent Ok(_)
return values should include Required::AlreadyRequired
. See the
documentation of Required
for more details.
Errors
If the underlying file system is inaccessible, an error is returned.
If reads to the underlying file system fail, an error is returned.
If path
does not point to a source file, an error is returned.
If the source file at path
has no contents, an error is returned.
Retrieve file contents for a source file.
Query the underlying virtual file system for the file contents of the
source file at path
.
Errors
If the underlying file system is inaccessible, an error is returned.
If reads to the underlying file system fail, an error is returned.
If path
does not point to a source file, an error is returned.