Struct bot_rs_core::profile::Profile

pub struct Profile { /* fields omitted */ }

Profile configuration containing configurations for the Bot-RS Core functionality.

Profile configurations are located at {{ENV_CONFIG_DIR}}/profiles/{profile-name}.

A Profile is only allowed to join the channel its named after.

Implementations

impl Profile

pub fn empty() -> Self

pub fn new(
    name: String,
    channels: Vec<String>,
    client_id: String,
    client_secret: Option<String>
) -> Self

pub fn active() -> Option<Self>

pub fn get_channels(&self) -> &[String]

pub fn get_client_id(&self) -> String

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

pub fn add_channels(&mut self, channels: Vec<String>)

pub fn from_dir(dir: &DirEntry) -> Result<Self, ProfileError>

pub fn profile_dir(name: OsString) -> PathBuf

pub fn set_active(&self)

pub fn set_credentials(&mut self, platform: Platform, creds: Credentials)

Sets the given credentials for the platform. Overwrites existing credentials for the platform.

pub fn get_credentials(&self, platform: &Platform) -> Option<&Credentials>

pub fn rights(&self) -> &AccessRights

pub fn path(&self) -> PathBuf

pub fn plugins_path(&self) -> PathBuf

pub fn save(&self) -> Result<(), ProfileError>

pub fn delete(&self) -> Result<(), ProfileError>

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Profile

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

Deserialize this value from the given Serde deserializer.

impl Display for Profile

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

Formats the value using the given formatter.

impl Eq for Profile

impl PartialEq<Profile> for Profile

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

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

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

This method tests for !=.

impl Serialize for Profile

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Profile

impl StructuralPartialEq for Profile