artichoke_backend/
load_path.rs

1//! Virtual file system.
2//!
3//! Artichoke proxies all file system access through a virtual file system. The
4//! file system can store Ruby sources and [extension hooks] in memory and will
5//! support proxying to the host file system for reads and writes.
6//!
7//! Artichoke uses the virtual file system to track metadata about loaded
8//! features.
9//!
10//! Artichoke has several virtual file system implementations. Only some of them
11//! support reading from the system file system.
12//!
13//! [extension hooks]: ExtensionHook
14
15use crate::Artichoke;
16use crate::error::Error;
17
18#[cfg(feature = "load-path-native-file-system-loader")]
19mod hybrid;
20mod memory;
21#[cfg(feature = "load-path-native-file-system-loader")]
22mod native;
23
24#[cfg(feature = "load-path-native-file-system-loader")]
25pub use hybrid::Hybrid;
26pub use memory::Memory;
27#[cfg(feature = "load-path-native-file-system-loader")]
28pub use native::Native;
29
30/// Directory at which Ruby sources and extensions are stored in the virtual
31/// file system.
32///
33/// `RUBY_LOAD_PATH` is the default current working directory for
34/// [`Memory`] file systems.
35///
36/// If the `load-path-native-file-system-loader` feature is enabled, the file
37/// system will locate the path on a [`Memory`] file system.
38#[cfg(not(windows))]
39pub const RUBY_LOAD_PATH: &str = "/artichoke/virtual_root/src/lib";
40
41/// Directory at which Ruby sources and extensions are stored in the virtual
42/// file system.
43///
44/// `RUBY_LOAD_PATH` is the default current working directory for
45/// [`Memory`] file systems.
46///
47/// [`Hybrid`] file systems locate the path on a [`Memory`] file system.
48#[cfg(windows)]
49pub const RUBY_LOAD_PATH: &str = "c:/artichoke/virtual_root/src/lib";
50
51/// Function type for extension hooks stored in the virtual file system.
52///
53/// This signature is equivalent to the signature for [`File::require`] as
54/// defined by the `artichoke-backend` implementation of [`LoadSources`].
55///
56/// [`File::require`]: artichoke_core::file::File::require
57/// [`LoadSources`]: crate::core::LoadSources
58pub type ExtensionHook = fn(&mut Artichoke) -> Result<(), Error>;
59
60#[cfg(all(feature = "load-path-native-file-system-loader", not(any(test, doctest))))]
61pub type Adapter = Hybrid;
62#[cfg(any(not(feature = "load-path-native-file-system-loader"), test, doctest))]
63pub type Adapter = Memory;
artichoke_backend/load_path.rs

artichoke_backend/
load_path.rs
