Struct urbit_http_api::channel::Channel

pub struct Channel {
    pub ship_interface: ShipInterface,
    pub uid: String,
    pub url: String,
    pub subscription_list: Vec<Subscription>,
    pub message_id_count: u64,
    // some fields omitted
}

Fields

ship_interface: ShipInterface

ShipInterface this channel is created from

uid: String

The uid of the channel

url: String

The url of the channel

subscription_list: Vec<Subscription>

message_id_count: u64

The current number of messages that have been sent out (which are also defined as message ids) via this Channel

Implementations

impl Channel

pub fn new(ship_interface: ShipInterface) -> Result<Channel>

Create a new channel

pub fn get_and_raise_message_id_count(&mut self) -> u64

Acquires and returns the current message_id_count from the ShipInterface that this channel was created from while also increase said value by 1.

pub fn poke(
    &mut self,
    app: &str,
    mark: &str,
    json: JsonValue
) -> Result<Response>

Sends a poke over the channel

pub fn create_new_subscription(
    &mut self,
    app: &str,
    path: &str
) -> Result<CreationID>

Create a new Subscription and thus subscribes to events on the ship with the provided app/path.

pub fn parse_event_messages(&mut self)

Parses SSE messages for this channel and moves them into the proper corresponding Subscription's message_list.

pub fn find_subscription(
    &mut self,
    app: &str,
    path: &str
) -> Option<&mut Subscription>

Finds the first Subscription in the list which has a matching app and path;

pub fn unsubscribe(&mut self, app: &str, path: &str) -> Option<bool>

Finds the first Subscription in the list which has a matching app and path, removes it from the list, and tells the ship that you are unsubscribing. Returns None if failed to find a subscription with a matching app & path.

pub fn delete_channel(self)

Deletes the channel

Trait Implementations

impl Debug for Channel

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

Formats the value using the given formatter.