Struct bot_rs_core::command_access::AccessRights

pub struct AccessRights { /* fields omitted */ }

Manages filters for command invocations. Should be used to manage the access of users to commands based on the messages.

Example

Its recommended to use this before processing the command.

use bot_rs_core::plugin::{Plugin, PluginInfo, PluginError};
use bot_rs_core::Message;
use async_trait::async_trait;
use bot_rs_core::profile::{Profiles, Profile};

// Profile can be stored on Plugin creation as active profile doesn't change at runtime
struct TestPlugin(Profile);

#[async_trait]
impl Plugin for TestPlugin{
    type Error = PluginError;

    async fn call(&self, message: Message) -> Result<Vec<Message>, PluginError> {
        match self.0.rights().allowed(&message) {
            Some(true) => (),// Message was checked by a AccessFilter and is allowed,
            Some(false) => (),// Message was checked by a AccessFilter and is not allowed
            None => (), // Message has no handling AccessFilters
        }
        Ok(Vec::with_capacity(0))
    }

    fn info(&self) -> PluginInfo {
        unimplemented!()
    }
}

Implementations

impl AccessRights

pub fn new() -> Self

pub fn is_empty(&self) -> bool

Returns if there are no filters.

pub fn iter(&self) -> impl Iterator<Item = &AccessFilter>

Returns an Iterator over all

pub fn allowed(&self, mssg: &Message) -> Option<bool>

Checks if any filter allows the invocation of a command.

Returns:

• Some(true) if filters were present for the message and any allowed it,
• Some(false) if filters were present for the message and none allowed it and
• None if no filters were present for the message.

Trait Implementations

impl Clone for AccessRights

fn clone(&self) -> AccessRights

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessRights

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

Formats the value using the given formatter.

impl Default for AccessRights

fn default() -> AccessRights

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for AccessRights

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

Deserialize this value from the given Serde deserializer.

impl Eq for AccessRights

impl PartialEq<AccessRights> for AccessRights

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

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

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

This method tests for !=.

impl Serialize for AccessRights

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 AccessRights

impl StructuralPartialEq for AccessRights