Struct matrix_uri::MatrixUri

pub struct MatrixUri {
    pub mxid: MatrixId,
    pub child_mxid: Option<MatrixId>,
    pub routing: Vec<String>,
    pub authority: Option<String>,
    pub fragment: Option<String>,
    /* private fields */
}

A Matrix URI

Fields

mxid: MatrixId

Primary MXID

child_mxid: Option<MatrixId>

Secondary, optional, MXID

routing: Vec<String>

Homeserver address order is preserved from URI

authority: Option<String>

“Reserved for future use” according to MSC

fragment: Option<String>

“Reserved for future use” according to MSC

Implementations

impl MatrixUri

pub fn new(
    mxid: MatrixId,
    child_mxid: Option<MatrixId>,
    query_params: Option<HashMap<String, String>>,
    routing: Option<Vec<String>>,
    action: Option<MatrixUriAction>
) -> Result<Self, MatrixUriGenError>

Builds new Matrix URI

pub fn action(&self) -> Option<MatrixUriAction>

Returns the action key from query parameters

pub fn query_string(&self) -> String

Constructs a query string from itself

pub fn matrix_to_string(&self) -> String

Builds a matrix.to URI

pub fn matrix_uri_string(&self) -> String

Builds a URI according to MSC2312 (matrix://)

Trait Implementations

impl Debug for MatrixUri

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

Formats the value using the given formatter.

impl FromStr for MatrixUri

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses both matrix.to URLs and MSC2312 (matrix://) URIs

type Err = MatrixUriParseError

The associated error which can be returned from parsing.