Struct SessionOptions 

pub struct SessionOptions {
    pub cook_opt: CookOptions,
    pub threaded: bool,
    pub cleanup: bool,
    pub env_files: Option<CString>,
    pub otl_path: Option<CString>,
    pub dso_path: Option<CString>,
    pub img_dso_path: Option<CString>,
    pub aud_dso_path: Option<CString>,
}

Session options passed to session create functions like crate::server::connect_to_pipe_server

Fields

cook_opt: CookOptions

Session cook options

threaded: bool

Create a Threaded server connection

cleanup: bool

Cleanup session upon close

env_files: Option<CString>

otl_path: Option<CString>

dso_path: Option<CString>

img_dso_path: Option<CString>

aud_dso_path: Option<CString>

Implementations

impl SessionOptions

pub fn houdini_env_files<I>(self, files: I) -> Self

where I: IntoIterator, I::Item: AsRef<str>,

A list of Houdini environment files the Engine will load from.

Panics

Panics if the joined path list contains an interior null byte.

pub fn otl_search_paths<I>(self, paths: I) -> Self

where I: IntoIterator, I::Item: AsRef<str>,

Add search paths for the Engine to find HDAs.

Panics

Panics if the joined path list contains an interior null byte.

pub fn dso_search_paths<P>(self, paths: P) -> Self

where P: IntoIterator, P::Item: AsRef<str>,

Add search paths for the Engine to find DSO plugins.

Panics

Panics if the joined path list contains an interior null byte.

pub fn image_search_paths<P>(self, paths: P) -> Self

where P: IntoIterator, P::Item: AsRef<str>,

Add search paths for the Engine to find image plugins.

Panics

Panics if the joined path list contains an interior null byte.

pub fn audio_search_paths<P>(self, paths: P) -> Self

where P: IntoIterator, P::Item: AsRef<str>,

Add search paths for the Engine to find audio files.

Panics

Panics if the joined path list contains an interior null byte.

pub fn cook_options(self, options: CookOptions) -> Self

Pass session CookOptions

pub fn threaded(self, threaded: bool) -> Self

Makes the server operate in threaded mode. See the official docs for more info.

pub fn cleanup(self, cleanup: bool) -> Self

Set whether to cleanup the session upon close

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionOptions

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

Formats the value using the given formatter.

impl Default for SessionOptions

fn default() -> SessionOptions

Returns the “default value” for a type.