Struct ContactId

pub struct ContactId(u32);

Contact ID, including reserved IDs.

Some contact IDs are reserved to identify special contacts. This type can represent both the special as well as normal contacts.

Tuple Fields

0: u32

Implementations

impl ContactId

pub const UNDEFINED: ContactId

Undefined contact. Used as a placeholder for trashed messages.

pub const SELF: ContactId

The owner of the account.

The email-address is set by set_config using “addr”.

pub const INFO: ContactId

ID of the contact for info messages.

pub const DEVICE: ContactId

ID of the contact for device messages.

pub(crate) const LAST_SPECIAL: ContactId

pub const DEVICE_ADDR: &'static str = "device@localhost"

Address to go with ContactId::DEVICE.

This is used by APIs which need to return an email address for this contact.

pub const fn new(id: u32) -> ContactId

Creates a new ContactId.

pub fn is_special(&self) -> bool

Whether this is a special ContactId.

Some ContactIds are reserved for special contacts like ContactId::SELF, ContactId::INFO and ContactId::DEVICE. This function indicates whether this ContactId is any of the reserved special ContactIds (true) or whether it is the ContactId of a real contact (false).

pub const fn to_u32(&self) -> u32

Numerical representation of the ContactId.

Each contact ID has a unique numerical representation which is used in the database (via [rusqlite::ToSql]) and also for FFI purposes. In Rust code you should never need to use this directly.

pub async fn set_name(self, context: &Context, name: &str) -> Result<()>

Sets display name for existing contact.

Display name may be an empty string, in which case the name displayed in the UI for this contact will switch to the contact’s authorized name.

pub(crate) async fn mark_bot( &self, context: &Context, is_bot: bool, ) -> Result<()>

Mark contact as bot.

pub(crate) async fn regossip_keys(&self, context: &Context) -> Result<()>

Reset gossip timestamp in all chats with this contact.

pub(crate) async fn scaleup_origin( context: &Context, ids: &[Self], origin: Origin, ) -> Result<()>

Updates the origin of the contacts, but only if origin is higher than the current one.

pub async fn addr(&self, context: &Context) -> Result<String>

Returns contact address.

pub async fn reset_encryption(self, context: &Context) -> Result<()>

Resets encryption with the contact.

Effect is similar to receiving a message without Autocrypt header from the contact, but this action is triggered manually by the user.

For example, this will result in sending the next message to 1:1 chat unencrypted, but will not remove existing verified keys.

impl ContactId

async fn get_stock_name(self, context: &Context) -> String

Get contact name, e.g. Bob, or bob@example.net if no name is set.

Trait Implementations

impl Clone for ContactId

fn clone(&self) -> ContactId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContactId

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

Formats the value using the given formatter.

impl Default for ContactId

fn default() -> ContactId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContactId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ContactId

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

Formats the value using the given formatter.

impl FromSql for ContactId

Allow converting an SQLite integer directly into ContactId.

fn column_result(value: ValueRef<'_>) -> FromSqlResult<Self>

Converts SQLite value into Rust value.

impl Hash for ContactId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ContactId

fn cmp(&self, other: &ContactId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ContactId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ContactId

fn partial_cmp(&self, other: &ContactId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ContactId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSql for ContactId

Allow converting ContactId to an SQLite type.

fn to_sql(&self) -> Result<ToSqlOutput<'_>>

Converts Rust value to SQLite value

impl Copy for ContactId

impl Eq for ContactId

impl StructuralPartialEq for ContactId