Struct lite_session::LiteSessionData

pub struct LiteSessionData { /* fields omitted */ }

The data part of the token which contains additional client identifying data

use lite_session::Role;

pub struct LiteSessionData {
    username: String,
    role: Role,
    tag: Option<String>,
    acl: Vec<String>,
}

Implementations

impl LiteSessionData

pub fn username(&mut self, value: &str) -> &mut Self

Add a custom username

pub fn role(&mut self, role: Role) -> &mut Self

A a desired Role from the list of provided by the Role module

pub fn tag(&mut self, tag: &str) -> &mut Self

Add a custom tag to identify this token or current client/server/node

pub fn add_acl(&mut self, capability: &str) -> &mut Self

Add a capability to the access control list

pub fn remove_acl(&mut self, capability: &str) -> Option<String>

Remove a capability from the access control list

pub fn get_username(&self) -> &String

Get the username

pub fn get_role(&self) -> &Role

Get the role

pub fn get_tag(&self) -> &Option<String>

Get the tag

pub fn get_acl(&self) -> &Vec<String>

Get the access control list of capabilities

pub fn build(&self) -> String

Build the data to a string that can be attached to a token

pub fn destructure(self, data: &str) -> Result<Self, LiteSessionError>

Destructure the current cipher text into its components and check if they are valid

Trait Implementations

impl Clone for LiteSessionData

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiteSessionData

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

Formats the value using the given formatter.

impl Default for LiteSessionData

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<LiteSessionData> for LiteSessionData

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

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

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

This method tests for !=.