88 lines
2.9 KiB
Rust
88 lines
2.9 KiB
Rust
//! Endpoints for the public room directory.
|
|
|
|
pub mod get_public_rooms;
|
|
pub mod get_public_rooms_filtered;
|
|
pub mod get_room_visibility;
|
|
pub mod set_room_visibility;
|
|
|
|
use js_int::{uint, UInt};
|
|
#[cfg(feature = "unstable-pre-spec")]
|
|
use ruma_events::room::join_rules::JoinRule;
|
|
use ruma_identifiers::{MxcUri, RoomAliasId, RoomId, RoomNameBox};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// A chunk of a room list response, describing one room
|
|
#[derive(Clone, Debug, Deserialize, Serialize)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
pub struct PublicRoomsChunk {
|
|
/// Aliases of the room.
|
|
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
|
pub aliases: Vec<RoomAliasId>,
|
|
|
|
/// The canonical alias of the room, if any.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub canonical_alias: Option<RoomAliasId>,
|
|
|
|
/// The name of the room, if any.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub name: Option<RoomNameBox>,
|
|
|
|
/// The number of members joined to the room.
|
|
pub num_joined_members: UInt,
|
|
|
|
/// The ID of the room.
|
|
pub room_id: RoomId,
|
|
|
|
/// The topic of the room, if any.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub topic: Option<String>,
|
|
|
|
/// Whether the room may be viewed by guest users without joining.
|
|
pub world_readable: bool,
|
|
|
|
/// Whether guest users may join the room and participate in it.
|
|
///
|
|
/// If they can, they will be subject to ordinary power level rules like any other user.
|
|
pub guest_can_join: bool,
|
|
|
|
/// 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.
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
#[cfg_attr(
|
|
feature = "compat",
|
|
serde(default, deserialize_with = "ruma_serde::empty_string_as_none")
|
|
)]
|
|
pub avatar_url: Option<MxcUri>,
|
|
|
|
/// The joining rule for the room.
|
|
#[cfg(feature = "unstable-pre-spec")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "unstable-pre-spec")))]
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
pub join_rule: Option<JoinRule>,
|
|
}
|
|
|
|
impl PublicRoomsChunk {
|
|
/// Creates a new `PublicRoomsChunk` with the given room ID.
|
|
///
|
|
/// All other fields will be propagated with default values (an empty list of aliases, `None`
|
|
/// for all `Option`al fields and `false` for all boolean fields), which should be overridden;
|
|
/// the `assign!` macro from the `assign` crate can simplify this.
|
|
pub fn new(room_id: RoomId) -> Self {
|
|
Self {
|
|
room_id,
|
|
aliases: Vec::new(),
|
|
canonical_alias: None,
|
|
name: None,
|
|
num_joined_members: uint!(0),
|
|
topic: None,
|
|
world_readable: false,
|
|
guest_can_join: false,
|
|
avatar_url: None,
|
|
#[cfg(feature = "unstable-pre-spec")]
|
|
join_rule: None,
|
|
}
|
|
}
|
|
}
|