artichoke_backend::load_path

Struct Hybrid

Source
pub struct Hybrid { /* private fields */ }

Implementations§

Source§

impl Hybrid

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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§

Source§

impl Debug for Hybrid

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Hybrid

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Hybrid

§

impl RefUnwindSafe for Hybrid

§

impl Send for Hybrid

§

impl Sync for Hybrid

§

impl Unpin for Hybrid

§

impl UnwindSafe for Hybrid

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.

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, 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.