Struct SessionOptionsBuilder

pub struct SessionOptionsBuilder { /* private fields */ }

A build for SessionOptions.

Implementations

impl SessionOptionsBuilder

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

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

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

pub fn env_variables<'a, I, K, V>(self, variables: I) -> Self

where I: Iterator<Item = &'a (K, V)>, K: ToString + 'a, V: ToString + 'a,

Set the server environment variables. See also Session::set_server_var. The difference is this method writes out a temp file with the variables and implicitly pass it to the engine (as if Self::houdini_env_files was used.

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.

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.

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.

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.

pub fn ignore_already_init(self, ignore: bool) -> Self

Do not error when connecting to a server process which has a session already initialized.

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

Pass session CookOptions

pub fn session_info(self, info: SessionInfo) -> Self

Session init options SessionInfo

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

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

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

Cleanup the server session when the last connection drops.

pub fn log_file(self, file: impl AsRef<Path>) -> Self

pub fn build(self) -> SessionOptions

Consume the builder and return the result.

Trait Implementations

impl Default for SessionOptionsBuilder

fn default() -> SessionOptionsBuilder

Returns the “default value” for a type.