Struct wicrs_server::channel::Channel

pub struct Channel {
    pub id: ID,
    pub hub_id: ID,
    pub name: String,
    pub created: u128,
}

Text channel, used to group a manage sets of messages.

Fields

id: ID

ID of the channel.

hub_id: ID

ID of the Hub that the channel belongs to.

name: String

Name of the channel.

created: u128

Date the channel was created in milliseconds since Unix Epoch.

Implementations

impl Channel

pub fn new(name: String, id: ID, hub_id: ID) -> Self

Creates a new channel object based on parameters.

pub fn get_folder(&self) -> String

Get the path of the channel’s data folder, used for storing message files.

pub async fn create_dir(&self) -> Result<()>

Creates the channel data folder.

pub async fn add_message(&mut self, message: Message) -> Result<()>

Adds a message to the channel, writes it to the file corresponding to the day the message was sent, one file per day of messages, only created if a message is sent that day.

Errors

This function will return an error in the following situations, but is not limited to just these cases:

• The message file does not exist and could not be created.
• Was unable to write to the message file.

pub async fn get_last_messages(&self, max: usize) -> Vec<Message>

Gets the last messages sent, max indicates the maximum number of messages to return.

pub async fn get_messages(
    &self,
    from: u128,
    to: u128,
    invert: bool,
    max: usize
) -> Vec<Message>

Gets a set of messages between two times given in milliseconds since Unix Epoch.

Arguments

• from - The earliest send time a message can have to be included.
• to - The latest send time a message can have to be included.
• invert - If true messages are returned in order of newest to oldest if false, oldest to newest, search is also done in that order.
• max - The maximum number of messages to return.

pub async fn on_all_raw_lines<F: FnMut(Lines<'_>)>(&self, action: F)

Perform an operation on the raw string of all the lines of all the files in the channel’s data directory.

pub async fn find_messages_containing(
    &self,
    string: String,
    case_sensitive: bool
) -> Vec<Message>

Search for messages that contain a string, if case_sensitive is true than the search is case_sensitive, case sensitive search is marginally faster.

pub async fn get_message(&self, id: &ID) -> Option<Message>

Get the first message with the given ID.

pub async fn get_current_file(&mut self) -> String

Gets the path of the current message file, filename is time in milliseconds from Unix Epoch divided by 86400000 (the number of milliseconds in a day).

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Channel

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Channel> for Channel

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

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

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

This method tests for !=.

impl Serialize for Channel

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Channel