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

Merge serde attributes and improve docs

Browse Source
This commit is contained in:
Jonas Platte 2021-10-08 12:45:56 +02:00
parent 271491732e
commit aa5fdf9d22
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
90 changed files with 524 additions and 314 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/ruma-api-macros/src/attribute.rs
View File

@ -22,8 +22,10 @@ impl Parse for MetaValue {
}
}
/// Like syn::MetaNameValue, but expects an identifier as the value. Also, we don't care about the
/// the span of the equals sign, so we don't have the `eq_token` field from syn::MetaNameValue.
/// Like syn::MetaNameValue, but expects an identifier as the value.
///
/// Also, we don't care about the the span of the equals sign, so we don't have the `eq_token` field
/// from syn::MetaNameValue.
pub struct MetaNameValue<V> {
/// The part left of the equals sign
pub name: Ident,
@ -50,7 +52,9 @@ pub enum Meta {
}
impl Meta {
/// Check if the given attribute is a ruma_api attribute. If it is, parse it.
/// Check if the given attribute is a ruma_api attribute.
///
/// If it is, parse it.
pub fn from_attribute(attr: &syn::Attribute) -> syn::Result<Option<Self>> {
if attr.path.is_ident("ruma_api") {
attr.parse_args().map(Some)

10
crates/ruma-api/src/lib.rs
View File

@ -216,14 +216,16 @@ use error::{FromHttpRequestError, FromHttpResponseError, IntoHttpError};
#[derive(Clone, Copy, Debug)]
#[allow(clippy::exhaustive_enums)]
pub enum SendAccessToken<'a> {
/// Add the given access token to the request only if the `METADATA` on the request requires it
/// Add the given access token to the request only if the `METADATA` on the request requires
/// it.
IfRequired(&'a str),
/// Always add the access token
/// Always add the access token.
Always(&'a str),
/// Don't add an access token. This will lead to an error if the request endpoint requires
/// authentication
/// Don't add an access token.
///
/// This will lead to an error if the request endpoint requires authentication
None,
}

8
crates/ruma-appservice-api/src/lib.rs
View File

@ -87,7 +87,9 @@ pub struct Registration {
/// A list of users, aliases and rooms namespaces that the application service controls.
pub namespaces: Namespaces,
/// Whether requests from masqueraded users are rate-limited. The sender is excluded.
/// Whether requests from masqueraded users are rate-limited.
///
/// The sender is excluded.
#[serde(skip_serializing_if = "Option::is_none")]
pub rate_limited: Option<bool>,
@ -123,7 +125,9 @@ pub struct RegistrationInit {
/// A list of users, aliases and rooms namespaces that the application service controls.
pub namespaces: Namespaces,
/// Whether requests from masqueraded users are rate-limited. The sender is excluded.
/// Whether requests from masqueraded users are rate-limited.
///
/// The sender is excluded.
pub rate_limited: Option<bool>,
/// The external protocols which the application service provides (e.g. IRC).

8
crates/ruma-client-api/src/error.rs
View File

@ -15,7 +15,9 @@ use serde_json::{from_slice as from_json_slice, Value as JsonValue};
/// Separate module because it's a lot of code.
mod kind_serde;
/// An enum for the error kind. Items may contain additional information.
/// An enum for the error kind.
///
/// Items may contain additional information.
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum ErrorKind {
@ -25,7 +27,9 @@ pub enum ErrorKind {
/// M_UNKNOWN_TOKEN
UnknownToken {
/// If this is `true`, the client can acquire a new access token by specifying the device
/// ID it is already using to the login API. For more information, see [the spec].
/// ID it is already using to the login API.
///
/// For more information, see [the spec].
///
/// [the spec]: https://matrix.org/docs/spec/client_server/r0.6.1#soft-logout
soft_logout: bool,

15
crates/ruma-client-api/src/r0/account/request_3pid_management_token_via_email.rs
View File

@ -30,9 +30,10 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<&'a str>,
/// Optional identity server hostname and access token. Deprecated since r0.6.0.
#[serde(flatten)]
#[serde(skip_serializing_if = "Option::is_none")]
/// Optional identity server hostname and access token.
///
/// Deprecated since r0.6.0.
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub identity_server_info: Option<IdentityServerInfo<'a>>,
}
@ -40,10 +41,12 @@ ruma_api! {
/// The session identifier given by the identity server.
pub sid: SessionIdBox,
/// URL to submit validation token to. If omitted, verification happens without client.
/// URL to submit validation token to.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will
/// result in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

15
crates/ruma-client-api/src/r0/account/request_3pid_management_token_via_msisdn.rs
View File

@ -33,9 +33,10 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<&'a str>,
/// Optional identity server hostname and access token. Deprecated since r0.6.0.
#[serde(flatten)]
#[serde(skip_serializing_if = "Option::is_none")]
/// Optional identity server hostname and access token.
///
/// Deprecated since r0.6.0.
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub identity_server_info: Option<IdentityServerInfo<'a>>,
}
@ -43,10 +44,12 @@ ruma_api! {
/// The session identifier given by the identity server.
pub sid: SessionIdBox,
/// URL to submit validation token to. If omitted, verification happens without client.
/// URL to submit validation token to.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will
/// result in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

15
crates/ruma-client-api/src/r0/account/request_password_change_token_via_email.rs
View File

@ -30,9 +30,10 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<&'a str>,
/// Optional identity server hostname and access token. Deprecated since r0.6.0.
#[serde(flatten)]
#[serde(skip_serializing_if = "Option::is_none")]
/// Optional identity server hostname and access token.
///
/// Deprecated since r0.6.0.
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub identity_server_info: Option<IdentityServerInfo<'a>>,
}
@ -40,10 +41,12 @@ ruma_api! {
/// The session identifier given by the identity server.
pub sid: SessionIdBox,
/// URL to submit validation token to. If omitted, verification happens without client.
/// URL to submit validation token to.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

8
crates/ruma-client-api/src/r0/account/request_password_change_token_via_msisdn.rs
View File

@ -36,10 +36,12 @@ ruma_api! {
/// The session identifier given by the identity server.
pub sid: SessionIdBox,
/// URL to submit validation token to. If omitted, verification happens without client.
/// URL to submit validation token to.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

15
crates/ruma-client-api/src/r0/account/request_registration_token_via_email.rs
View File

@ -30,9 +30,10 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<&'a str>,
/// Optional identity server hostname and access token. Deprecated since r0.6.0.
#[serde(flatten)]
#[serde(skip_serializing_if = "Option::is_none")]
/// Optional identity server hostname and access token.
///
/// Deprecated since r0.6.0.
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub identity_server_info: Option<IdentityServerInfo<'a>>,
}
@ -40,10 +41,12 @@ ruma_api! {
/// The session identifier given by the identity server.
pub sid: SessionIdBox,
/// URL to submit validation token to. If omitted, verification happens without client.
/// URL to submit validation token to.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

15
crates/ruma-client-api/src/r0/account/request_registration_token_via_msisdn.rs
View File

@ -33,9 +33,10 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub next_link: Option<&'a str>,
/// Optional identity server hostname and access token. Deprecated since r0.6.0.
#[serde(flatten)]
#[serde(skip_serializing_if = "Option::is_none")]
/// Optional identity server hostname and access token.
///
/// Deprecated since r0.6.0.
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub identity_server_info: Option<IdentityServerInfo<'a>>,
}
@ -43,10 +44,12 @@ ruma_api! {
/// The session identifier given by the identity server.
pub sid: SessionIdBox,
/// URL to submit validation token to. If omitted, verification happens without client.
/// URL to submit validation token to.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If omitted, verification happens without client.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

10
crates/ruma-client-api/src/r0/backup/add_backup_key_session.rs
View File

@ -17,7 +17,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
@ -35,8 +37,10 @@ ruma_api! {
}
response: {
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.

10
crates/ruma-client-api/src/r0/backup/add_backup_key_sessions.rs
View File

@ -19,7 +19,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
@ -32,8 +34,10 @@ ruma_api! {
}
response: {
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.

10
crates/ruma-client-api/src/r0/backup/add_backup_keys.rs
View File

@ -19,7 +19,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
@ -28,8 +30,10 @@ ruma_api! {
}
response: {
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.

2
crates/ruma-client-api/src/r0/backup/create_backup.rs
View File

@ -21,7 +21,7 @@ ruma_api! {
}
response: {
/// The backup version. This is an opaque string.
/// The backup version.
pub version: String,
}

10
crates/ruma-client-api/src/r0/backup/delete_backup_key_session.rs
View File

@ -15,7 +15,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
@ -29,8 +31,10 @@ ruma_api! {
}
response: {
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.

10
crates/ruma-client-api/src/r0/backup/delete_backup_key_sessions.rs
View File

@ -15,7 +15,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
@ -25,8 +27,10 @@ ruma_api! {
}
response: {
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.

10
crates/ruma-client-api/src/r0/backup/delete_backup_keys.rs
View File

@ -14,14 +14,18 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
}
response: {
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.

8
crates/ruma-client-api/src/r0/backup/get_backup.rs
View File

@ -29,11 +29,13 @@ ruma_api! {
/// The number of keys stored in the backup.
pub count: UInt,
/// An opaque string representing stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The backup version. This is an opaque string.
/// The backup version.
pub version: String,
}

4
crates/ruma-client-api/src/r0/backup/get_backup_key_session.rs
View File

@ -16,7 +16,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,

4
crates/ruma-client-api/src/r0/backup/get_backup_key_sessions.rs
View File

@ -18,7 +18,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,

4
crates/ruma-client-api/src/r0/backup/get_backup_keys.rs
View File

@ -18,7 +18,9 @@ ruma_api! {
}
request: {
/// The backup version. Must be the current backup.
/// The backup version.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: &'a str,
}

8
crates/ruma-client-api/src/r0/backup/get_latest_backup.rs
View File

@ -26,11 +26,13 @@ ruma_api! {
/// The number of keys stored in the backup.
pub count: UInt,
/// An opaque string represetning stored keys in the backup. Clients can compare it with
/// the etag value they received in the request of their last key storage request.
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The backup version. This is an opaque string.
/// The backup version.
pub version: String,
}

5
crates/ruma-client-api/src/r0/device/update_device.rs
View File

@ -18,8 +18,9 @@ ruma_api! {
#[ruma_api(path)]
pub device_id: &'a DeviceId,
/// The new display name for this device. If this is `None`, the display name won't be
/// changed.
/// The new display name for this device.
///
/// If this is `None`, the display name won't be changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub display_name: Option<String>,
}

4
crates/ruma-client-api/src/r0/directory.rs
View File

@ -47,8 +47,8 @@ pub struct PublicRoomsChunk {
/// The URL for the room's avatar, if one is set.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

6
crates/ruma-client-api/src/r0/filter/lazy_load.rs
View File

@ -13,8 +13,10 @@ pub enum LazyLoadOptions {
/// Enables lazy-loading of events.
Enabled {
/// If `true`, sends all membership events for all events, even if they have
/// already been sent to the client. Defaults to `false`.
/// If `true`, sends all membership events for all events, even if they have already been
/// sent to the client.
///
/// Defaults to `false`.
include_redundant_members: bool,
},
}

26
crates/ruma-client-api/src/r0/keys/get_keys.rs
View File

@ -22,8 +22,9 @@ ruma_api! {
#[derive(Default)]
request: {
/// The time (in milliseconds) to wait when downloading keys from remote
/// servers. 10 seconds is the recommended default.
/// The time (in milliseconds) to wait when downloading keys from remote servers.
///
/// 10 seconds is the recommended default.
#[serde(
with = "ruma_serde::duration::opt_ms",
default,
@ -31,24 +32,25 @@ ruma_api! {
)]
pub timeout: Option<Duration>,
/// The keys to be downloaded. An empty list indicates all devices for
/// the corresponding user.
/// The keys to be downloaded.
///
/// An empty list indicates all devices for the corresponding user.
pub device_keys: BTreeMap<UserId, Vec<DeviceIdBox>>,
/// If the client is fetching keys as a result of a device update
/// received in a sync request, this should be the 'since' token of that
/// sync request, or any later sync token. This allows the server to
/// ensure its response contains the keys advertised by the notification
/// in that sync.
/// If the client is fetching keys as a result of a device update received in a sync
/// request, this should be the 'since' token of that sync request, or any later sync token.
///
/// This allows the server to ensure its response contains the keys advertised by the
/// notification in that sync.
#[serde(skip_serializing_if = "Option::is_none")]
pub token: Option<&'a str>,
}
#[derive(Default)]
response: {
/// If any remote homeservers could not be reached, they are recorded
/// here. The names of the properties are the names of the unreachable
/// servers.
/// If any remote homeservers could not be reached, they are recorded here.
///
/// The names of the properties are the names of the unreachable servers.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub failures: BTreeMap<String, JsonValue>,

4
crates/ruma-client-api/src/r0/keys/upload_keys.rs
View File

@ -19,7 +19,9 @@ ruma_api! {
#[derive(Default)]
request: {
/// Identity keys for the device. May be absent if no new identity keys are required.
/// Identity keys for the device.
///
/// May be absent if no new identity keys are required.
#[serde(skip_serializing_if = "Option::is_none")]
pub device_keys: Option<DeviceKeys>,

12
crates/ruma-client-api/src/r0/keys/upload_signing_keys.rs
View File

@ -27,13 +27,17 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub master_key: Option<CrossSigningKey>,
/// The user's self-signing key. Must be signed with the accompanied master, or by the
/// user's most recently uploaded master key if no master key is included in the request.
/// The user's self-signing key.
///
/// Must be signed with the accompanied master, or by the user's most recently uploaded
/// master key if no master key is included in the request.
#[serde(skip_serializing_if = "Option::is_none")]
pub self_signing_key: Option<CrossSigningKey>,
/// The user's user-signing key. Must be signed with the accompanied master, or by the
/// user's most recently uploaded master key if no master key is included in the request.
/// The user's user-signing key.
///
/// Must be signed with the accompanied master, or by the user's most recently uploaded
/// master key if no master key is included in the request.
#[serde(skip_serializing_if = "Option::is_none")]
pub user_signing_key: Option<CrossSigningKey>,
}

3
crates/ruma-client-api/src/r0/media/create_content.rs
View File

@ -46,8 +46,7 @@ ruma_api! {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}

10
crates/ruma-client-api/src/r0/media/get_content_thumbnail.rs
View File

@ -29,13 +29,15 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub method: Option<Method>,
/// The *desired* width of the thumbnail. The actual thumbnail may not match the size
/// specified.
/// The *desired* width of the thumbnail.
///
/// The actual thumbnail may not match the size specified.
#[ruma_api(query)]
pub width: UInt,
/// The *desired* height of the thumbnail. The actual thumbnail may not match the size
/// specified.
/// The *desired* height of the thumbnail.
///
/// The actual thumbnail may not match the size specified.
#[ruma_api(query)]
pub height: UInt,

19
crates/ruma-client-api/src/r0/membership/get_member_events.rs
View File

@ -20,21 +20,26 @@ ruma_api! {
#[ruma_api(path)]
pub room_id: &'a RoomId,
/// The point in time (pagination token) to return members for in the room. This token can
/// be obtained from a prev_batch token returned for each room by the sync API.
/// The point in time (pagination token) to return members for in the room.
///
/// This token can be obtained from a prev_batch token returned for each room by the sync
/// API.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub at: Option<&'a str>,
/// The kind of memberships to filter for. Defaults to no filtering if unspecified. When
/// specified alongside not_membership, the two parameters create an 'or' condition: either
/// the membership is the same as membership or is not the same as not_membership.
/// The kind of memberships to filter for.
///
/// Defaults to no filtering if unspecified. When specified alongside not_membership, the
/// two parameters create an 'or' condition: either the membership is the same as membership
/// or is not the same as not_membership.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub membership: Option<MembershipEventFilter>,
/// The kind of memberships to *exclude* from the results. Defaults to no filtering if
/// unspecified.
/// The kind of memberships to *exclude* from the results.
///
/// Defaults to no filtering if unspecified.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub not_membership: Option<MembershipEventFilter>,

5
crates/ruma-client-api/src/r0/membership/join_room_by_id_or_alias.rs
View File

@ -20,8 +20,9 @@ ruma_api! {
#[ruma_api(path)]
pub room_id_or_alias: &'a RoomIdOrAliasId,
/// The servers to attempt to join the room through. One of the servers
/// must be participating in the room.
/// The servers to attempt to join the room through.
///
/// One of the servers must be participating in the room.
#[ruma_api(query)]
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub server_name: &'a [ServerNameBox],

4
crates/ruma-client-api/src/r0/membership/joined_members.rs
View File

@ -55,8 +55,8 @@ pub struct RoomMember {
/// The mxc avatar url of the user.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

7
crates/ruma-client-api/src/r0/profile/get_avatar_url.rs
View File

@ -23,8 +23,8 @@ ruma_api! {
response: {
/// The user's avatar URL, if set.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",
@ -37,8 +37,7 @@ ruma_api! {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}

7
crates/ruma-client-api/src/r0/profile/get_profile.rs
View File

@ -23,8 +23,8 @@ ruma_api! {
response: {
/// The user's avatar URL, if set.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",
@ -41,8 +41,7 @@ ruma_api! {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}

7
crates/ruma-client-api/src/r0/profile/set_avatar_url.rs
View File

@ -22,8 +22,8 @@ ruma_api! {
///
/// `None` is used to unset the avatar.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[cfg_attr(
feature = "compat",
serde(
@ -43,8 +43,7 @@ ruma_api! {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<&'a str>,
}

12
crates/ruma-client-api/src/r0/push.rs
View File

@ -21,8 +21,8 @@ pub mod set_pushrule;
pub mod set_pushrule_actions;
pub mod set_pushrule_enabled;
/// Like `SimplePushRule`, but may represent any kind of push rule
/// thanks to `pattern` and `conditions` being optional.
/// Like `SimplePushRule`, but may represent any kind of push rule thanks to `pattern` and
/// `conditions` being optional.
///
/// To create an instance of this type, use one of its `From` implementations.
#[derive(Clone, Debug, Serialize, Deserialize)]
@ -41,13 +41,15 @@ pub struct PushRule {
pub rule_id: String,
/// The conditions that must hold true for an event in order for a rule to be applied to an
/// event. A rule with no conditions always matches.
/// event.
///
/// Only applicable to underride and override rules.
/// A rule with no conditions always matches. Only applicable to underride and override rules.
#[serde(skip_serializing_if = "Option::is_none")]
pub conditions: Option<Vec<PushCondition>>,
/// The glob-style pattern to match against. Only applicable to content rules.
/// The glob-style pattern to match against.
///
/// Only applicable to content rules.
#[serde(skip_serializing_if = "Option::is_none")]
pub pattern: Option<String>,
}

12
crates/ruma-client-api/src/r0/push/get_notifications.rs
View File

@ -30,16 +30,20 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<UInt>,
/// Allows basic filtering of events returned. Supply "highlight" to return only events
/// where the notification had the 'highlight' tweak set.
/// Allows basic filtering of events returned.
///
/// Supply "highlight" to return only events where the notification had the 'highlight'
/// tweak set.
#[ruma_api(query)]
#[serde(skip_serializing_if = "Option::is_none")]
pub only: Option<&'a str>,
}
response: {
/// The token to supply in the from param of the next /notifications request in order
/// to request more events. If this is absent, there are no more results.
/// The token to supply in the from param of the next /notifications request in order to
/// request more events.
///
/// If this is absent, there are no more results.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_token: Option<String>,

10
crates/ruma-client-api/src/r0/push/set_pushrule.rs
View File

@ -42,12 +42,16 @@ ruma_api! {
pub actions: &'a [Action],
/// The conditions that must hold true for an event in order for a rule to be applied to an
/// event. A rule with no conditions always matches. Only applicable to underride and
/// override rules, empty Vec otherwise.
/// event.
///
/// A rule with no conditions always matches. Only applicable to underride and override
/// rules, empty Vec otherwise.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub conditions: &'a [PushCondition],
/// The glob-style pattern to match against. Only applicable to content rules.
/// The glob-style pattern to match against.
///
/// Only applicable to content rules.
#[serde(skip_serializing_if = "Option::is_none")]
pub pattern: Option<&'a str>,
}

10
crates/ruma-client-api/src/r0/room/create_room.rs
View File

@ -71,7 +71,9 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub room_alias_name: Option<&'a str>,
/// Room version to set for the room. Defaults to homeserver's default if not specified.
/// Room version to set for the room.
///
/// Defaults to homeserver's default if not specified.
#[serde(skip_serializing_if = "Option::is_none")]
pub room_version: Option<&'a RoomVersionId>,
@ -80,10 +82,10 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub topic: Option<&'a str>,
/// A public visibility indicates that the room will be shown in the published room
/// list. A private visibility will hide the room from the published room list.
/// A public visibility indicates that the room will be shown in the published room list.
///
/// Defaults to `Private`.
/// A private visibility will hide the room from the published room list. Defaults to
/// `Private`.
#[serde(default, skip_serializing_if = "ruma_serde::is_default")]
pub visibility: Visibility,
}

4
crates/ruma-client-api/src/r0/room/report_content.rs
View File

@ -26,7 +26,9 @@ ruma_api! {
/// Integer between -100 and 0 rating offensivness.
pub score: Int,
/// Reason to report content. May be blank.
/// Reason to report content.
///
/// May be blank.
pub reason: &'a str,
}

26
crates/ruma-client-api/src/r0/search/search_events.rs
View File

@ -77,7 +77,9 @@ pub struct Criteria<'a> {
/// The string to search events for.
pub search_term: &'a str,
/// The keys to search for. Defaults to all keys.
/// The keys to search for.
///
/// Defaults to all keys.
#[serde(skip_serializing_if = "Option::is_none")]
pub keys: Option<&'a [SearchKeys]>,
@ -357,7 +359,9 @@ pub struct ResultRoomEvents {
pub groups: BTreeMap<GroupingKey, BTreeMap<RoomIdOrUserId, ResultGroup>>,
/// Token that can be used to get the next batch of results, by passing as the `next_batch`
/// parameter to the next call. If this field is absent, there are no more results.
/// parameter to the next call.
///
/// If this field is absent, there are no more results.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_batch: Option<String>,
@ -365,8 +369,9 @@ pub struct ResultRoomEvents {
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub results: Vec<SearchResult>,
/// The current state for every room in the results. This is included if the request had the
/// `include_state` key set with a value of `true`.
/// The current state for every room in the results.
///
/// This is included if the request had the `include_state` key set with a value of `true`.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub state: BTreeMap<RoomId, Vec<Raw<AnyStateEvent>>>,
@ -398,8 +403,9 @@ impl ResultRoomEvents {
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ResultGroup {
/// Token that can be used to get the next batch of results in the group, by passing as the
/// `next_batch` parameter to the next call. If this field is absent, there are no more
/// results in this group.
/// `next_batch` parameter to the next call.
///
/// If this field is absent, there are no more results in this group.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_batch: Option<String>,
@ -432,7 +438,9 @@ pub struct SearchResult {
#[serde(skip_serializing_if = "EventContextResult::is_empty")]
pub context: EventContextResult,
/// A number that describes how closely this result matches the search. Higher is closer.
/// A number that describes how closely this result matches the search.
///
/// Higher is closer.
#[serde(skip_serializing_if = "Option::is_none")]
pub rank: Option<UInt>,
@ -459,8 +467,8 @@ impl SearchResult {
pub struct UserProfile {
/// The user's avatar URL, if set.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

5
crates/ruma-client-api/src/r0/session/login.rs
View File

@ -32,8 +32,9 @@ ruma_api! {
#[serde(skip_serializing_if = "Option::is_none")]
pub device_id: Option<&'a DeviceId>,
/// A display name to assign to the newly-created device. Ignored if device_id corresponds
/// to a known device.
/// A display name to assign to the newly-created device.
///
/// Ignored if `device_id` corresponds to a known device.
#[serde(skip_serializing_if = "Option::is_none")]
pub initial_device_display_name: Option<&'a str>,
}

6
crates/ruma-client-api/src/r0/state/get_state_events.rs
View File

@ -23,8 +23,10 @@ ruma_api! {
response: {
/// If the user is a member of the room this will be the current state of the room as a
/// list of events. If the user has left the room then this will be the state of the
/// room when they left as a list of events.
/// list of events.
///
/// If the user has left the room then this will be the state of the room when they left as
/// a list of events.
#[ruma_api(body)]
pub room_state: Vec<Raw<AnyStateEvent>>,
}

8
crates/ruma-client-api/src/r0/sync/sync_events.rs
View File

@ -247,8 +247,7 @@ pub struct JoinedRoom {
#[serde(default, skip_serializing_if = "RoomAccountData::is_empty")]
pub account_data: RoomAccountData,
/// The ephemeral events in the room that aren't recorded in the timeline or state of the
/// room. e.g. typing.
/// The ephemeral events in the room that aren't recorded in the timeline or state of the room.
#[serde(default, skip_serializing_if = "Ephemeral::is_empty")]
pub ephemeral: Ephemeral,
}
@ -433,8 +432,9 @@ impl Ephemeral {
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct RoomSummary {
/// Users which can be used to generate a room name if the room does not have
/// one. Required if room name or canonical aliases are not set or empty.
/// Users which can be used to generate a room name if the room does not have one.
///
/// Required if room name or canonical aliases are not set or empty.
#[serde(rename = "m.heroes", default, skip_serializing_if = "Vec::is_empty")]
pub heroes: Vec<String>,

4
crates/ruma-client-api/src/r0/user_directory/search_users.rs
View File

@ -80,8 +80,8 @@ pub struct User {
/// The avatar url, as an MXC, if one exists.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

4
crates/ruma-common/src/directory.rs
View File

@ -51,8 +51,8 @@ pub struct PublicRoomsChunk {
/// The URL for the room's avatar, if one is set.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

19
crates/ruma-common/src/encryption.rs
View File

@ -11,10 +11,14 @@ use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct DeviceKeys {
/// The ID of the user the device belongs to. Must match the user ID used when logging in.
/// The ID of the user the device belongs to.
///
/// Must match the user ID used when logging in.
pub user_id: UserId,
/// The ID of the device these keys belong to. Must match the device ID used when logging in.
/// The ID of the device these keys belong to.
///
/// Must match the device ID used when logging in.
pub device_id: DeviceIdBox,
/// The encryption algorithms supported by this device.
@ -113,17 +117,20 @@ pub struct CrossSigningKey {
/// What the key is used for.
pub usage: Vec<KeyUsage>,
/// The public key. The object must have exactly one property.
/// The public key.
///
/// The object must have exactly one property.
pub keys: BTreeMap<String, String>,
/// Signatures of the key. Only optional for master key.
/// Signatures of the key.
///
/// Only optional for master key.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub signatures: CrossSigningKeySignatures,
}
impl CrossSigningKey {
/// Creates a new `CrossSigningKey` with the given user ID, usage, keys and
/// signatures.
/// Creates a new `CrossSigningKey` with the given user ID, usage, keys and signatures.
pub fn new(
user_id: UserId,
usage: Vec<KeyUsage>,

4
crates/ruma-common/src/push.rs
View File

@ -392,7 +392,9 @@ impl Equivalent<PatternedPushRule> for str {
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct PusherData {
/// Required if the pusher's kind is http. The URL to use to send notifications to.
/// The URL to use to send notifications to.
///
/// Required if the pusher's kind is http.
#[serde(skip_serializing_if = "Option::is_none")]
pub url: Option<String>,

18
crates/ruma-common/src/push/predefined.rs
View File

@ -209,10 +209,11 @@ impl ConditionalPushRule {
}
}
/// Matches any encrypted event sent in a room with exactly two members. Unlike other push
/// rules, this rule cannot be matched against the content of the event by nature of it being
/// encrypted. This causes the rule to be an "all or nothing" match where it either matches all
/// events that are encrypted (in 1:1 rooms) or none.
/// Matches any encrypted event sent in a room with exactly two members.
///
/// Unlike other push rules, this rule cannot be matched against the content of the event by
/// nature of it being encrypted. This causes the rule to be an "all or nothing" match where it
/// either matches all events that are encrypted (in 1:1 rooms) or none.
pub fn encrypted_room_one_to_one() -> Self {
Self {
rule_id: ".m.rules.encrypted_room_one_to_one".into(),
@ -259,10 +260,11 @@ impl ConditionalPushRule {
}
}
/// Matches all encrypted events. Unlike other push rules, this rule cannot be matched against
/// the content of the event by nature of it being encrypted. This causes the rule to be an
/// "all or nothing" match where it either matches all events that are encrypted (in group
/// rooms) or none.
/// Matches all encrypted events.
///
/// Unlike other push rules, this rule cannot be matched against the content of the event by
/// nature of it being encrypted. This causes the rule to be an "all or nothing" match where it
/// either matches all events that are encrypted (in group rooms) or none.
pub fn encrypted() -> Self {
Self {
rule_id: ".m.rules.encrypted".into(),

4
crates/ruma-common/src/thirdparty.rs
View File

@ -25,8 +25,8 @@ pub struct Protocol {
/// A content URI representing an icon for the third party protocol.
///
/// If you activate the `compat` feature, this field being absent in JSON will give you an
/// empty string here.
/// If you activate the `compat` feature, this field being absent in JSON will result in an
/// empty string here during deserialization.
#[cfg_attr(feature = "compat", serde(default))]
pub icon: String,

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

@ -13,7 +13,9 @@ use super::SessionDescription;
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_event(type = "m.call.answer", kind = Message)]
pub struct CallAnswerEventContent {
/// The VoIP session description object. The session description type must be *answer*.
/// The VoIP session description object.
///
/// The session description type must be *answer*.
pub answer: SessionDescription,
/// The ID of the call this event relates to.

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

@ -16,12 +16,15 @@ pub struct CallInviteEventContent {
/// A unique identifier for the call.
pub call_id: String,
/// The time in milliseconds that the invite is valid for. Once the invite age exceeds this
/// value, clients should discard it. They should also no longer show the call as awaiting an
/// answer in the UI.
/// The time in milliseconds that the invite is valid for.
///
/// Once the invite age exceeds this value, clients should discard it. They should also no
/// longer show the call as awaiting an answer in the UI.
pub lifetime: UInt,
/// The session description object. The session description type must be *offer*.
/// The session description object.
///
/// The session description type must be *offer*.
pub offer: SessionDescription,
/// The version of the VoIP specification this messages adheres to.

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

@ -78,8 +78,9 @@ pub enum CancelCode {
#[ruma_enum(rename = "m.user")]
User,
/// The verification process timed out. Verification processes can define their own timeout
/// parameters.
/// The verification process timed out.
///
/// Verification processes can define their own timeout parameters.
#[ruma_enum(rename = "m.timeout")]
Timeout,

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

@ -11,8 +11,10 @@ pub mod user;
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct PolicyRuleEventContent {
/// The entity affected by this rule. Glob characters * and ? can be used to match zero or more
/// and one or more characters respectively.
/// The entity affected by this rule.
///
/// Glob characters `*` and `?` can be used to match zero or more and one or more characters
/// respectively.
pub entity: String,
/// The suggested action to take.

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

@ -30,8 +30,8 @@ pub struct PresenceEvent {
pub struct PresenceEventContent {
/// The current avatar URL for this user.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",

43
crates/ruma-events/src/room.rs
View File

@ -52,11 +52,15 @@ pub struct ImageInfo {
#[serde(skip_serializing_if = "Option::is_none")]
pub thumbnail_info: Option<Box<ThumbnailInfo>>,
/// The URL to the thumbnail of the image. Only present if the thumbnail is unencrypted.
/// The URL to the thumbnail of the image.
///
/// Only present if the thumbnail is unencrypted.
#[serde(skip_serializing_if = "Option::is_none")]
pub thumbnail_url: Option<MxcUri>,
/// Information on the encrypted thumbnail image. Only present if the thumbnail is encrypted.
/// Information on the encrypted thumbnail image.
///
/// Only present if the thumbnail is encrypted.
#[serde(skip_serializing_if = "Option::is_none")]
pub thumbnail_file: Option<Box<EncryptedFile>>,
@ -65,8 +69,7 @@ pub struct ImageInfo {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}
@ -126,7 +129,9 @@ pub struct EncryptedFile {
/// Clients should support the SHA-256 hash, which uses the key sha256.
pub hashes: BTreeMap<String, String>,
/// Version of the encrypted attachments protocol. Must be `v2`.
/// Version of the encrypted attachments protocol.
///
/// Must be `v2`.
pub v: String,
}
@ -151,7 +156,9 @@ pub struct EncryptedFileInit {
/// Clients should support the SHA-256 hash, which uses the key sha256.
pub hashes: BTreeMap<String, String>,
/// Version of the encrypted attachments protocol. Must be `v2`.
/// Version of the encrypted attachments protocol.
///
/// Must be `v2`.
pub v: String,
}
@ -169,13 +176,19 @@ impl From<EncryptedFileInit> for EncryptedFile {
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct JsonWebKey {
/// Key type. Must be `oct`.
/// Key type.
///
/// Must be `oct`.
pub kty: String,
/// Key operations. Must at least contain `encrypt` and `decrypt`.
/// Key operations.
///
/// Must at least contain `encrypt` and `decrypt`.
pub key_ops: Vec<String>,
/// Required. Algorithm. Must be `A256CTR`.
/// Algorithm.
///
/// Must be `A256CTR`.
pub alg: String,
/// The key, encoded as url-safe unpadded base64.
@ -195,13 +208,19 @@ pub struct JsonWebKey {
#[derive(Debug)]
#[allow(clippy::exhaustive_structs)]
pub struct JsonWebKeyInit {
/// Key type. Must be `oct`.
/// Key type.
///
/// Must be `oct`.
pub kty: String,
/// Key operations. Must at least contain `encrypt` and `decrypt`.
/// Key operations.
///
/// Must at least contain `encrypt` and `decrypt`.
pub key_ops: Vec<String>,
/// Required. Algorithm. Must be `A256CTR`.
/// Algorithm.
///
/// Must be `A256CTR`.
pub alg: String,
/// The key, encoded as url-safe unpadded base64.

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

@ -85,8 +85,7 @@ pub struct ImageInfo {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}

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

@ -14,7 +14,9 @@ use serde::{Deserialize, Serialize};
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_event(type = "m.room.create", kind = State)]
pub struct RoomCreateEventContent {
/// The `user_id` of the room creator. This is set by the homeserver.
/// The `user_id` of the room creator.
///
/// This is set by the homeserver.
#[ruma_event(skip_redaction)]
pub creator: UserId,
@ -26,7 +28,9 @@ pub struct RoomCreateEventContent {
)]
pub federate: bool,
/// The version of the room. Defaults to "1" if the key does not exist.
/// The version of the room.
///
/// Defaults to `RoomVersionId::Version1`.
#[serde(default = "default_room_version_id")]
pub room_version: RoomVersionId,

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

@ -6,8 +6,8 @@ use serde::{Deserialize, Serialize};
/// The content of an `m.room.history_visibility` event.
///
/// This event controls whether a member of a room can see the events that happened in a room
/// from before they joined.
/// This event controls whether a member of a room can see the events that happened in a room from
/// before they joined.
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_event(type = "m.room.history_visibility", kind = State)]
@ -33,21 +33,26 @@ impl RoomHistoryVisibilityEventContent {
#[non_exhaustive]
pub enum HistoryVisibility {
/// Previous events are accessible to newly joined members from the point they were invited
/// onwards. Events stop being accessible when the member's state changes to something other
/// than *invite* or *join*.
/// onwards.
///
/// Events stop being accessible when the member's state changes to something other than
/// *invite* or *join*.
Invited,
/// Previous events are accessible to newly joined members from the point they joined the room
/// onwards. Events stop being accessible when the member's state changes to something other
/// than *join*.
/// onwards.
/// Events stop being accessible when the member's state changes to something other than
/// *join*.
Joined,
/// Previous events are always accessible to newly joined members. All events in the room are
/// accessible, even those sent when the member was not a part of the room.
/// Previous events are always accessible to newly joined members.
///
/// All events in the room are accessible, even those sent when the member was not a part of
/// the room.
Shared,
/// All events while this is the `HistoryVisibility` value may be shared by any
/// participating homeserver with anyone, regardless of whether they have ever joined the room.
/// All events while this is the `HistoryVisibility` value may be shared by any participating
/// homeserver with anyone, regardless of whether they have ever joined the room.
WorldReadable,
#[doc(hidden)]

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

@ -40,10 +40,10 @@ use crate::{StrippedStateEvent, SyncStateEvent};
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_event(type = "m.room.member", kind = State)]
pub struct RoomMemberEventContent {
/// The avatar URL for this user, if any. This is added by the homeserver.
/// The avatar URL for this user, if any.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// This is added by the homeserver. If you activate the `compat` feature, this field being an
/// empty string in JSON will result in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",
@ -51,7 +51,9 @@ pub struct RoomMemberEventContent {
)]
pub avatar_url: Option<MxcUri>,
/// The display name for this user, if any. This is added by the homeserver.
/// The display name for this user, if any.
///
/// This is added by the homeserver.
#[serde(skip_serializing_if = "Option::is_none")]
pub displayname: Option<String>,
@ -74,8 +76,7 @@ pub struct RoomMemberEventContent {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
/// User-supplied text for why their membership has changed.
@ -302,7 +303,9 @@ fn membership_change(
}
impl RoomMemberEvent {
/// Helper function for membership change. Check [the specification][spec] for details.
/// Helper function for membership change.
///
/// Check [the specification][spec] for details.
///
/// [spec]: https://matrix.org/docs/spec/client_server/r0.6.1#m-room-member
pub fn membership_change(&self) -> MembershipChange {
@ -311,7 +314,9 @@ impl RoomMemberEvent {
}
impl SyncStateEvent<RoomMemberEventContent> {
/// Helper function for membership change. Check [the specification][spec] for details.
/// Helper function for membership change.
///
/// Check [the specification][spec] for details.
///
/// [spec]: https://matrix.org/docs/spec/client_server/r0.6.1#m-room-member
pub fn membership_change(&self) -> MembershipChange {
@ -320,7 +325,9 @@ impl SyncStateEvent<RoomMemberEventContent> {
}
impl StrippedStateEvent<RoomMemberEventContent> {
/// Helper function for membership change. Check [the specification][spec] for details.
/// Helper function for membership change.
///
/// Check [the specification][spec] for details.
///
/// [spec]: https://matrix.org/docs/spec/client_server/r0.6.1#m-room-member
pub fn membership_change(&self) -> MembershipChange {

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

@ -867,13 +867,11 @@ pub struct VideoInfo {
pub duration: Option<UInt>,
/// The height of the video in pixels.
#[serde(rename = "h")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "h", skip_serializing_if = "Option::is_none")]
pub height: Option<UInt>,
/// The width of the video in pixels.
#[serde(rename = "w")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "w", skip_serializing_if = "Option::is_none")]
pub width: Option<UInt>,
/// The mimetype of the video, e.g. "video/mp4".
@ -905,8 +903,7 @@ pub struct VideoInfo {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}

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

@ -16,22 +16,22 @@ use serde::{Deserialize, Serialize};
pub struct RoomThirdPartyInviteEventContent {
/// A user-readable string which represents the user who has been invited.
///
/// If you activate the `compat` feature, this field being absent in JSON will give you an
/// empty string here.
/// If you activate the `compat` feature, this field being absent in JSON will result in an
/// empty string here during deserialization.
#[cfg_attr(feature = "compat", serde(default))]
pub display_name: String,
/// A URL which can be fetched to validate whether the key has been revoked.
///
/// If you activate the `compat` feature, this field being absent in JSON will give you an
/// empty string here.
/// If you activate the `compat` feature, this field being absent in JSON will result in an
/// empty string here during deserialization.
#[cfg_attr(feature = "compat", serde(default))]
pub key_validity_url: String,
/// A Base64-encoded Ed25519 key with which the token must be signed.
///
/// If you activate the `compat` feature, this field being absent in JSON will give you an
/// empty string here.
/// If you activate the `compat` feature, this field being absent in JSON will result in an
/// empty string here during deserialization.
#[cfg_attr(feature = "compat", serde(default))]
pub public_key: String,

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

@ -14,8 +14,8 @@ use serde::{Deserialize, Serialize};
pub struct RoomTombstoneEventContent {
/// A server-defined message.
///
/// If you activate the `compat` feature, this field being absent in JSON will give you an
/// empty string here.
/// If you activate the `compat` feature, this field being absent in JSON will result in an
/// empty string here during deserialization.
#[cfg_attr(feature = "compat", serde(default))]
pub body: String,

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

@ -13,15 +13,16 @@ use crate::room::ImageInfo;
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_event(type = "m.sticker", kind = Message)]
pub struct StickerEventContent {
/// A textual representation or associated description of the sticker image. This could
/// be the alt text of the original image, or a message to accompany and further
/// A textual representation or associated description of the sticker image.
///
/// This could be the alt text of the original image, or a message to accompany and further
/// describe the sticker.
pub body: String,
/// Metadata about the image referred to in `url` including a thumbnail representation.
pub info: ImageInfo,
/// The URL to the sticker image. This must be a valid `mxc://` URI.
/// The URL to the sticker image.
pub url: MxcUri,
}

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

@ -75,8 +75,9 @@ impl Error for InvalidUserTagName {}
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub enum TagName {
/// `m.favourite`: The user's favorite rooms. These should be shown with higher precedence
/// than other rooms.
/// `m.favourite`: The user's favorite rooms.
///
/// These should be shown with higher precedence than other rooms.
Favorite,
/// `m.lowpriority`: These should be shown with lower precedence than others.

13
crates/ruma-federation-api/src/device/get_devices/v1.rs
View File

@ -17,7 +17,9 @@ ruma_api! {
}
request: {
/// The user ID to retrieve devices for. Must be a user local to the receiving homeserver.
/// The user ID to retrieve devices for.
///
/// Must be a user local to the receiving homeserver.
#[ruma_api(path)]
pub user_id: &'a UserId,
}
@ -26,12 +28,13 @@ ruma_api! {
/// The user ID devices were requested for.
pub user_id: UserId,
/// A unique ID for a given user_id which describes the version of the returned device
/// list. This is matched with the `stream_id` field in `m.device_list_update` EDUs in
/// order to incrementally update the returned device_list.
/// A unique ID for a given user_id which describes the version of the returned device list.
///
/// This is matched with the `stream_id` field in `m.device_list_update` EDUs in order to
/// incrementally update the returned device_list.
pub stream_id: UInt,
/// The user's devices. May be empty.
/// The user's devices.
pub devices: Vec<UserDevice>,
}
}

10
crates/ruma-federation-api/src/discovery.rs
View File

@ -59,12 +59,14 @@ pub struct ServerSigningKeys {
/// Public keys that the homeserver used to use and when it stopped using them.
pub old_verify_keys: BTreeMap<ServerSigningKeyId, OldVerifyKey>,
/// Digital signatures of this object signed using the verify_keys. Map of
/// server name to keys by key ID
/// Digital signatures of this object signed using the verify_keys.
///
/// Map of server name to keys by key ID
pub signatures: BTreeMap<ServerNameBox, BTreeMap<ServerSigningKeyId, String>>,
/// Timestamp when the keys should be refreshed. This field MUST be ignored in room
/// versions 1, 2, 3, and 4.
/// Timestamp when the keys should be refreshed.
///
/// This field MUST be ignored in room versions 1, 2, 3, and 4.
pub valid_until_ts: MilliSecondsSinceUnixEpoch,
}

4
crates/ruma-federation-api/src/discovery/get_server_version/v1.rs
View File

@ -46,7 +46,9 @@ pub struct Server {
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Version of this implementation. The version format depends on the implementation.
/// Version of this implementation.
///
/// The version format depends on the implementation.
#[serde(skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
}

12
crates/ruma-federation-api/src/event/get_missing_events/v1.rs
View File

@ -21,15 +21,21 @@ ruma_api! {
#[ruma_api(path)]
pub room_id: &'a RoomId,
/// The maximum number of events to retrieve. Defaults to 10.
/// The maximum number of events to retrieve.
///
/// Defaults to 10.
#[serde(default = "default_limit", skip_serializing_if = "is_default_limit")]
pub limit: UInt,
/// The minimum depth of events to retrieve. Defaults to 0.
/// The minimum depth of events to retrieve.
///
/// Defaults to 0.
#[serde(default, skip_serializing_if = "ruma_serde::is_default")]
pub min_depth: UInt,
/// The latest event IDs that the sender already has. These are skipped when retrieving the previous events of `latest_events`.
/// The latest event IDs that the sender already has.
///
/// These are skipped when retrieving the previous events of `latest_events`.
pub earliest_events: &'a [EventId],
/// The event IDs to retrieve the previous events for.

5
crates/ruma-federation-api/src/keys/get_keys/v1.rs
View File

@ -19,8 +19,9 @@ ruma_api! {
}
request: {
/// The keys to be downloaded. Gives all keys for a given user if the list of device ids is
/// empty.
/// The keys to be downloaded.
///
/// Gives all keys for a given user if the list of device ids is empty.
pub device_keys: BTreeMap<UserId, Vec<DeviceIdBox>>,
}

11
crates/ruma-federation-api/src/membership/get_leave_event/v1.rs
View File

@ -26,12 +26,15 @@ ruma_api! {
}
response: {
/// The version of the room where the server is trying to leave. If not provided, the room
/// version is assumed to be either "1" or "2".
/// The version of the room where the server is trying to leave.
///
/// If not provided, the room version is assumed to be either "1" or "2".
pub room_version: Option<RoomVersionId>,
/// An unsigned template event. Note that events have a different format depending on the
/// room version - check the room version specification for precise event formats.
/// An unsigned template event.
///
/// Note that events have a different format depending on the room version - check the room
/// version specification for precise event formats.
pub event: Box<RawJsonValue>,
}
}

7
crates/ruma-federation-api/src/query/get_profile_information/v1.rs
View File

@ -33,8 +33,8 @@ ruma_api! {
/// Avatar URL for the user's avatar.
///
/// If you activate the `compat` feature, this field being an empty string in JSON will give
/// you `None` here.
/// If you activate the `compat` feature, this field being an empty string in JSON will result
/// in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat",
@ -47,8 +47,7 @@ ruma_api! {
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-doc/pull/2448).
#[cfg(feature = "unstable-pre-spec")]
#[serde(rename = "xyz.amorgan.blurhash")]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}
}

4
crates/ruma-federation-api/src/thirdparty/bind_callback/v1.rs vendored
View File

@ -59,7 +59,9 @@ impl<'a> Request<'a> {
#[derive(Debug, Clone, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ThirdPartyInvite {
/// The type of third party invite issues. Currently only "email" is used.
/// The type of third party invite issues.
///
/// Currently only `Medium::Email` is used.
pub medium: Medium,
/// The third party identifier that received the invite.

4
crates/ruma-federation-api/src/thirdparty/exchange_invite/v1.rs vendored
View File

@ -19,7 +19,9 @@ ruma_api! {
#[ruma_api(path)]
pub room_id: &'a RoomId,
/// The event type. Must be `m.room.member`.
/// The event type.
///
/// Must be `EventType::RoomMember`.
#[serde(rename = "type")]
pub kind: EventType,

12
crates/ruma-federation-api/src/transactions/edu.rs
View File

@ -107,7 +107,9 @@ pub struct PresenceUpdate {
/// The number of milliseconds that have elapsed since the user last did something.
pub last_active_ago: UInt,
/// Whether or not the user is currently active. Defaults to false.
/// Whether or not the user is currently active.
///
/// Defaults to false.
#[serde(default)]
pub currently_active: bool,
}
@ -206,15 +208,17 @@ pub struct DeviceListUpdateContent {
/// The ID of the device whose details are changing.
pub device_id: DeviceIdBox,
/// The public human-readable name of this device. Will be absent if the device has no name.
/// The public human-readable name of this device.
///
/// Will be absent if the device has no name.
#[serde(skip_serializing_if = "Option::is_none")]
pub device_display_name: Option<String>,
/// An ID sent by the server for this update, unique for a given user_id.
pub stream_id: UInt,
/// The stream_ids of any prior m.device_list_update EDUs sent for this user
/// which have not been referred to already in an EDU's prev_id field.
/// The stream_ids of any prior m.device_list_update EDUs sent for this user which have not
/// been referred to already in an EDU's prev_id field.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub prev_id: Vec<UInt>,

15
crates/ruma-identifiers/src/event_id.rs
View File

@ -51,11 +51,10 @@ impl fmt::Debug for EventId {
impl EventId {
/// Attempts to generate an `EventId` for the given origin server with a localpart consisting
/// of 18 random ASCII characters. This should only be used for events in the original format
/// as used by Matrix room versions 1 and 2.
/// of 18 random ASCII characters.
///
/// Does not currently ever fail, but may fail in the future if the homeserver cannot be parsed
/// parsed as a valid host.
/// This should only be used for events in the original format as used by Matrix room versions
/// 1 and 2.
#[cfg(feature = "rand")]
pub fn new(server_name: &ServerName) -> Self {
use crate::generate_localpart;
@ -65,9 +64,11 @@ impl EventId {
Self { full_id, colon_idx: NonZeroU8::new(19) }
}
/// Returns the event's unique ID. For the original event format as used by Matrix room
/// versions 1 and 2, this is the "localpart" that precedes the homeserver. For later formats,
/// this is the entire ID without the leading $ sigil.
/// Returns the event's unique ID.
///
/// For the original event format as used by Matrix room versions 1 and 2, this is the
/// "localpart" that precedes the homeserver. For later formats, this is the entire ID without
/// the leading `$` sigil.
pub fn localpart(&self) -> &str {
let idx = match self.colon_idx {
Some(idx) => idx.get() as usize,

4
crates/ruma-identity-service-api/src/association/email/create_email_validation_session/v2.rs
View File

@ -32,7 +32,9 @@ ruma_api! {
}
response: {
/// The session ID. Session IDs are opaque strings generated by the identity server.
/// The session ID.
///
/// Session IDs are opaque strings generated by the identity server.
pub sid: SessionIdBox,
}
}

4
crates/ruma-identity-service-api/src/association/msisdn/create_msisdn_validation_session/v2.rs
View File

@ -37,7 +37,9 @@ ruma_api! {
}
response: {
/// The session ID. Session IDs are opaque strings generated by the identity server.
/// The session ID.
///
/// Session IDs are opaque strings generated by the identity server.
pub sid: SessionIdBox,
}
}

9
crates/ruma-identity-service-api/src/association/unbind_3pid/v2.rs
View File

@ -20,15 +20,16 @@ ruma_api! {
///
/// If this is not provided, the request must be signed by the homeserver which controls
/// the `mxid`.
#[serde(flatten)]
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(flatten, skip_serializing_if = "Option::is_none")]
pub threepid_ownership_proof: Option<&'a ThreePidOwnershipProof>,
/// The Matrix user ID to remove from the 3PIDs.
pub mxid: &'a UserId,
/// The 3PID to remove. Must match the 3PID used to generate the session if using `sid` and
/// `client_secret` to authenticate this request.
/// The 3PID to remove.
///
/// Must match the 3PID used to generate the session if using `sid` and `client_secret` to
/// authenticate this request.
pub threepid: &'a ThirdPartyId,
}

14
crates/ruma-identity-service-api/src/authentication/register/v2.rs
View File

@ -17,15 +17,18 @@ ruma_api! {
}
request: {
/// An access token the consumer may use to verify the identity of the
/// person who generated the token. This is given to the federation API
/// GET /openid/userinfo to verify the user's identity.
/// An access token the consumer may use to verify the identity of the person who generated
/// the token.
///
/// This is given to the federation API `GET /openid/userinfo` to verify the user's
/// identity.
pub access_token: &'a str,
/// The string `Bearer`.
pub token_type: TokenType,
/// The homeserver domain the consumer should use when attempting to verify the user's identity.
/// The homeserver domain the consumer should use when attempting to verify the user's
/// identity.
pub matrix_server_name: &'a ServerName,
/// The number of seconds before this token expires and a new one must be generated.
@ -34,7 +37,8 @@ ruma_api! {
}
response: {
/// An opaque string representing the token to authenticate future requests to the identity server with.
/// An opaque string representing the token to authenticate future requests to the identity
/// server with.
pub token: String,
}
}

9
crates/ruma-identity-service-api/src/invitation/store_invitation/v2.rs
View File

@ -64,15 +64,18 @@ ruma_api! {
}
response: {
/// The generated token. Must be a string consisting of the characters `[0-9a-zA-Z.=_-]`.
/// The generated token.
///
/// Its length must not exceed 255 characters and it must not be empty.
/// Must be a string consisting of the characters `[0-9a-zA-Z.=_-]`. Its length must not
/// exceed 255 characters and it must not be empty.
pub token: String,
/// A list of [server's long-term public key, generated ephemeral public key].
pub public_keys: PublicKeys,
/// The generated (redacted) display_name. An example is `f...@b...`.
/// The generated (redacted) display_name.
///
/// An example is `f...@b...`.
pub display_name: String,
}
}

4
crates/ruma-identity-service-api/src/lookup/get_hash_parameters/v2.rs
View File

@ -23,7 +23,9 @@ ruma_api! {
/// Servers SHOULD rotate this string often.
pub lookup_pepper: String,
/// The algorithms the server supports. Must contain at least `sha256`.
/// The algorithms the server supports.
///
/// Must contain at least `sha256`.
pub algorithms: Vec<IdentifierHashingAlgorithm>,
}
}

13
crates/ruma-identity-service-api/src/lookup/lookup_3pid/v2.rs
View File

@ -26,15 +26,18 @@ ruma_api! {
/// make use of it.
pub pepper: &'a str,
/// The addresses to look up. The format of the entries here depend on the `algorithm`
/// used. Note that queries which have been incorrectly hashed or formatted will lead to no
/// matches.
/// The addresses to look up.
///
/// The format of the entries here depend on the `algorithm` used. Note that queries which
/// have been incorrectly hashed or formatted will lead to no matches.
pub addresses: &'a [String],
}
response: {
/// Any applicable mappings of `addresses` to Matrix User IDs. Addresses which do not have
/// associations will not be included, which can make this property be an empty object.
/// Any applicable mappings of `addresses` to Matrix User IDs.
///
/// Addresses which do not have associations will not be included, which can make this
/// property be an empty object.
pub mappings: BTreeMap<String, UserId>,
}
}

12
crates/ruma-push-gateway-api/src/send_event_notification/v1.rs
View File

@ -204,14 +204,16 @@ pub struct Device {
#[serde(skip_serializing_if = "Option::is_none")]
pub pushkey_ts: Option<SecondsSinceUnixEpoch>,
/// A dictionary of additional pusher-specific data. For 'http' pushers,
/// this is the data dictionary passed in at pusher creation minus the `url`
/// key.
/// A dictionary of additional pusher-specific data.
///
/// For 'http' pushers, this is the data dictionary passed in at pusher creation minus the
/// `url` key.
#[serde(skip_serializing_if = "Option::is_none")]
pub data: Option<PusherData>,
/// A dictionary of customisations made to the way this notification is to
/// be presented. These are added by push rules.
/// A dictionary of customisations made to the way this notification is to be presented.
///
/// These are added by push rules.
#[serde(with = "tweak_serde", skip_serializing_if = "Vec::is_empty")]
pub tweaks: Vec<Tweak>,
}

6
crates/ruma-serde-macros/src/lib.rs
View File

@ -27,8 +27,10 @@ mod serialize_as_ref_str;
mod util;
/// Derive the `Outgoing` trait, possibly generating an 'Incoming' version of the struct this
/// derive macro is used on. Specifically, if no lifetime variables are used on any of the fields
/// of the struct, this simple implementation will be generated:
/// derive macro is used on.
///
/// Specifically, if no lifetime variables are used on any of the fields of the struct, this simple
/// implementation will be generated:
///
/// ```ignore
/// # // TODO: "ignore" this doctest until it is more extensively documented. (See #541)

6
crates/ruma-signatures/src/functions.rs
View File

@ -767,8 +767,10 @@ pub fn redact(
Ok(event)
}
/// Extracts the server names to check signatures for given event. It will return the sender's
/// server (unless it's a third party invite) and the event id server (on v1 and v2 room versions)
/// Extracts the server names to check signatures for given event.
///
/// It will return the sender's server (unless it's a third party invite) and the event id server
/// (on v1 and v2 room versions)
fn servers_to_check_signatures(
object: &CanonicalJsonObject,
version: &RoomVersionId,

6
crates/ruma-state-res/src/lib.rs
View File

@ -33,8 +33,10 @@ pub type StateMap<T> = HashMap<(EventType, String), T>;
/// A mapping of `EventId` to `T`, usually a `ServerPdu`.
type EventMap<T> = HashMap<EventId, T>;
/// Resolve sets of state events as they come in. Internally `StateResolution` builds a graph and an
/// auth chain to allow for state conflict resolution.
/// Resolve sets of state events as they come in.
///
/// Internally `StateResolution` builds a graph and an auth chain to allow for state conflict
/// resolution.
///
/// ## Arguments
///

5
xtask/src/cargo.rs
View File

@ -79,8 +79,9 @@ impl Package {
Ok(())
}
/// Get the changes for the version. If `update` is `true`, update the changelog for the release
/// of the given version.
/// Get the changes for the version.
///
/// If `update` is `true`, update the changelog for the release of the given version.
pub fn changes(&self, update: bool) -> Result<String> {
let mut changelog_path = self.manifest_path.clone();
changelog_path.set_file_name("CHANGELOG.md");

4
xtask/src/util.rs
View File

@ -2,7 +2,9 @@ use std::io::{stdin, stdout, BufRead, Write};
use crate::Result;
/// Ask the user the given yes or no question and wait for their input. Returns `true` for yes.
/// Ask the user the given yes or no question and wait for their input.
///
/// Returns `true` for yes.
pub fn ask_yes_no(question: &str) -> Result<bool> {
let mut input = String::new();
let stdin = stdin();