Struct ServerInterface 

pub struct ServerInterface<'a> { /* private fields */ }

A safe wrapper around Adobe’s ExtendScript server interface.

This struct provides a safe and idiomatic Rust interface to the underlying C API, handling memory management, type conversions, and error handling automatically.

Implementations

impl<'a> ServerInterface<'a>

pub fn new(interface: &'a SoServerInterface, server: SoHServer) -> Self

Creates a new ServerInterface instance.

Arguments

• interface - Reference to the SoServerInterface function table
• server - Server handle for object management

pub fn server(&self) -> SoHServer

Get the server handle

pub fn raw_interface(&self) -> *const SoServerInterface

Get the raw interface pointer

pub fn dump_object(&self, h_object: SoHObject) -> c_long

Dumps the current state of an object for debugging purposes.

Arguments

• h_object - Handle to the object to dump

Returns

• ESerror_t - Error code indicating success or failure

pub fn dump_server(&self) -> c_long

Dumps the current state of the server for debugging purposes.

Returns

• ESerror_t - Error code indicating success or failure

pub fn get_live_object( &self, h_object: SoHObject, name: &str, ) -> Result<TaggedData, c_long>

Gets a property value from a live object.

Arguments

• h_object - Handle to the object
• name - Name of the property to get

Returns

• Result<TaggedData, ESerror_t> - The property value or error code

pub fn get_live_object_from_raw_address( &self, h_object: SoHObject, address: *mut c_void, ) -> Result<TaggedData, c_long>

pub fn put_live_object( &self, h_object: SoHObject, name: &str, value: &TaggedData, ) -> c_long

Sets a property value on a live object.

Arguments

• h_object - Handle to the object
• name - Name of the property to set
• value - Value to set

Returns

• ESerror_t - Error code indicating success or failure

pub fn call_live_object( &self, h_object: SoHObject, method: &str, args: &[TaggedData], ) -> Result<TaggedData, c_long>

Calls a method on a live object.

Arguments

• h_object - Handle to the object
• method - Name of the method to call
• args - Array of arguments to pass to the method

Returns

• Result<TaggedData, ESerror_t> - The return value or error code

pub fn eval(&self, script: &str) -> Result<TaggedData, c_long>

Evaluates a JavaScript script.

Arguments

• script - JavaScript code to evaluate

Returns

• Result<TaggedData, ESerror_t> - The result of evaluation or error code

pub fn tagged_data_init(&self) -> Result<TaggedData, c_long>

Initializes a new TaggedData instance.

Returns

• Result<TaggedData, ESerror_t> - The initialized TaggedData or error code

pub fn tagged_data_free(&self, data: &mut TaggedData)

Frees a TaggedData instance.

Arguments

• data - TaggedData instance to free

pub fn add_class( &self, name: &str, object_interface: &mut SoObjectInterface, ) -> c_long

Adds a new JavaScript class.

Arguments

• name - Name of the class
• object_interface - Interface implementation for the class

Returns

• ESerror_t - Error code indicating success or failure

pub fn add_method( &self, h_object: SoHObject, name: &str, id: i32, desc: &str, ) -> c_long

Adds a method to an object.

Arguments

• h_object - Handle to the object
• name - Name of the method
• id - Method ID
• desc - Method description

Returns

• ESerror_t - Error code indicating success or failure

pub fn add_methods( &self, h_object: SoHObject, names: &mut [SoCClientName], ) -> c_long

Adds multiple methods to an object.

Arguments

• h_object - Handle to the object
• names - Array of method definitions

Returns

• ESerror_t - Error code indicating success or failure

pub fn add_property( &self, h_object: SoHObject, name: &str, id: i32, desc: &str, ) -> c_long

Adds a property to an object.

Arguments

• h_object - Handle to the object
• name - Name of the property
• id - Property ID
• desc - Property description

Returns

• ESerror_t - Error code indicating success or failure

pub fn add_properties( &self, h_object: SoHObject, names: &mut [SoCClientName], ) -> c_long

Adds multiple properties to an object.

Arguments

• h_object - Handle to the object
• names - Array of property definitions

Returns

• ESerror_t - Error code indicating success or failure

pub fn get_class( &self, h_object: SoHObject, max_name_len: i32, ) -> Result<String, c_long>

Gets the class name of an object.

Arguments

• h_object - Handle to the object
• max_name_len - Maximum length of the class name

Returns

• Result<String, ESerror_t> - The class name or error code

pub fn get_server( &self, h_object: SoHObject, ) -> Result<(SoHServer, &'a SoServerInterface), c_long>

Gets the server interface for an object.

Arguments

• h_object - Handle to the object

Returns

• Result<(SoHServer, &'a SoServerInterface), ESerror_t> - Server handle and interface or error code

pub fn set_client_data( &self, h_object: SoHObject, client_data: *mut c_void, ) -> c_long

Sets client data for an object.

Arguments

• h_object - Handle to the object
• client_data - Pointer to client data

Returns

• ESerror_t - Error code indicating success or failure

pub fn get_client_data<T>(&self, h_object: SoHObject) -> Result<*mut T, c_long>

Gets client data from an object.

Type Parameters

• T - Type of the client data

Arguments

• h_object - Handle to the object

Returns

• Result<*mut T, ESerror_t> - Pointer to client data or error code

Trait Implementations

impl<'a> Clone for ServerInterface<'a>

fn clone(&self) -> ServerInterface<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ServerInterface<'a>