Struct NodeClient 

pub struct NodeClient {
    pub api_base: String,
    pub token: Option<String>,
    /* private fields */
}

HTTP client for the local zerox1-node REST API.

Supports both local-node mode (POST /envelopes/send, GET /ws/inbox) and hosted-agent mode (POST /hosted/send, GET /ws/hosted/inbox).

Example

use zerox1_client::NodeClient;

let client = NodeClient::new("http://127.0.0.1:9090", Some("my-secret".into()));

Fields

api_base: String

token: Option<String>

Implementations

impl NodeClient

pub fn new(api_base: impl Into<String>, token: Option<String>) -> Result<Self>

Create a new client. token is the ZX01_API_SECRET or a read key.

pub fn ws_base(&self) -> String

Derive the WebSocket base URL (http → ws, https → wss).

pub fn inbox_ws_url(&self) -> String

WebSocket URL for GET /ws/inbox.

pub fn hosted_inbox_ws_url(&self, hosted_token: &str) -> String

WebSocket URL for GET /ws/hosted/inbox (hosted-agent mode).

pub async fn ping(&self) -> bool

GET /hosted/ping — lightweight reachability probe.

pub async fn identity(&self) -> Result<AgentId>

GET /identity — fetch the node’s own agent_id.

pub async fn send_envelope( &self, msg_type: &str, recipient: Option<&AgentId>, conversation_id: &ConversationId, payload: &[u8], ) -> Result<SendEnvelopeResponse>

POST /envelopes/send — local-node mode.

payload is raw bytes; base64-encoding is handled internally.

pub async fn hosted_send( &self, hosted_token: &str, msg_type: &str, recipient: Option<&AgentId>, conversation_id: &ConversationId, payload: &[u8], ) -> Result<()>

POST /hosted/send — hosted-agent mode.

payload is raw bytes; hex-encoding is handled internally.

pub async fn listen_inbox<F, Fut>(&self, handler: F) -> Result<()>

where F: FnMut(InboundEnvelope) -> Fut, Fut: Future<Output = Result<()>>,

Open a GET /ws/inbox stream and call handler for each inbound envelope.

Returns when the connection closes or an error occurs. The caller is responsible for reconnect logic.

Example

client.listen_inbox(|env| async move {
    println!("{} from {}", env.msg_type, env.sender);
    Ok(())
}).await.ok();

Trait Implementations

impl Clone for NodeClient

fn clone(&self) -> NodeClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeClient

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

Formats the value using the given formatter.