Struct Channel 

pub struct Channel { /* private fields */ }

Data pipelines that transmit bytes bidirectionally.

Implementations

impl Channel

pub async fn create(client: &Client, capacity: u32) -> Result<Self, ClientError>

Create a channel using the remote-client guest.

pub fn new(client: &Client, handle: GuestResourceId) -> Self

Construct a handle to an existing channel.

Safety

handle must be a valid channel capability minted for the current client; forged or stale handles will be rejected by the remote guest and may cause the connection to be closed.

pub async fn delete(self) -> Result<(), ClientError>

Delete this channel.

pub async fn subscribe( &self, chunk_size: u32, ) -> Result<Subscriber, ClientError>

Subscribe to this channel as a Subscriber of byte payloads.

Examples

use futures::{StreamExt, pin_mut};

let mut subscriber = channel.subscribe(64 * 1024).await?;
pin_mut!(subscriber);
if let Some(frame) = subscriber.next().await {
    let payload = frame?;
    eprintln!("received {} bytes", payload.len());
}

pub async fn subscribe_shared( &self, chunk_size: u32, ) -> Result<Subscriber, ClientError>

Subscribe to this channel as a Subscriber of byte payloads.

Examples

use futures::{StreamExt, pin_mut};

let mut subscriber = channel.subscribe_shared(64 * 1024).await?;
pin_mut!(subscriber);
if let Some(frame) = subscriber.next().await {
    let payload = frame?;
    eprintln!("received {} bytes", payload.len());
}

pub async fn publish(&self) -> Result<Publisher, ClientError>

Create a publisher for this channel. The returned Sink streams raw payloads.

Examples

use futures::SinkExt;

let mut publisher = channel.publish().await?;
publisher.send(b"hello".to_vec()).await?;
publisher.close().await?;

pub fn handle(&self) -> GuestResourceId

Expose the raw handle.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.