Struct urbit_http_api::chat::Chat

pub struct Chat<'a> {
    pub channel: &'a mut Channel,
}

A struct that provides an interface for interacting with Urbit chats

Fields

channel: &'a mut Channel

Implementations

impl<'a> Chat<'a>

Methods for interacting with a Chat

pub fn send_message(
    &mut self,
    chat_ship: &str,
    chat_name: &str,
    message: &Message
) -> Result<String>

Send a message to an Urbit chat. Returns the index of the node that was added to Graph Store.

pub fn export_chat_log(
    &mut self,
    chat_ship: &str,
    chat_name: &str
) -> Result<Vec<String>>

Extracts a Chat’s messages automatically into a list of formatted Strings

pub fn export_authored_messages(
    &mut self,
    chat_ship: &str,
    chat_name: &str
) -> Result<Vec<AuthoredMessage>>

Extracts a Chat’s messages as AuthoredMessages

pub fn subscribe_to_chat(
    &mut self,
    chat_ship: &str,
    chat_name: &str
) -> Result<Receiver<AuthoredMessage>>

Subscribe to and watch for messages for a specific chat. This method returns a Receiver with the AuthoredMessages that are posted to the chat after subscribing. Simply call receiver.try_recv() to read the next AuthoredMessage if one has been posted in the specified chat.

Technical Note: This method actually creates a new Channel with your Urbit Ship, and spawns a new unix thread locally that processes all messages on said channel. This is required due to borrowing mechanisms in Rust, however on the plus side this makes it potentially more performant by each subscription having it’s own unix thread.