Struct UserRegistrationToken 

pub struct UserRegistrationToken {
    pub id: Ulid,
    pub token: String,
    pub username: Option<String>,
    pub email: Option<String>,
    pub passwordless: bool,
    pub room_id: Option<String>,
    pub usage_limit: Option<u32>,
    pub times_used: u32,
    pub created_at: DateTime<Utc>,
    pub last_used_at: Option<DateTime<Utc>>,
    pub expires_at: Option<DateTime<Utc>>,
    pub revoked_at: Option<DateTime<Utc>>,
}

Fields

id: Ulid

token: String

username: Option<String>

A localpart to impose, or a template for one (see is_username_template). A template token works only through its /register?token=… link: the registration token step refuses it.

email: Option<String>

passwordless: bool

room_id: Option<String>

usage_limit: Option<u32>

times_used: u32

created_at: DateTime<Utc>

last_used_at: Option<DateTime<Utc>>

expires_at: Option<DateTime<Utc>>

revoked_at: Option<DateTime<Utc>>

Implementations

impl UserRegistrationToken

pub fn is_valid(&self, now: DateTime<Utc>) -> bool

Returns true if the token is still valid and can be used

pub fn is_invite(&self) -> bool

Returns true if the token is an invite: it registers without a password, as the username (or username template) and the email address it pins

pub fn can_be_used(&self, now: DateTime<Utc>) -> bool

Returns true if the token can still be used (not expired and under usage limit)

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

The username, if it is a template (see is_username_template)

Trait Implementations

impl Clone for UserRegistrationToken

fn clone(&self) -> UserRegistrationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserRegistrationToken

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

Formats the value using the given formatter.

impl Eq for UserRegistrationToken

impl PartialEq for UserRegistrationToken

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserRegistrationToken