Struct HostedClient 

pub struct HostedClient {
    pub remote: Remote<IrohTransport<Credentials>>,
    /* private fields */
}

A direct Weft connection. The application retains operation IDs, credentials, observed versions and stream checkpoints; reconnect never retries a mutation.

Fields

remote: Remote<IrohTransport<Credentials>>

Implementations

impl HostedClient

pub async fn connect_server( server: &str, options: &ConnectionOptions, ) -> Result<Self>

Verify the application’s HTTPS descriptor trust, connect once, and discover the endpoint’s actual v2 implementation inventory.

pub async fn connect_endpoint( address: EndpointAddr, credential: Credentials, timeout: Duration, tls_ca_certificate_pem: Option<&str>, ) -> Result<Self>

Connect to an endpoint whose public key the application already trusts. Relay addresses are routing hints; Iroh authenticates the supplied key.

pub async fn connect_endpoint_with_description( address: EndpointAddr, credential: Credentials, timeout: Duration, tls_ca_certificate_pem: Option<&str>, description: Option<DescribeEndpointResponse>, ) -> Result<Self>

Connect with a description authenticated and retained by the application. A mismatched description is discarded and rediscovered on this connection.

pub async fn bind_endpoint( tls_ca_certificate_pem: Option<&str>, ) -> Result<Endpoint>

Bind without routing hints so HTTPS trust discovery can run concurrently. Only verified relays are installed before connecting.

pub async fn connect_bound_endpoint( endpoint: Endpoint, address: EndpointAddr, credential: Credentials, timeout: Duration, description: Option<DescribeEndpointResponse>, tls_ca_certificate_pem: Option<&str>, ) -> Result<Self>

Finish connecting an independently bound endpoint to a verified address.

pub fn local_endpoint_id(&self) -> EndpointId

pub fn endpoint(&self) -> &Endpoint

pub fn connection(&self) -> &Connection

pub fn into_parts( self, ) -> (Remote<IrohTransport<Credentials>>, Endpoint, Connection)

Release the discovered remote and the live Iroh session without closing.

The caller becomes responsible for closing connection / endpoint.

pub async fn close(&self)

Cancel this connection’s streams and await endpoint shutdown.

Trait Implementations

impl Drop for HostedClient

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.