Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Wrap json_client send request between nodes or browsers.

Implementations§

Source§

impl Client

Source

pub fn new(endpoint_url: &str) -> Result<Self>

Creates a new Client instance with the specified endpoint URL and signature.

Source

pub async fn connect_peer_via_http( &mut self, url: &str, ) -> Result<ClientOutput<String>>

Establishes a WebRTC connection with a remote peer using HTTP as the signaling channel.

This function allows two peers to establish a WebRTC connection using HTTP, which can be useful in scenarios where a direct peer-to-peer connection is not possible due to firewall restrictions or other network issues. The function sends ICE candidates and Session Description Protocol (SDP) messages over HTTP as a form of signaling to establish the connection.

Takes a URL for an HTTP server that will be used as the signaling channel to exchange ICE candidates and SDP with the remote peer. Returns a Did that can be used to refer to this connection in subsequent WebRTC operations.

Source

pub async fn connect_with_seed( &mut self, source: &str, ) -> Result<ClientOutput<()>>

Attempts to connect to a peer using a seed file located at the specified source path.

Source

pub async fn connect_with_did(&mut self, did: &str) -> Result<ClientOutput<()>>

Attempts to connect to a peer using a DID stored in a Distributed Hash Table (DHT).

Source

pub async fn list_peers(&mut self) -> Result<ClientOutput<()>>

Lists all connected peers and their status.

Returns an Output containing a formatted string representation of the list of peers if successful, or an anyhow::Error if an error occurred.

Source

pub async fn disconnect(&mut self, did: &str) -> Result<ClientOutput<()>>

Disconnects from the peer with the specified DID.

Source

pub async fn send_message( &self, did: &str, namespace: &str, data: &str, ) -> Result<ClientOutput<()>>

Sends a namespaced message to the specified peer, routed to the peer’s protocol registered under namespace (the extension Envelope model).

Source

pub async fn register_service(&self, name: &str) -> Result<ClientOutput<()>>

Registers a new service with the given name.

Source

pub async fn lookup_service(&self, name: &str) -> Result<ClientOutput<()>>

Looks up the DIDs of services registered with the given name.

Source

pub async fn publish_message_to_topic( &self, topic: &str, data: &str, ) -> Result<ClientOutput<()>>

Publishes a message to the specified topic.

Source

pub async fn subscribe_topic<'a, 'b>( &'a self, topic: String, ) -> impl Stream<Item = String> + 'b
where 'a: 'b,

Subscribes to the specified topic and returns a stream of messages published to the topic.

Source

pub async fn inspect(&self) -> Result<ClientOutput<SwarmInfo>>

Query for swarm inspect info.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T> MaybeSend for T
where T: Send + Sync,

Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more