Struct PermissionString 

pub struct PermissionString(/* private fields */);

A validated access-control permission token.

Guaranteed not to exceed MAX_ROOM_STRING_BYTES bytes (UTF-8). Used by RoomAccessPolicy::Permission. The limit is enforced at construction time via PermissionString::new and at Serde decode time.

Implementations

impl PermissionString

pub fn new(s: impl Into<String>) -> Result<Self, RoomStringError>

Creates a PermissionString, returning RoomStringError if s exceeds MAX_ROOM_STRING_BYTES bytes.

Errors

Returns RoomStringError if the byte length of s exceeds MAX_ROOM_STRING_BYTES.

pub fn as_str(&self) -> &str

Returns the permission token as a string slice.

Trait Implementations

impl Clone for PermissionString

fn clone(&self) -> PermissionString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PermissionString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PermissionString

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

Formats the value using the given formatter.

impl From<PermissionString> for String

fn from(p: PermissionString) -> String

Converts to this type from the input type.

impl Hash for PermissionString

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PermissionString

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PermissionString

fn eq(&self, other: &PermissionString) -> 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 PartialOrd for PermissionString

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for PermissionString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for PermissionString

type Error = RoomStringError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for PermissionString

impl StructuralPartialEq for PermissionString