Struct urbit_http_api::interface::ShipInterface

pub struct ShipInterface {
    pub url: String,
    pub session_auth: HeaderValue,
    pub ship_name: String,
    // some fields omitted
}

Fields

url: String

The URL of the ship given as http://ip:port such as http://0.0.0.0:8080.

session_auth: HeaderValue

The session auth string header value

ship_name: String

The ship name (without a leading ~)

Implementations

impl ShipInterface

pub fn new(ship_url: &str, ship_code: &str) -> Result<ShipInterface>

Logs into the given ship and creates a new ShipInterface. ship_url should be http://ip:port of the given ship. Example: http://0.0.0.0:8080. ship_code is the code acquire from your ship by typing +code in dojo.

pub fn ship_name_with_sig(&self) -> String

Returns the ship name with a leading ~ (By default ship_name does not have one)

pub fn create_channel(&self) -> Result<Channel>

Create a Channel using this ShipInterface

pub fn send_put_request(&self, url: &str, body: &JsonValue) -> Result<Response>

pub fn scry(&self, app: &str, path: &str, mark: &str) -> Result<Response>

Sends a scry to the ship

pub fn spider(
    &self,
    input_mark: &str,
    output_mark: &str,
    thread_name: &str,
    body: &JsonValue
) -> Result<Response>

Run a thread via spider

Trait Implementations

impl Clone for ShipInterface

fn clone(&self) -> ShipInterface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShipInterface

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

Formats the value using the given formatter.

impl Default for ShipInterface

fn default() -> Self

Returns the “default value” for a type.