Struct harmony_rust_sdk::api::Hmc

pub struct Hmc { /* fields omitted */ }

A HMC.

An example HMC looks like hmc://chat.harmonyapp.io/403cb46c-49cf-4ae1-b876-f38eb26accb0.

Implementations

impl Hmc

pub fn new(server: impl Display, id: impl Display) -> Self

Creates a new HMC given a homeserver and (attachment) ID.

Note that this function does not check that the id argument is actually an ID, so it may panic or requests made with this Hmc may fail.

Example

let hmc = Hmc::new("example.org", "403cb46c-49cf-4ae1-b876-f38eb26accb0");
assert_eq!(hmc.to_string(), "hmc://example.org/403cb46c-49cf-4ae1-b876-f38eb26accb0");

pub fn id(&self) -> &str

Gets the ID of this HMC.

Example

let hmc = Hmc::new("example.org", "403cb46c-49cf-4ae1-b876-f38eb26accb0");
assert_eq!(hmc.id(), "403cb46c-49cf-4ae1-b876-f38eb26accb0");

pub fn server(&self) -> &str

Gets the server of this HMC.

Example

let hmc = Hmc::new("example.org", "403cb46c-49cf-4ae1-b876-f38eb26accb0");
assert_eq!(hmc.server(), "example.org");

pub fn port(&self) -> u16

Gets the port of this HMC.

Example

let hmc = Hmc::new("example.org:2289", "403cb46c-49cf-4ae1-b876-f38eb26accb0");
assert_eq!(hmc.port(), 2289);

Trait Implementations

impl Clone for Hmc

fn clone(&self) -> Hmc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hmc

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

Formats the value using the given formatter.

impl Default for Hmc

fn default() -> Self

Returns the “default value” for a type.

impl Display for Hmc

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

Formats the value using the given formatter.

impl Eq for Hmc

impl From<Hmc> for FileId

fn from(hmc: Hmc) -> Self

Performs the conversion.

impl Hash for Hmc

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Hmc> for Hmc

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

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

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

This method tests for !=.

impl StructuralEq for Hmc

impl StructuralPartialEq for Hmc

impl TryFrom<Url> for Hmc

type Error = HmcParseError

The type returned in the event of a conversion error.

fn try_from(value: Url) -> Result<Self, Self::Error>

Performs the conversion.