Struct RoomInfo 

#[non_exhaustive]
pub struct RoomInfo {
    pub id: RoomId,
    pub kind: RoomKind,
    pub key: Option<String>,
    pub name: Option<String>,
    pub member_count: Option<u32>,
    pub max_members: Option<u32>,
    pub peer: Option<UserId>,
}

A room.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: RoomId

The id.

kind: RoomKind

What kind of room.

key: Option<String>

The key of a public room.

name: Option<String>

A display name.

member_count: Option<u32>

The number of members connected right now, if the server shares it.

max_members: Option<u32>

The member cap, if any.

peer: Option<UserId>

For a direct-message room: the other member.

Implementations

impl RoomInfo

pub fn new(id: RoomId, kind: RoomKind) -> Self

A room with no key, name or counts.

Examples found in repository

examples/print_frames.rs (line 30)

fn main() {
    let now = UnixMillis(1_790_000_000_000);
    println!("WebSocket");
    println!("{:<22} {}", "auth (client)", WsAuth::new("example-access-token").to_message());
    show("auth.ok", &WsServerFrame::AuthOk(Some(WsAuthOk::new(UserId(42)))));
    show("auth.failed", &WsServerFrame::AuthFailed(ApiError::new(codes::TOKEN_EXPIRED, "the token expired")));
    show("request chat.join", &WsRequestFrame::call(1, JoinRoom::new("world")));
    show("answer", &WsResponseFrame::ok(1, RoomInfo::new(RoomId(12), RoomKind::Room).with_key("world")));
    show("request chat.send", &WsRequestFrame::call(2, SendMessage::new(RoomId(12), "hello")));
    show("answer", &WsResponseFrame::ok(2, SendAck::new(MessageId(981), now)));
    show("refused", &WsResponseFrame::<()>::error(3, ApiError::new(codes::NOT_A_MEMBER, "join the room first")));
    show("push chat.message", &WsPushFrame::push(ChatMessage::new(MessageId(981), RoomId(12), UserId(42), "hello", now).with_sender_name("Ada")));
    let codes: Vec<String> = CloseCode::ALL.iter().map(|c| format!("{c}{}", if c.is_permanent() { " (permanent)" } else { "" })).collect();
    println!("{:<22} {}", "close codes", codes.join(", "));

    println!();
    println!("HTTP");
    show("POST login", &LoginRequest::new("ada@example.com", "example password"));
    let tokens = TokenPair::new(
        AccessToken::new("example-access"),
        now.saturating_add_millis(3_600_000),
        RefreshToken::new("example-refresh"),
        now.saturating_add_millis(30 * 86_400_000),
    );
    show("  → 200", &AuthSession::new(Account::new(UserId(42), now).with_email("ada@example.com", true), tokens));
    show("PUT storage object", &PutObject::new(serde_json::json!({"level": 3})).if_version(ObjectVersion(2)));
    show("  → 409", &ErrorBody::new(ApiError::new(codes::VERSION_CONFLICT, "the object changed").with_details(serde_json::json!({"current_version": 3}))));
}

pub fn with_peer(self, peer: UserId) -> Self

The same room with this direct-message peer.

pub fn with_key(self, key: impl Into<String>) -> Self

The same room with this key.

Examples found in repository

examples/print_frames.rs (line 30)

fn main() {
    let now = UnixMillis(1_790_000_000_000);
    println!("WebSocket");
    println!("{:<22} {}", "auth (client)", WsAuth::new("example-access-token").to_message());
    show("auth.ok", &WsServerFrame::AuthOk(Some(WsAuthOk::new(UserId(42)))));
    show("auth.failed", &WsServerFrame::AuthFailed(ApiError::new(codes::TOKEN_EXPIRED, "the token expired")));
    show("request chat.join", &WsRequestFrame::call(1, JoinRoom::new("world")));
    show("answer", &WsResponseFrame::ok(1, RoomInfo::new(RoomId(12), RoomKind::Room).with_key("world")));
    show("request chat.send", &WsRequestFrame::call(2, SendMessage::new(RoomId(12), "hello")));
    show("answer", &WsResponseFrame::ok(2, SendAck::new(MessageId(981), now)));
    show("refused", &WsResponseFrame::<()>::error(3, ApiError::new(codes::NOT_A_MEMBER, "join the room first")));
    show("push chat.message", &WsPushFrame::push(ChatMessage::new(MessageId(981), RoomId(12), UserId(42), "hello", now).with_sender_name("Ada")));
    let codes: Vec<String> = CloseCode::ALL.iter().map(|c| format!("{c}{}", if c.is_permanent() { " (permanent)" } else { "" })).collect();
    println!("{:<22} {}", "close codes", codes.join(", "));

    println!();
    println!("HTTP");
    show("POST login", &LoginRequest::new("ada@example.com", "example password"));
    let tokens = TokenPair::new(
        AccessToken::new("example-access"),
        now.saturating_add_millis(3_600_000),
        RefreshToken::new("example-refresh"),
        now.saturating_add_millis(30 * 86_400_000),
    );
    show("  → 200", &AuthSession::new(Account::new(UserId(42), now).with_email("ada@example.com", true), tokens));
    show("PUT storage object", &PutObject::new(serde_json::json!({"level": 3})).if_version(ObjectVersion(2)));
    show("  → 409", &ErrorBody::new(ApiError::new(codes::VERSION_CONFLICT, "the object changed").with_details(serde_json::json!({"current_version": 3}))));
}

pub fn with_name(self, name: impl Into<String>) -> Self

The same room with this name.

pub fn with_members( self, member_count: Option<u32>, max_members: Option<u32>, ) -> Self

The same room with these counts.

Trait Implementations

impl Clone for RoomInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RoomInfo

impl PartialEq for RoomInfo

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RoomInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RoomInfo