Struct DisplayName

pub struct DisplayName { /* private fields */ }

A high-level wrapper for strings representing display names.

This wrapper provides attempts to determine whether a display name contains characters that could make it ambiguous or easily confused with similar names.

Examples

use matrix_sdk_base::deserialized_responses::DisplayName;

let display_name = DisplayName::new("𝒮𝒶𝒽𝒶𝓈𝓇𝒶𝒽𝓁𝒶");

// The normalized and sanitized string will be returned by DisplayName.as_normalized_str().
assert_eq!(display_name.as_normalized_str(), Some("sahasrahla"));

let display_name = DisplayName::new("@alice:localhost");

// The display name looks like an MXID, which makes it ambiguous.
assert!(display_name.is_inherently_ambiguous());

Implementations

impl DisplayName

pub fn new(raw: &str) -> DisplayName

Creates a new DisplayName from the given raw string.

The raw display name is transformed into a Unicode-normalized form, with common confusable characters removed to reduce ambiguity.

Note: If removing confusable characters fails, DisplayName::is_inherently_ambiguous will return true, and DisplayName::as_normalized_str() will return `None.

pub fn is_inherently_ambiguous(&self) -> bool

Is this display name considered to be ambiguous?

If the display name has cancer (i.e. fails normalisation or has a different normalised form) or looks like an MXID, then it’s ambiguous.

pub fn as_raw_str(&self) -> &str

Returns the underlying raw and and unsanitized string of this DisplayName.

pub fn as_normalized_str(&self) -> Option<&str>

Returns the underlying normalized and and sanitized string of this DisplayName.

Returns None if normalization failed during construction of this DisplayName.

Trait Implementations

impl Clone for DisplayName

fn clone(&self) -> DisplayName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayName

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

Formats the value using the given formatter.

impl Hash for DisplayName

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DisplayName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DisplayName