Struct MsgId

pub struct MsgId(u32);

Message ID, including reserved IDs.

Some message IDs are reserved to identify special message types. This type can represent both the special as well as normal messages.

Tuple Fields

0: u32

Implementations

impl MsgId

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

Schedules full message download for partially downloaded message.

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

Updates the message download state. Returns Ok if the message doesn’t exist anymore.

impl MsgId

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

Returns ephemeral message timer value for the message.

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

Starts ephemeral message timer for the message if it is not started yet.

impl MsgId

pub fn new(id: u32) -> MsgId

Create a new MsgId.

pub fn new_unset() -> MsgId

Create a new unset MsgId.

pub fn is_special(self) -> bool

Whether the message ID signifies a special message.

This kind of message ID can not be used for real messages.

pub fn is_unset(self) -> bool

Whether the message ID is unset.

When a message is created it initially has a ID of 0, which is filled in by a real message ID once the message is saved in the database. This returns true while the message has not been saved and thus not yet been given an actual message ID.

When this is true, MsgId::is_special will also always be true.

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

Returns message state.

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

pub async fn trash(self, context: &Context, on_server: bool) -> Result<()>

Put message into trash chat and delete message text.

It means the message is deleted locally, but not on the server. We keep some infos to

1. not download the same message again
2. be able to delete the message on the server if we want to

• on_server: Delete the message on the server also if it is seen on IMAP later, but only if all parts of the message are trashed with this flag. true if the user explicitly deletes the message. As for trashing a partially downloaded message when replacing it with a fully downloaded one, see receive_imf::add_parts().

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

pub fn to_u32(self) -> u32

Bad evil escape hatch.

Avoid using this, eventually types should be cleaned up enough that it is no longer necessary.

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

Returns raw text of a message, used for message info

pub async fn get_info_server_urls( context: &Context, rfc724_mid: String, ) -> Result<Vec<String>>

Returns server foldernames and UIDs of a message, used for message info

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

Returns information about hops of a message, used for message info

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

Returns detailed message information in a multi-line text form.

impl MsgId

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

Get HTML by database message id. This requires mime_headers field to be set for the message; this is the case at least when Message.has_html() returns true (we do not save raw mime unconditionally in the database to save space). The corresponding ffi-function is dc_get_msg_html().

Trait Implementations

impl Clone for MsgId

fn clone(&self) -> MsgId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MsgId

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

Formats the value using the given formatter.

impl Default for MsgId

fn default() -> MsgId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MsgId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MsgId

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

Formats the value using the given formatter.

impl FromSql for MsgId

Allow converting an SQLite integer directly into MsgId.

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

Converts SQLite value into Rust value.

impl Hash for MsgId

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 MsgId

fn cmp(&self, other: &MsgId) -> 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 MsgId

fn eq(&self, other: &MsgId) -> 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 MsgId

fn partial_cmp(&self, other: &MsgId) -> 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 MsgId

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 MsgId

Allow converting MsgId to an SQLite type.

This allows you to directly store MsgId into the database.

Errors

This does ensure that no special message IDs are written into the database and the conversion will fail if this is not the case.

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

Converts Rust value to SQLite value

impl Copy for MsgId

impl Eq for MsgId

impl StructuralPartialEq for MsgId