Struct rustyscript::Module

source ·
pub struct Module { /* private fields */ }
Expand description

Represents a pice of javascript for execution. Must be ESM formatted

Implementations§

source§

impl Module

source

pub fn new(filename: &str, 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!');");
source

pub fn load(filename: &str) -> 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.

Example
use rustyscript::Module;

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

pub fn load_dir(directory: &str) -> 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.

Example
use rustyscript::Module;

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

pub fn filename(&self) -> &str

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());
source

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§

source§

impl Clone for Module

source§

fn clone(&self) -> Module

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Module

source§

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

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

impl Default for Module

source§

fn default() -> Module

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

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Module

source§

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

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

impl PartialEq for Module

source§

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

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

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.
source§

impl Serialize for Module

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Module

source§

impl StructuralEq for Module

source§

impl StructuralPartialEq for Module

Auto Trait Implementations§

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> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

§

type Output = T

Should always be Self
§

impl<T> Serializable for T
where T: Serialize,

§

fn to_v8<'a>( &mut self, scope: &mut HandleScope<'a> ) -> Result<Local<'a, Value>, Error>

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Send for T
where T: ?Sized,

§

impl<T> Sync for T
where T: ?Sized,