Struct rustyscript::Module

pub struct Module { /* private fields */ }

Represents a pice of javascript for execution.

Implementations

impl Module

pub fn new(filename: impl AsRef<Path>, contents: &str) -> Self

Creates a new Module instance with the given filename and contents. If filename is relative it will be resolved to the current working dir at runtime

Arguments

• filename - A string representing the filename of the module.
• contents - A string containing the contents of the module.

Returns

A new Module instance.

Example

use rustyscript::Module;

let module = Module::new("module.js", "console.log('Hello, World!');");

pub fn load(filename: impl AsRef<Path>) -> Result<Self, Error>

Loads a Module instance from a file with the given filename.

Arguments

• filename - A string representing the filename of the module file.

Returns

A Result containing the loaded Module instance or an std::io::Error if there are issues reading the file.

Errors

Will return an error if the file cannot be read.

Example

use rustyscript::Module;

let module = Module::load("src/ext/rustyscript/rustyscript.js")?;

pub fn load_dir(directory: impl AsRef<Path>) -> Result<Vec<Self>, Error>

Attempt to load all .js/.ts files in a given directory Fails if any of the files cannot be loaded

Arguments

• directory - A string representing the target directory

Returns

A Result containing a vec of loaded Module instances or an std::io::Error if there are issues reading a file.

Errors

Will return an error if the directory cannot be read, or if any contained file cannot be read.

Example

use rustyscript::Module;

let all_modules = Module::load_dir("src/ext/rustyscript")?;

pub fn filename(&self) -> &Path

Returns the filename of the module.

Returns

A reference to a string containing the filename.

Example

use rustyscript::Module;

let module = Module::new("module.js", "console.log('Hello, World!');");
println!("Filename: {:?}", module.filename());

pub fn contents(&self) -> &str

Returns the contents of the module.

Returns

A reference to a string containing the module contents.

Example

use rustyscript::Module;

let module = Module::new("module.js", "console.log('Hello, World!');");
println!("Module Contents: {}", module.contents());

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Module

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Module

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Module

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

Formats the value using the given formatter.

impl PartialEq for Module

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Module

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Module

impl StructuralPartialEq for Module