Struct DefaultUser 

pub struct DefaultUser {
    pub display_name: String,
    pub is_bot: bool,
}

Available on crate feature ffi only.

The SimpleX user profile used to initialise the chat instance.

Security

The display_name field is injected into a SimpleX CLI command of the form /create {kind} '{display_name}'. It is intended to be a short, fixed, ASCII identifier chosen by the application author, do not supply a user-input here to avoid command injections like: “User’Name”(creates a user named “User” with bio=“Name”)

Fields

display_name: String

is_bot: bool

Implementations

impl DefaultUser

pub fn regular<S>(name: S) -> DefaultUser

where S: Into<String>,

Creates a regular SimpleX user profile with the given display name.

name is injected literally into /create user '{name}'. Use a fixed ASCII identifier; do not pass user-supplied input here.

pub fn bot<S>(name: S) -> DefaultUser

where S: Into<String>,

Creates a bot SimpleX user profile with the given display name.

name is injected literally into /create bot '{name}'. Use a fixed ASCII identifier; do not pass user-supplied input here.

Trait Implementations

impl Clone for DefaultUser

fn clone(&self) -> DefaultUser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultUser

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

Formats the value using the given formatter.