Struct Script

pub struct Script { /* private fields */ }

Implementations

impl Script

pub fn new(core: Option<&Core>, vssapi: VssApi, api: Api) -> Self

Creates a new script instance.

Panics

Panics if the script creation fails.

pub fn get_api(&self) -> Api

pub fn core(&self) -> Result<CoreRef<'_>, ScriptError>

Returns a reference to the core associated with this script.

Errors

Returns an error message if the core could not be retrieved.

pub fn evaluate( &self, buffer: &CStr, filename: &CStr, ) -> Result<(), ScriptError>

Evaluates a script buffer with the given filename.

Errors

Returns an error message if the script evaluation fails.

pub fn evaluate_file(&self, filename: &CStr) -> Result<(), ScriptError>

Evaluates a script from a file.

Errors

Returns an error message if the script evaluation fails.

pub fn get_output(&self, index: c_int) -> Result<OutputNode, ScriptError>

Gets the output node at the specified index.

Errors

Returns a ScriptError if the output node could not be retrieved.

Trait Implementations

impl Clone for Script

fn clone(&self) -> Script

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Script

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

Formats the value using the given formatter.

impl Drop for Script

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Script

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Script

fn eq(&self, other: &Script) -> 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 Eq for Script

impl StructuralPartialEq for Script