Struct twilight_cache_inmemory::permission::InMemoryCachePermissions

pub struct InMemoryCachePermissions<'a>(_);

This is supported on crate feature permission-calculator only.

Calculate the permissions of a member with information from the cache.

Implementations

impl<'a> InMemoryCachePermissions<'a>

pub const fn cache_ref(&'a self) -> &'a InMemoryCache

Immutable reference to the underlying cache.

pub const fn into_cache(self) -> &'a InMemoryCache

Consume the statistics interface, returning the underlying cache reference.

pub fn in_channel(
    &self,
    user_id: UserId,
    channel_id: ChannelId
) -> Result<Permissions, ChannelError>

Calculate the permissions of a member in a guild channel.

Returns Permissions::all if the user is the owner of the guild.

The following ResourceTypes must be enabled:

• ResourceType::CHANNEL
• ResourceType::MEMBER
• ResourceType::ROLE

Examples

use twilight_cache_inmemory::InMemoryCache;
use twilight_model::id::{ChannelId, UserId};

let cache = InMemoryCache::new();

// later on...

let channel_id = ChannelId::new(4).expect("non zero");
let user_id = UserId::new(5).expect("non zero");

let permissions = cache.permissions().in_channel(user_id, channel_id)?;
println!(
    "User {} in channel {} has permissions {:?}",
    user_id,
    channel_id,
    permissions,
);

Errors

Returns a ChannelErrorType::ChannelUnavailable error type if the guild channel is not in the cache.

Returns a ChannelErrorType::MemberUnavailable error type if the member for the user in the guild is not present.

Returns a ChannelErrorType::RoleUnavailable error type if one of the member’s roles is not in the cache.

pub fn root(
    &self,
    user_id: UserId,
    guild_id: GuildId
) -> Result<Permissions, RootError>

Calculate the guild-level permissions of a member.

Returns Permissions::all if the user is the owner of the guild.

The following ResourceTypes must be enabled:

• ResourceType::MEMBER
• ResourceType::ROLE

Examples

use twilight_cache_inmemory::InMemoryCache;
use twilight_model::id::{GuildId, UserId};

let cache = InMemoryCache::new();

// later on...

let guild_id = GuildId::new(4).expect("non zero");
let user_id = UserId::new(5).expect("non zero");

let permissions = cache.permissions().root(user_id, guild_id)?;
println!(
    "User {} in guild {} has permissions {:?}",
    user_id,
    guild_id,
    permissions,
);

Errors

Returns a RootErrorType::MemberUnavailable error type if the member for the user in the guild is not present.

Returns a RootErrorType::RoleUnavailable error type if one of the member’s roles is not in the cache.

Trait Implementations

impl<'a> Clone for InMemoryCachePermissions<'a>

fn clone(&self) -> InMemoryCachePermissions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InMemoryCachePermissions<'a>

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

Formats the value using the given formatter.