Struct Event

pub struct Event {

    room: OnceCell<Room>,
    item: RefCell<Option<Arc<EventTimelineItem>>>,
    event_id_string: PhantomData<Option<String>>,
    sender_id_string: PhantomData<String>,
    timestamp: PhantomData<DateTime>,
    formatted_timestamp: PhantomData<String>,
    source: PhantomData<Option<String>>,
    has_source: PhantomData<bool>,
    state: Cell<MessageState>,
    is_edited: PhantomData<bool>,
    latest_edit_source: PhantomData<String>,
    latest_edit_event_id_string: PhantomData<String>,
    latest_edit_timestamp: PhantomData<Option<DateTime>>,
    latest_edit_formatted_timestamp: PhantomData<String>,
    is_highlighted: PhantomData<bool>,
    reactions: ReactionList,
    read_receipts: ListStore,
    has_read_receipts: PhantomData<bool>,
}

Fields

room: OnceCell<Room>

The room containing this event.

item: RefCell<Option<Arc<EventTimelineItem>>>

The underlying SDK timeline item.

event_id_string: PhantomData<Option<String>>

The global permanent ID of this event, if it has been received from the server, as a string.

sender_id_string: PhantomData<String>

The ID of the sender of this event, as a string.

timestamp: PhantomData<DateTime>

The timestamp of this event, as a GDateTime.

formatted_timestamp: PhantomData<String>

The formatted timestamp of this event.

source: PhantomData<Option<String>>

The pretty-formatted JSON source, if it has been echoed back by the server.

has_source: PhantomData<bool>

Whether we have the JSON source of this event.

state: Cell<MessageState>

The state of this event.

is_edited: PhantomData<bool>

Whether this event was edited.

latest_edit_source: PhantomData<String>

The pretty-formatted JSON source for the latest edit of this event.

This string is empty if the event is not edited.

latest_edit_event_id_string: PhantomData<String>

The ID for the latest edit of this event, as a string.

This string is empty if the event is not edited.

latest_edit_timestamp: PhantomData<Option<DateTime>>

The timestamp for the latest edit of this event, as a GDateTime, if any.

latest_edit_formatted_timestamp: PhantomData<String>

The formatted timestamp for the latest edit of this event.

This string is empty if the event is not edited.

is_highlighted: PhantomData<bool>

Whether this event should be highlighted.

reactions: ReactionList

The reactions on this event.

read_receipts: ListStore

The read receipts on this event.

has_read_receipts: PhantomData<bool>

Whether this event has any read receipt.

Implementations

impl Event

fn register_type()

Registers the type only once.

impl Event

pub fn downgrade(&self) -> <Self as Downgrade>::Weak

impl Event

fn set_room(&self, room: Room)

Set the room that contains this event.

pub(super) fn set_item(&self, item: EventTimelineItem)

Set the underlying SDK timeline item.

pub(super) fn item(&self) -> Arc<EventTimelineItem>

The underlying SDK timeline item.

pub(super) fn identifier(&self) -> TimelineEventItemId

The global permanent or temporary identifier of this event.

pub(super) fn event_id(&self) -> Option<OwnedEventId>

The global permanent ID of this event, if it has been received from the server.

fn event_id_string(&self) -> Option<String>

The global permanent ID of this event, if it has been received from the server, as a string.

pub(crate) fn transaction_id(&self) -> Option<OwnedTransactionId>

The temporary ID of this event, if it has been sent with this session.

pub(super) fn sender_id(&self) -> OwnedUserId

The ID of the sender of this event.

fn sender_id_string(&self) -> String

The ID of the sender of this event, as a string.

pub(super) fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

The timestamp of this event, as the number of milliseconds since Unix Epoch.

fn timestamp(&self) -> DateTime

The timestamp of this event, as a GDateTime.

fn formatted_timestamp(&self) -> String

The formatted timestamp of this event.

pub(super) fn raw(&self) -> Option<Raw<AnySyncTimelineEvent>>

The raw JSON source, if it has been echoed back by the server.

fn source(&self) -> Option<String>

The pretty-formatted JSON source, if it has been echoed back by the server.

fn has_source(&self) -> bool

Whether we have the JSON source.

fn compute_state(&self) -> MessageState

Compute the current state of this event.

fn update_state(&self)

Update the state of this event.

fn is_edited(&self) -> bool

Whether this event was edited.

fn latest_edit_raw(&self) -> Option<Raw<AnySyncTimelineEvent>>

The JSON source for the latest edit of this event, if any.

fn latest_edit_source(&self) -> String

The pretty-formatted JSON source for the latest edit of this event.

This string is empty if the event is not edited.

fn latest_edit_event_id_string(&self) -> String

The ID of the latest edit of this Event.

This string is empty if the event is not edited.

fn latest_edit_timestamp(&self) -> Option<DateTime>

The timestamp of the latest edit of this Event, as a GDateTime, if any.

fn latest_edit_formatted_timestamp(&self) -> String

The formatted timestamp of the latest edit of this Event.

fn is_highlighted(&self) -> bool

Whether this Event should be highlighted.

fn update_read_receipts( &self, new_read_receipts: &IndexMap<OwnedUserId, Receipt>, )

Update the read receipts list with the given receipts.

fn has_read_receipts(&self) -> bool

Whether this event has any read receipt.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

impl DerivedObjectProperties for Event

fn derived_properties() -> &'static [ParamSpec]

Properties installed for this type.

fn derived_property(&self, id: usize, pspec: &ParamSpec) -> Value

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

fn derived_set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

impl ObjectImpl for Event

fn signals() -> &'static [Signal]

Signals installed for this type.

fn properties() -> &'static [ParamSpec]

Properties installed for this type.

fn set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Property setter.

fn property(&self, id: usize, pspec: &ParamSpec) -> Value

Property getter.

fn constructed(&self)

Constructed.

fn dispose(&self)

Disposes of the object.

fn notify(&self, pspec: &ParamSpec)

Function to be called when property change is notified for with self.notify("property").

fn dispatch_properties_changed(&self, pspecs: &[ParamSpec])

impl ObjectSubclass for Event

const NAME: &'static str = "RoomEvent"

GObject type name.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<Event>

The C class struct.

type Instance = InstanceStruct<Event>

The C instance struct.

type Type = Event

Wrapper around this subclass defined with wrapper!

type ParentType = TimelineItem

Parent Rust type to inherit from.

fn new() -> Self

Constructor.

const ABSTRACT: bool = false

If this subclass is an abstract class or not.

const ALLOW_NAME_CONFLICT: bool = false

Allow name conflicts for this class.

fn type_init(_type_: &mut InitializingType<Self>)

Additional type initialization.

fn class_init(_klass: &mut Self::Class)

Class initialization.

fn with_class(_klass: &Self::Class) -> Self

Constructor.

fn instance_init(_obj: &InitializingObject<Self>)

Performs additional instance initialization.

impl ObjectSubclassType for Event

fn type_data() -> NonNull<TypeData>

Storage for the type-specific data used during registration.

fn type_() -> Type

Returns the glib::Type ID of the subclass.

impl TimelineItemImpl for Event

fn can_hide_header(&self) -> bool

fn event_sender_id(&self) -> Option<OwnedUserId>

fn selectable(&self) -> bool