Struct artichoke_backend::load_path::Hybrid
source · pub struct Hybrid { /* private fields */ }Implementations§
source§impl Hybrid
impl Hybrid
sourcepub fn new() -> Self
pub fn new() -> Self
Create a new hybrid virtual file system.
This file system allows access to the host file system with an in-memory
file system mounted at RUBY_LOAD_PATH.
sourcepub fn resolve_file(&self, path: &Path) -> Option<Vec<u8>>
pub fn resolve_file(&self, path: &Path) -> Option<Vec<u8>>
Check whether path points to a file in the virtual file system and
return the absolute path if it exists.
This API is infallible and will return None for non-existent paths.
sourcepub fn is_file(&self, path: &Path) -> bool
pub fn is_file(&self, path: &Path) -> bool
Check whether path points to a file in the virtual file system.
This API is infallible and will return false for non-existent paths.
sourcepub fn read_file(&self, path: &Path) -> Result<Vec<u8>>
pub fn read_file(&self, path: &Path) -> Result<Vec<u8>>
Read file contents for the file at path.
Returns a byte slice of complete file contents. If path is relative,
it is absolutized relative to the current working directory of the
virtual file system.
§Errors
If path does not exist, an io::Error with error kind
io::ErrorKind::NotFound is returned.
sourcepub fn write_file(&mut self, path: &Path, buf: Cow<'static, [u8]>) -> Result<()>
pub fn write_file(&mut self, path: &Path, buf: Cow<'static, [u8]>) -> Result<()>
Write file contents into the virtual file system at path.
Writes the full file contents. If any file contents already exist at
path, they are replaced. Extension hooks are preserved.
Only the Memory file system at RUBY_LOAD_PATH is writable.
§Errors
If access to the Memory file system returns an error, the error is
returned. See Memory::write_file.
sourcepub fn get_extension(&self, path: &Path) -> Option<ExtensionHook>
pub fn get_extension(&self, path: &Path) -> Option<ExtensionHook>
Retrieve an extension hook for the file at path.
This API is infallible and will return None for non-existent paths.
sourcepub fn register_extension(
&mut self,
path: &Path,
extension: ExtensionHook
) -> Result<()>
pub fn register_extension( &mut self, path: &Path, extension: ExtensionHook ) -> Result<()>
Write extension hook into the virtual file system at path.
If any extension hooks already exist at path, they are replaced. File
contents are preserved.
This function writes all extensions to the virtual file system. If the given path does not map to the virtual file system, the extension is unreachable.
§Errors
If the given path does not resolve to the virtual file system, an error is returned.
sourcepub fn is_required(&self, path: &Path) -> Option<bool>
pub fn is_required(&self, path: &Path) -> Option<bool>
Check whether a file at path has been required already.
This API is infallible and will return false for non-existent paths.
sourcepub fn mark_required(&mut self, path: &Path) -> Result<()>
pub fn mark_required(&mut self, path: &Path) -> Result<()>
Mark a source at path as required on the interpreter.
This metadata is used by Kernel#require and friends to enforce that
Ruby sources are only loaded into the interpreter once to limit side
effects.
§Errors
If path does not exist, an io::Error with error kind
io::ErrorKind::NotFound is returned.