Struct rustsynth::vsscript::Environment

pub struct Environment { /* private fields */ }

A wrapper for the VSScript environment.

Implementations

impl Environment

pub fn new(core: &CoreRef<'_>) -> Result<Self, Error>

Creates an empty script environment.

Useful if it is necessary to set some variable in the script environment before evaluating any scripts.

pub fn from_script(core: &CoreRef<'_>, script: &str) -> Result<Self, Error>

Creates a script environment and evaluates a script contained in a string.

pub fn from_file<P: AsRef<Path>>( core: &CoreRef<'_>, path: P ) -> Result<Self, Error>

Creates a script environment and evaluates a script contained in a file.

pub fn eval_script(&mut self, script: &str) -> Result<(), Error>

Evaluates a script contained in a string.

pub fn eval_file<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Error>

Evaluates a script contained in a file.

pub fn get_variable(&self, name: &str, map: &mut Map<'_>) -> Result<(), Error>

Retrieves a variable from the script environment.

pub fn set_variables(&self, variables: &Map<'_>) -> Result<(), Error>

Sets variables in the script environment.

pub fn get_output(&self, index: usize) -> Option<Node<'_>>

pub fn get_output_alpha(&self, index: usize) -> Option<Node<'_>>

pub fn clear_output(&self, index: usize) -> Result<(), Error>

Trait Implementations

impl Debug for Environment

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

Formats the value using the given formatter.

impl Drop for Environment

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Environment

impl Sync for Environment