Struct GlobalCache 

pub struct GlobalCache {
    pub api_config: Arc<StoatConfig>,
    pub config: Arc<CacheConfig>,
    pub servers: Arc<HashMap<String, Server>>,
    pub users: Arc<HashMap<String, User>>,
    pub members: Arc<HashMap<String, HashMap<String, Member>>>,
    pub channels: Arc<HashMap<String, Channel>>,
    pub messages: Arc<RwLock<VecDeque<Message>>>,
    pub emojis: Arc<HashMap<String, Emoji>>,
    pub voice_states: Arc<HashMap<String, ChannelVoiceState>>,
    pub current_user_id: Arc<RwLock<Option<String>>>,
}

Holds all locally cached objects.

Fields

api_config: Arc<StoatConfig>

config: Arc<CacheConfig>

servers: Arc<HashMap<String, Server>>

users: Arc<HashMap<String, User>>

members: Arc<HashMap<String, HashMap<String, Member>>>

channels: Arc<HashMap<String, Channel>>

messages: Arc<RwLock<VecDeque<Message>>>

emojis: Arc<HashMap<String, Emoji>>

voice_states: Arc<HashMap<String, ChannelVoiceState>>

current_user_id: Arc<RwLock<Option<String>>>

Implementations

impl GlobalCache

pub fn new(api_config: StoatConfig, config: CacheConfig) -> Self

pub async fn cleanup(&self)

Clears all internal state.

pub fn autumn_url(&self) -> &str

Base URL for Autumn.

pub fn livekit_nodes(&self) -> &[VoiceNode]

All public Livekit voice nodes.

pub fn get_server(&self, server_id: &str) -> Option<Server>

Gets a server.

pub fn insert_server(&self, server: Server)

Inserts a server.

pub fn update_server_with<R>( &self, server_id: &str, f: impl FnOnce(&mut Server) -> R, ) -> Option<R>

Updates a server.

pub fn remove_server(&self, server_id: &str) -> Option<Server>

Removes a server.

pub fn get_user(&self, user_id: &str) -> Option<User>

Gets a user.

pub fn insert_user(&self, user: User)

Inserts a user.

pub fn update_user_with<R>( &self, user_id: &str, f: impl FnOnce(&mut User) -> R, ) -> Option<R>

Updates a user.

pub fn remove_user(&self, user_id: &str) -> Option<User>

Removes a user.

pub fn get_member(&self, server_id: &str, user_id: &str) -> Option<Member>

Gets a server member.

pub fn insert_member(&self, member: Member)

Inserts a server member.

pub fn update_member_with<R>( &self, server_id: &str, user_id: &str, f: impl FnOnce(&mut Member) -> R, ) -> Option<R>

Updates a server member.

pub fn remove_member(&self, server_id: &str, user_id: &str) -> Option<Member>

Removes a server member.

pub fn get_channel(&self, channel_id: &str) -> Option<Channel>

Gets a channel.

pub fn insert_channel(&self, channel: Channel)

Inserts a channel.

pub fn update_channel_with<R>( &self, channel_id: &str, f: impl FnOnce(&mut Channel) -> R, ) -> Option<R>

Updates a channel.

pub fn remove_channel(&self, channel_id: &str) -> Option<Channel>

Removes a channel.

pub fn get_message(&self, message_id: &str) -> Option<Message>

Gets a message.

pub fn insert_message(&self, message: Message)

Inserts a message.

pub fn update_message_with<R>( &self, message_id: &str, f: impl FnOnce(&mut Message) -> R, ) -> Option<R>

Updates a message.

pub fn remove_message(&self, message_id: &str) -> Option<Message>

Removes a message.

pub fn remove_messages(&self, message_ids: &[String]) -> Vec<Message>

Bulk removes messages.

pub fn get_current_user(&self) -> Option<User>

Current logged in user.

Examples found in repository

examples/commands.rs (line 41)

    async fn ready(&self, context: Context) -> Result<(), Self::Error> {
        println!(
            "Logged into {}",
            context.cache.get_current_user().unwrap().username
        );

        Ok(())
    }

examples/simple.rs (line 24)

    async fn ready(&self, context: Context) -> Result<(), Self::Error> {
        println!(
            "Logged into {}",
            context.cache.get_current_user().unwrap().username
        );

        Ok(())
    }

pub fn insert_voice_state(&self, voice_state: ChannelVoiceState)

Inserts a channel voice state.

pub fn remove_voice_state(&self, channel_id: &str) -> Option<ChannelVoiceState>

Removes a channel voice state.

pub fn get_voice_state(&self, channel_id: &str) -> Option<ChannelVoiceState>

Gets a channel voice state.

pub fn insert_voice_state_partipant( &self, channel_id: &str, user_voice_state: UserVoiceState, )

Inserts a voice state partipant.

pub fn remove_voice_state_partipant( &self, channel_id: &str, user_id: &str, ) -> Option<UserVoiceState>

Removes a voice state partipant

pub fn update_voice_state_partipant_with<R>( &self, channel_id: &str, user_id: &str, f: impl FnOnce(&mut UserVoiceState) -> R, ) -> Option<R>

Updates a voice state partipant.

pub fn insert_emoji(&self, emoji: Emoji)

Inserts an emoji.

pub fn get_emoji(&self, emoji_id: &str) -> Option<Emoji>

Gets an emoji.

pub fn remove_emoji(&self, emoji_id: &str) -> Option<Emoji>

Removes an emoji.

pub fn remove_server_emojis(&self, server_id: &str) -> Vec<Emoji>

Removes all server emojis.

pub fn set_current_user_id(&self, user_id: String)

Sets the current logged in user id.

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

Trait Implementations

impl AsRef<GlobalCache> for GlobalCache

fn as_ref(&self) -> &GlobalCache

Converts this type into a shared reference of the (usually inferred) input type.

impl<E: From<Error> + Clone + Debug + Send + Sync + 'static, S: Debug + Clone + Send + Sync + 'static> AsRef<GlobalCache> for Context<E, S>

fn as_ref(&self) -> &GlobalCache

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<GlobalCache> for Context

fn as_ref(&self) -> &GlobalCache

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for GlobalCache

fn clone(&self) -> GlobalCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalCache

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

Formats the value using the given formatter.