Skip to main content

XmtpFfiClientOptions

Struct XmtpFfiClientOptions 

Source
#[repr(C)]
pub struct XmtpFfiClientOptions {
Show 16 fields pub host: *const c_char, pub gateway_host: *const c_char, pub is_secure: i32, pub db_path: *const c_char, pub encryption_key: *const u8, pub inbox_id: *const c_char, pub account_identifier: *const c_char, pub identifier_kind: i32, pub nonce: u64, pub auth_handle: *const XmtpFfiAuthHandle, pub app_version: *const c_char, pub device_sync_worker_mode: i32, pub allow_offline: i32, pub client_mode: i32, pub max_db_pool_size: u32, pub min_db_pool_size: u32,
}
Expand description

Options for creating a client. All string fields are borrowed (not freed by this library).

Fields§

§host: *const c_char

gRPC v3 host URL (required).

§gateway_host: *const c_char

Gateway host URL for decentralized API (nullable, enables d14n if set).

§is_secure: i32

Whether the connection is TLS-secured.

§db_path: *const c_char

Path to the SQLite database file. Null = ephemeral.

§encryption_key: *const u8

32-byte encryption key for the database. Null = unencrypted.

§inbox_id: *const c_char

Inbox ID (required).

§account_identifier: *const c_char

Account identifier string (required).

§identifier_kind: i32

Identifier kind: 0 = Ethereum, 1 = Passkey.

§nonce: u64

Nonce for identity strategy (default 1 if 0).

§auth_handle: *const XmtpFfiAuthHandle

Optional auth handle for gateway authentication. Null = no auth.

§app_version: *const c_char

Application version string (nullable).

§device_sync_worker_mode: i32

Device sync worker mode: 0 = Enabled (default), 1 = Disabled.

§allow_offline: i32

Allow offline mode. 0 = no (default), 1 = yes.

§client_mode: i32

Client mode: 0 = Default, 1 = Notification (read-only).

§max_db_pool_size: u32

Maximum database connection pool size. 0 = use default.

§min_db_pool_size: u32

Minimum database connection pool size. 0 = use default.

Trait Implementations§

Source§

impl Clone for XmtpFfiClientOptions

Source§

fn clone(&self) -> XmtpFfiClientOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for XmtpFfiClientOptions

Source§

impl Debug for XmtpFfiClientOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for XmtpFfiClientOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for XmtpFfiClientOptions

Source§

impl PartialEq for XmtpFfiClientOptions

Source§

fn eq(&self, other: &XmtpFfiClientOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for XmtpFfiClientOptions

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.