Struct RubyCore

Source

pub struct RubyCore { /* private fields */ }

Expand description

A Ruby load path builder that prepares paths for in-memory Ruby Core and Ruby Standard Library sources.

Artichoke embeds Ruby sources and native extensions into an in-memory file system. This in-memory file system is addressed at a virtual mount point, which must be located within the VM $LOAD_PATH so they may be loaded by the require subsystem.

Like the site directories in MRI, these paths are the lowest priority load paths and should appear at the end of the $LOAD_PATH.

Paths earlier in the sequence returned from load_path have higher priority.

use mezzaluna_load_path::RubyCore;

let core_loader = RubyCore::new();
// Load path contains 2 entries: one for Ruby Core sources and one for
// Ruby Standard Library sources.
assert_eq!(core_loader.load_path().len(), 2);

Implementations§

Source §

impl RubyCore

Source

pub const fn new() -> Self

Create a new load path builder that reads from the RUBYLIB environment variable.

The RUBYLIB environment variable is read only once at the time this method is called. The resolved load path is immutable.

This method returns None if there are errors resolving the RUBYLIB environment variable, if the RUBYLIB environment variable is not set, or if the given RUBYLIB environment variable only contains empty paths.

§Examples

use mezzaluna_load_path::RubyCore;

let loader = RubyCore::new();

Source

pub fn core_load_path(self) -> &'static Path

Return a reference to the load path for sources in the Ruby Core library.

Features in Ruby Core have the lowest priority, so the returned path should appear last in $LOAD_PATH.

§Examples

use std::path::Path;
use mezzaluna_load_path::RubyCore;

let loader = RubyCore::new();

if cfg!(windows) {
    assert_eq!(
        loader.core_load_path(),
        Path::new("c:/artichoke/virtual_root/site/core/lib"),
    );
} else {
    assert_eq!(
        loader.core_load_path(),
        Path::new("/artichoke/virtual_root/site/core/lib"),
    );
}

Source

pub fn stdlib_load_path(self) -> &'static Path

Return a reference to the load path for sources in the Ruby Standard Library.

Features in Ruby Standard Library have low priority, so the returned path should appear second to last in $LOAD_PATH (only ahead of the core load path).

§Examples

use std::path::Path;
use mezzaluna_load_path::RubyCore;

let loader = RubyCore::new();

if cfg!(windows) {
    assert_eq!(
        loader.stdlib_load_path(),
        Path::new("c:/artichoke/virtual_root/site/stdlib/lib"),
    );
} else {
    assert_eq!(
        loader.stdlib_load_path(),
        Path::new("/artichoke/virtual_root/site/stdlib/lib"),
    );
}

Source

pub fn load_path(self) -> [&'static Path; 2]

Return a reference to the paths in $LOAD_PATH parsed by this builder.

Because the site paths have the lowest priority when loading features, the returned paths should appear last in $LOAD_PATH.

§Examples

use mezzaluna_load_path::RubyCore;

let loader = RubyCore::new();
assert_eq!(
    loader.load_path(),
    [loader.stdlib_load_path(), loader.core_load_path()],
);