Struct SimplexCliBuilder 

pub struct SimplexCliBuilder<I = Empty<OsString>> { /* private fields */ }

Builder for SimplexCli.

Obtained via SimplexCli::builder.

Example

let cli = SimplexCli::builder("Bot", 5225)
    .db_prefix("/var/db/simplex")
    .db_key(secret)
    .arg("--smp-servers=smp://example.com")
    .spawn()
    .await?;

Implementations

impl<I> SimplexCliBuilder<I>

where I: Iterator<Item = OsString>,

pub fn db_prefix(self, path: impl Into<String>) -> SimplexCliBuilder<I>

Sets the path to the SimpleX database directory (defaults to ".").

pub fn db_key(self, key: impl Into<String>) -> SimplexCliBuilder<I>

Passes a database encryption key via the -k flag.

pub fn arg( self, arg: impl Into<OsString>, ) -> SimplexCliBuilder<Chain<I, Once<OsString>>>

Adds an extra command argument

pub fn args<J>( self, args: J, ) -> SimplexCliBuilder<Chain<I, <J as IntoIterator>::IntoIter>>

where J: IntoIterator<Item = OsString>,

Adds multiple extra command arguments

pub async fn spawn(self) -> Result<SimplexCli, Error>

Spawns the simplex-chat process and returns a SimplexCli handle.

Checks the installed CLI version against the supported range before spawning.