Struct ruma_identifiers::user_id::UserId

pub struct UserId { /* fields omitted */ }

A Matrix user ID.

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

assert_eq!(
    UserId::try_from("@carl:example.com").unwrap().as_ref(),
    "@carl:example.com"
);

Methods

impl UserId

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

This is supported on feature="rand" only.

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

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

pub fn parse_with_server_name(
    id: impl AsRef<str> + Into<String>,
    server_name: &str
) -> Result<Self, Error>

Attempts to complete a user ID, by adding the colon + server name and @ prefix, if not present already.

This is a convenience function for the login API, where a user can supply either their full user ID or just the localpart. It only supports a valid user ID or a valid user ID localpart, not the localpart plus the @ prefix, or the localpart plus server name without the @ prefix.

pub fn localpart(&self) -> &str

Returns the user's localpart.

pub fn server_name(&self) -> &str

Returns the server name of the user ID.

pub fn is_historical(&self) -> bool

Whether this user ID is a historical one, i.e. one that doesn't conform to the latest specification of the user ID grammar but is still accepted because it was previously allowed.

Trait Implementations

impl<'expr> AsExpression<Nullable<Text>> for &'expr UserId

type Expression = Bound<Nullable<Text>, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Nullable<Text>> for UserId

type Expression = Bound<Nullable<Text>, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<'expr> AsExpression<Text> for &'expr UserId

type Expression = Bound<Text, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Text> for UserId

type Expression = Bound<Text, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsRef<str> for UserId

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for UserId

fn clone(&self) -> UserId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserId

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

Deserialize this value from the given Serde deserializer.

impl Display for UserId

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

Formats the value using the given formatter.

impl Eq for UserId

impl From<UserId> for String

fn from(id: UserId) -> Self

Performs the conversion.

impl<DB> FromSql<Text, DB> for UserId where
    String: FromSql<Text, DB>,
    DB: Backend, 

fn from_sql(
    value: Option<&<DB as Backend>::RawValue>
) -> DeserializeResult<Self>

See the trait documentation.

impl<__ST, __DB> FromSqlRow<__ST, __DB> for UserId where
    __DB: Backend,
    Self: FromSql<__ST, __DB>, 

fn build_from_row<R: Row<__DB>>(row: &mut R) -> Result<Self>

See the trait documentation.

const FIELDS_NEEDED: usize

The number of fields that this type will consume. Must be equal to the number of times you would call row.take() in build_from_row

impl Hash for UserId

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 NotNull for UserId

impl Ord for UserId

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<String> for UserId

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<UserId> for UserId

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<UserId> for str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<UserId> for String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for UserId

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<UserId> for UserId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl QueryId for UserId

type QueryId = UserId

A type which uniquely represents Self in a SQL query.

const HAS_STATIC_QUERY_ID: bool

Can the SQL generated by Self be uniquely identified by its type?

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl<__ST, __DB> Queryable<__ST, __DB> for UserId where
    __DB: Backend,
    Self: FromSql<__ST, __DB>, 

type Row = Self

The Rust type you'd like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

impl Serialize for UserId

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

Serialize this value into the given Serde serializer.

impl SingleValue for UserId

impl<__DB> ToSql<Nullable<Text>, __DB> for UserId where
    __DB: Backend,
    Self: ToSql<Text, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

See the trait documentation.

impl<DB> ToSql<Text, DB> for UserId where
    DB: Backend, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> SerializeResult

See the trait documentation.

impl<'_> TryFrom<&'_ str> for UserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<Cow<'_, str>> for UserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(user_id: Cow<str>) -> Result<Self, Error>

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

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

impl TryFrom<String> for UserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.