Struct ruma_identifiers::RoomId

pub struct RoomId { /* fields omitted */ }

A Matrix room ID.

A RoomId is generated randomly or converted from a string slice, and can be converted back into a string as needed.

assert_eq!(
    RoomId::try_from("!n8f893n9:example.com").unwrap().to_string(),
    "!n8f893n9:example.com"
);

Methods

impl RoomId

pub fn new(homeserver_host: &str) -> Result<Self, Error>

Attempts to generate a RoomId for the given origin server with a localpart consisting of 18 random ASCII characters.

Fails if the given homeserver cannot be parsed as a valid host.

pub fn hostname(&self) -> &Host

Returns a Host for the room ID, containing the server name (minus the port) of the originating homeserver.

The host can be either a domain name, an IPv4 address, or an IPv6 address.

pub fn localpart(&self) -> &str

Returns the rooms's unique ID.

pub fn port(&self) -> u16

Returns the port the originating homeserver can be accessed on.

Trait Implementations

impl Clone for RoomId

fn clone(&self) -> RoomId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<RoomId> for RoomId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for RoomId

impl Debug for RoomId

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

Formats the value using the given formatter.

impl Display for RoomId

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl Hash for RoomId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> TryFrom<&'a str> for RoomId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(room_id: &'a str) -> Result<Self, Error>

Attempts to create a new Matrix room ID from a string representation.

The string must include the leading ! sigil, the localpart, a literal colon, and a valid server name.

impl Serialize for RoomId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for RoomId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.