chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

ruma-events: Add links to specs in modules docs

Browse Source
This commit is contained in:
homersimpsons 2021-12-28 15:36:34 +01:00 committed by GitHub
parent 18a113444a
commit 2d3816d72c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
49 changed files with 147 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/ruma-events/src/call/answer.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.call.answer` event.
//! Types for the [`m.call.answer`] event.
//!
//! [`m.call.answer`]: https://spec.matrix.org/v1.1/client-server-api/#mcallanswer
use js_int::UInt;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/call/candidates.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.call.candidates` event.
//! Types for the [`m.call.candidates`] event.
//!
//! [`m.call.candidates`]: https://spec.matrix.org/v1.1/client-server-api/#mcallcandidates
use js_int::UInt;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/call/hangup.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.call.hangup` event.
//! Types for the [`m.call.hangup`] event.
//!
//! [`m.call.hangup`]: https://spec.matrix.org/v1.1/client-server-api/#mcallhangup
use js_int::UInt;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/call/invite.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.call.invite` event.
//! Types for the [`m.call.invite`] event.
//!
//! [`m.call.invite`]: https://spec.matrix.org/v1.1/client-server-api/#mcallinvite
use js_int::UInt;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/direct.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.direct` event.
//! Types for the [`m.direct`] event.
//!
//! [`m.direct`]: https://spec.matrix.org/v1.1/client-server-api/#mdirect
use std::{
collections::BTreeMap,

4
crates/ruma-events/src/dummy.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.dummy` event.
//! Types for the [`m.dummy`] event.
//!
//! [`m.dummy`]: https://spec.matrix.org/v1.1/client-server-api/#mdummy
use std::fmt;

4
crates/ruma-events/src/forwarded_room_key.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.forwarded_room_key` event.
//! Types for the [`m.forwarded_room_key`] event.
//!
//! [`m.forwarded_room_key`]: https://spec.matrix.org/v1.1/client-server-api/#mforwarded_room_key
use ruma_events_macros::EventContent;
use ruma_identifiers::{EventEncryptionAlgorithm, RoomId};

4
crates/ruma-events/src/fully_read.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.fully_read` event.
//! Types for the [`m.fully_read`] event.
//!
//! [`m.fully_read`]: https://spec.matrix.org/v1.1/client-server-api/#mfully_read
use ruma_events_macros::EventContent;
use ruma_identifiers::EventId;

4
crates/ruma-events/src/ignored_user_list.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.ignored_user_list` event.
//! Types for the [`m.ignored_user_list`] event.
//!
//! [`m.ignored_user_list`]: https://spec.matrix.org/v1.1/client-server-api/#mignored_user_list
use ruma_events_macros::EventContent;
use ruma_identifiers::UserId;

4
crates/ruma-events/src/key/verification.rs
View File

@ -3,7 +3,9 @@
//! This module also contains types shared by events in its child namespaces.
//!
//! The MSC for the in-room variants of the `m.key.verification.*` events can be found
//! [here](https://github.com/matrix-org/matrix-doc/pull/2241).
//! [on GitHub][github-matrix-doc-2214].
//!
//! [github-matrix-doc-2214]: https://github.com/matrix-org/matrix-doc/pull/2241
#[cfg(feature = "unstable-pre-spec")]
use ruma_identifiers::EventId;
use ruma_serde::StringEnum;

4
crates/ruma-events/src/key/verification/accept.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.accept` event.
//! Types for the [`m.key.verification.accept`] event.
//!
//! [`m.key.verification.accept`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationaccept
use std::collections::BTreeMap;

4
crates/ruma-events/src/key/verification/cancel.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.cancel` event.
//! Types for the [`m.key.verification.cancel`] event.
//!
//! [`m.key.verification.cancel`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationcancel
use ruma_events_macros::EventContent;
use ruma_serde::StringEnum;

4
crates/ruma-events/src/key/verification/done.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.done` event.
//! Types for the [`m.key.verification.done`] event.
//!
//! [`m.key.verification.done`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationdone
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/key/verification/key.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.key` event.
//! Types for the [`m.key.verification.key`] event.
//!
//! [`m.key.verification.key`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationkey
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/key/verification/mac.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.mac` event.
//! Types for the [`m.key.verification.mac`] event.
//!
//! [`m.key.verification.mac`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationmac
use std::collections::BTreeMap;

4
crates/ruma-events/src/key/verification/ready.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.ready` event.
//! Types for the [`m.key.verification.ready`] event.
//!
//! [`m.key.verification.ready`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationready
use ruma_events_macros::EventContent;
use ruma_identifiers::DeviceId;

4
crates/ruma-events/src/key/verification/request.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.request` event.
//! Types for the [`m.key.verification.request`] event.
//!
//! [`m.key.verification.request`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationrequest
use ruma_common::MilliSecondsSinceUnixEpoch;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/key/verification/start.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.key.verification.start` event.
//! Types for the [`m.key.verification.start`] event.
//!
//! [`m.key.verification.start`]: https://spec.matrix.org/v1.1/client-server-api/#mkeyverificationstart
use std::collections::BTreeMap;

4
crates/ruma-events/src/policy/rule/room.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.policy.rule.room` event.
//! Types for the [`m.policy.rule.room`] event.
//!
//! [`m.policy.rule.room`]: https://spec.matrix.org/v1.1/client-server-api/#mpolicyruleroom
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/policy/rule/server.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.policy.rule.server` event.
//! Types for the [`m.policy.rule.server`] event.
//!
//! [`m.policy.rule.server`]: https://spec.matrix.org/v1.1/client-server-api/#mpolicyruleserver
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/policy/rule/user.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.policy.rule.user` event.
//! Types for the [`m.policy.rule.user`] event.
//!
//! [`m.policy.rule.user`]: https://spec.matrix.org/v1.1/client-server-api/#mpolicyruleuser
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/push_rules.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.push_rules` event.
//! Types for the [`m.push_rules`] event.
//!
//! [`m.push_rules`]: https://spec.matrix.org/v1.1/client-server-api/#mpush_rules
use ruma_common::push::Ruleset;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/receipt.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.receipt` event.
//! Types for the [`m.receipt`] event.
//!
//! [`m.receipt`]: https://spec.matrix.org/v1.1/client-server-api/#mreceipt
use std::{
collections::BTreeMap,

4
crates/ruma-events/src/room/avatar.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.avatar` event.
//! Types for the [`m.room.avatar`] event.
//!
//! [`m.room.avatar`]: https://spec.matrix.org/v1.1/client-server-api/#mroomavatar
use js_int::UInt;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/room/canonical_alias.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.canonical_alias` event.
//! Types for the [`m.room.canonical_alias`] event.
//!
//! [`m.room.canonical_alias`]: https://spec.matrix.org/v1.1/client-server-api/#mroomcanonical_alias
use ruma_events_macros::EventContent;
use ruma_identifiers::RoomAliasId;

4
crates/ruma-events/src/room/create.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.create` event.
//! Types for the [`m.room.create`] event.
//!
//! [`m.room.create`]: https://spec.matrix.org/v1.1/client-server-api/#mroomcreate
use ruma_events_macros::EventContent;
use ruma_identifiers::{EventId, RoomId, RoomVersionId, UserId};

4
crates/ruma-events/src/room/encrypted.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.encrypted` event.
//! Types for the [`m.room.encrypted`] event.
//!
//! [`m.room.encrypted`]: https://spec.matrix.org/v1.1/client-server-api/#mroomencrypted
use std::collections::BTreeMap;

4
crates/ruma-events/src/room/encryption.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.encryption` event.
//! Types for the [`m.room.encryption`] event.
//!
//! [`m.room.encryption`]: https://spec.matrix.org/v1.1/client-server-api/#mroomencryption
use js_int::UInt;
use ruma_events_macros::EventContent;

4
crates/ruma-events/src/room/guest_access.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.guest_access` event.
//! Types for the [`m.room.guest_access`] event.
//!
//! [`m.room.guest_access`]: https://spec.matrix.org/v1.1/client-server-api/#mroomguest_access
use ruma_events_macros::EventContent;
use ruma_serde::StringEnum;

4
crates/ruma-events/src/room/history_visibility.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.history_visibility` event.
//! Types for the [`m.room.history_visibility`] event.
//!
//! [`m.room.history_visibility`]: https://spec.matrix.org/v1.1/client-server-api/#mroomhistory_visibility
use ruma_events_macros::EventContent;
use ruma_serde::StringEnum;

4
crates/ruma-events/src/room/join_rules.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.join_rules` event.
//! Types for the [`m.room.join_rules`] event.
//!
//! [`m.room.join_rules`]: https://spec.matrix.org/v1.1/client-server-api/#mroomjoin_rules
use ruma_events_macros::EventContent;
#[cfg(feature = "unstable-pre-spec")]

4
crates/ruma-events/src/room/member.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.member` event.
//! Types for the [`m.room.member`] event.
//!
//! [`m.room.member`]: https://spec.matrix.org/v1.1/client-server-api/#mroommember
use std::collections::BTreeMap;

4
crates/ruma-events/src/room/message.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.message` event.
//! Types for the [`m.room.message`] event.
//!
//! [`m.room.message`]: https://spec.matrix.org/v1.1/client-server-api/#mroommessage
use std::{borrow::Cow, fmt};

4
crates/ruma-events/src/room/message/feedback.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.message.feedback` event.
//! Types for the [`m.room.message.feedback`] event.
//!
//! [`m.room.message.feedback`]: https://spec.matrix.org/v1.1/client-server-api/#mroommessagefeedback
use ruma_events_macros::EventContent;
use ruma_identifiers::EventId;

4
crates/ruma-events/src/room/name.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.name` event.
//! Types for the [`m.room.name`] event.
//!
//! [`m.room.name`]: https://spec.matrix.org/v1.1/client-server-api/#mroomname
use ruma_events_macros::EventContent;
use ruma_identifiers::RoomName;

4
crates/ruma-events/src/room/pinned_events.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.pinned_events` event.
//! Types for the [`m.room.pinned_events`] event.
//!
//! [`m.room.pinned_events`]: https://spec.matrix.org/v1.1/client-server-api/#mroompinned_events
use ruma_events_macros::EventContent;
use ruma_identifiers::EventId;

4
crates/ruma-events/src/room/power_levels.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.power_levels` event.
//! Types for the [`m.room.power_levels`] event.
//!
//! [`m.room.power_levels`]: https://spec.matrix.org/v1.1/client-server-api/#mroompower_levels
use std::collections::BTreeMap;

4
crates/ruma-events/src/room/redaction.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.redaction` event.
//! Types for the [`m.room.redaction`] event.
//!
//! [`m.room.redaction`]: https://spec.matrix.org/v1.1/client-server-api/#mroomredaction
use ruma_common::MilliSecondsSinceUnixEpoch;
use ruma_events_macros::{Event, EventContent};

4
crates/ruma-events/src/room/server_acl.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.server_acl` event.
//! Types for the [`m.room.server_acl`] event.
//!
//! [`m.room.server_acl`]: https://spec.matrix.org/v1.1/client-server-api/#mroomserver_acl
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/room/third_party_invite.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.third_party_invite` event.
//! Types for the [`m.room.third_party_invite`] event.
//!
//! [`m.room.third_party_invite`]: https://spec.matrix.org/v1.1/client-server-api/#mroomthird_party_invite
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/room/tombstone.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.tombstone` event.
//! Types for the [`m.room.tombstone`] event.
//!
//! [`m.room.tombstone`]: https://spec.matrix.org/v1.1/client-server-api/#mroomtombstone
use ruma_events_macros::EventContent;
use ruma_identifiers::RoomId;

4
crates/ruma-events/src/room/topic.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room.topic` event.
//! Types for the [`m.room.topic`] event.
//!
//! [`m.room.topic`]: https://spec.matrix.org/v1.1/client-server-api/#mroomtopic
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/room_key.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room_key` event.
//! Types for the [`m.room_key`] event.
//!
//! [`m.room_key`]: https://spec.matrix.org/v1.1/client-server-api/#mroom_key
use ruma_events_macros::EventContent;
use ruma_identifiers::{EventEncryptionAlgorithm, RoomId};

4
crates/ruma-events/src/room_key_request.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.room_key_request` event.
//! Types for the [`m.room_key_request`] event.
//!
//! [`m.room_key_request`]: https://spec.matrix.org/v1.1/client-server-api/#mroom_key_request
use ruma_events_macros::EventContent;
use ruma_identifiers::{DeviceId, EventEncryptionAlgorithm, RoomId};

4
crates/ruma-events/src/secret/request.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.secret.request` event.
//! Types for the [`m.secret.request`] event.
//!
//! [`m.secret.request`]: https://spec.matrix.org/v1.1/client-server-api/#msecretrequest
use std::convert::TryFrom;

4
crates/ruma-events/src/secret/send.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.secret.send` event.
//! Types for the [`m.secret.send`] event.
//!
//! [`m.secret.send`]: https://spec.matrix.org/v1.1/client-server-api/#msecretsend
use ruma_events_macros::EventContent;
use serde::{Deserialize, Serialize};

4
crates/ruma-events/src/sticker.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.sticker` event.
//! Types for the [`m.sticker`] event.
//!
//! [`m.sticker`]: https://spec.matrix.org/v1.1/client-server-api/#msticker
use ruma_events_macros::EventContent;
use ruma_identifiers::MxcUri;

4
crates/ruma-events/src/tag.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.tag` event.
//! Types for the [`m.tag`] event.
//!
//! [`m.tag`]: https://spec.matrix.org/v1.1/client-server-api/#mtag
use std::{collections::BTreeMap, error::Error, fmt, str::FromStr};

4
crates/ruma-events/src/typing.rs
View File

@ -1,4 +1,6 @@
//! Types for the `m.typing` event.
//! Types for the [`m.typing`] event.
//!
//! [`m.typing`]: https://spec.matrix.org/v1.1/client-server-api/#mtyping
use ruma_events_macros::EventContent;
use ruma_identifiers::UserId;