mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-02-15 18:12:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc(sdk,base,ffi): Improve documentation and rename favorite to favourite.

Browse Source 
The Matrix specification uses the `m.favourite` orthography. Let's use
the same in our code. So `set_is_favorite` becomes `set_is_favourite`.
This patch updates this in various places for the sake of consistency.
This commit is contained in:
Ivan Enderlin
2024-02-08 15:25:41 +01:00
parent 71f4af9cdd
commit 31ba7b82d8
3 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
bindings/matrix-sdk-ffi/src/room.rs
View File

@@ -256,12 +256,12 @@ impl Room {
})))
}
pub async fn set_is_favorite(
pub async fn set_is_favourite(
&self,
is_favorite: bool,
tag_order: Option<f64>,
) -> Result<(), ClientError> {
self.inner.set_is_favorite(is_favorite, tag_order).await?;
self.inner.set_is_favourite(is_favorite, tag_order).await?;
Ok(())
}

4
crates/matrix-sdk-base/src/rooms/mod.rs
View File

@@ -105,7 +105,7 @@ pub struct BaseRoomInfo {
/// memberships.
#[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
pub(crate) rtc_member: BTreeMap<OwnedUserId, MinimalStateEvent<CallMemberEventContent>>,
// Whether this room has been manually marked as unread
/// Whether this room has been manually marked as unread.
#[serde(default)]
pub(crate) is_marked_unread: bool,
/// Some notable tags.
@@ -318,7 +318,7 @@ bitflags! {
/// others, and this struct describe them.
#[repr(transparent)]
#[derive(Debug, Default, Clone, Copy, Deserialize, Serialize)]
pub struct NotableTags: u8 {
pub(crate) struct NotableTags: u8 {
/// The `m.favourite` tag.
const FAVOURITE = 0b0000_0001;

22
crates/matrix-sdk/src/room/mod.rs
View File

@@ -968,16 +968,17 @@ impl Room {
self.client.send(request, None).await
}
/// Update the is_favorite flag from the room by calling set_tag or
/// remove_tag method on `m.favourite` tag.
/// If `is_favorite` is `true`, and `m.low_priority` tag is set on the room,
/// the tag will be removed too.
/// Add or remove the `m.favourite` flag for this room.
///
/// If `is_favourite` is `true`, and the `m.low_priority` tag is set on the
/// room, the tag will be removed too.
///
/// # Arguments
///
/// * `is_favorite` - Whether to mark this room as favorite or not.
/// * `is_favourite` - Whether to mark this room as favourite.
/// * `tag_order` - The order of the tag if any.
pub async fn set_is_favorite(&self, is_favorite: bool, tag_order: Option<f64>) -> Result<()> {
if is_favorite {
pub async fn set_is_favourite(&self, is_favourite: bool, tag_order: Option<f64>) -> Result<()> {
if is_favourite {
let tag_info = assign!(TagInfo::new(), { order: tag_order });
self.set_tag(TagName::Favorite, tag_info).await?;
@@ -991,10 +992,11 @@ impl Room {
Ok(())
}
/// Update the is_low_priority flag from the room by calling set_tag or
/// remove_tag method on `m.low_priority` tag.
/// If `is_low_priority` is `true`, and `m.favourite` tag is set on the
/// Add or remove the `m.lowpriority` flag for this room.
///
/// If `is_low_priority` is `true`, and the `m.favourite` tag is set on the
/// room, the tag will be removed too.
///
/// # Arguments
///
/// * `is_low_priority` - Whether to mark this room as low_priority or not.