Skip to main content

DefaultUser

Struct DefaultUser 

Source
pub struct DefaultUser {
    pub display_name: String,
    pub is_bot: bool,
}
Expand description

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§

Source§

impl DefaultUser

Source

pub fn regular<S: Into<String>>(name: S) -> Self

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.

Source

pub fn bot<S: Into<String>>(name: S) -> Self

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§

Source§

impl Clone for DefaultUser

Source§

fn clone(&self) -> DefaultUser

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 Debug for DefaultUser

Source§

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

Formats the value using the given formatter. Read more

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.