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
}

A Channel which is used to interact with a ship

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

Channel methods for basic functionality

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

Create a new channel

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

impl Channel

Channel methods which expose advanced functionality, typically by producing another struct which is built on top of Channel.

pub fn chat(&mut self) -> Chat<'_>

Create a Chat struct which exposes an interface for interacting with chats on Urbit

pub fn graph_store(&mut self) -> GraphStore<'_>

Create a GraphStore struct which exposes an interface for interacting with a ship's Graph Store.

Trait Implementations

impl Debug for Channel

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

Formats the value using the given formatter.