Struct artichoke_backend::load_path::Native

pub struct Native { /* private fields */ }

Implementations

impl Native

pub fn new() -> Self

Create a new native virtual file system.

This file system grants access to the host file system.

pub fn resolve_file(&self, path: &Path) -> Option<PathBuf>

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.

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.

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.

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.

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.

Trait Implementations

impl Debug for Native

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

Formats the value using the given formatter.

impl Default for Native

fn default() -> Native

Returns the “default value” for a type.

impl PartialEq for Native

fn eq(&self, other: &Native) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Native

impl StructuralPartialEq for Native