Skip to main content

BotBuilder

Struct BotBuilder 

Source
pub struct BotBuilder { /* private fields */ }
Available on crate feature ffi only.
Expand description

Builder for an FFI-backed Bot.

Implementations§

Source§

impl BotBuilder

Source

pub fn new(name: impl Into<String>, db_opts: DbOpts) -> Self

Build a bot account (default).

Source

pub fn with_default_user(self, user: DefaultUser) -> Self

Override the default user created for empty databases.

By default the default user name matches the bot name. This setting allows to create a user different from an active bot

Source

pub fn auto_accept(self) -> Self

Create public address and auto accept users

Source

pub fn auto_accept_with(self, welcome_message: impl Into<String>) -> Self

Self::auto_accept with a welcome message

Source

pub fn with_avatar(self, avatar: ImagePreview) -> Self

Set the bot avatar during initialisation

Source

pub fn with_profile(self, profile: Profile) -> Self

Update/create the whole bot profile on launch

Source

pub fn with_preferences(self, prefs: Preferences) -> Self

Apply these preferences to the bot’s profile during initialisation.

Source

pub fn max_event_latency(self, latency: Duration) -> Self

Set max permissible event latency. See WorkerConfig::max_event_latency for details

Source

pub fn max_instances(self, instances: usize) -> Self

Set max concurrent SimpleX-Chat instances. See WorkerConfig::max_instances for details

Source

pub async fn launch( self, ) -> Result<(Bot, EventStream<CoreResult<CoreEvent>>), BotInitError>

Initialise the SimpleX FFI runtime and return a ready-to-use bot.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V