ByteStreams

Struct ByteStreams 

Source
pub struct ByteStreams<OB, IB> {
    pub outgoing: OB,
    pub incoming: IB,
}
Expand description

A component that communicates over byte streams (stdin/stdout, sockets, pipes, etc.).

ByteStreams implements the Component trait for any pair of AsyncRead and AsyncWrite streams, handling serialization of JSON-RPC messages to/from newline-delimited JSON. This is the standard way to communicate with external processes or network connections.

§Use Cases

  • Stdio communication: Connect to agents or proxies via stdin/stdout
  • Network sockets: TCP, Unix domain sockets, or other stream-based protocols
  • Named pipes: Cross-process communication on the same machine
  • File I/O: Reading from and writing to file descriptors

§Example

Connecting to an agent via stdio:

use sacp::link::UntypedLink;
use tokio_util::compat::{TokioAsyncReadCompatExt, TokioAsyncWriteCompatExt};

let component = ByteStreams::new(
    tokio::io::stdout().compat_write(),
    tokio::io::stdin().compat(),
);

// Use as a component in a connection
sacp::link::UntypedLink::builder()
    .name("my-client")
    .serve(component)
    .await?;

Fields§

§outgoing: OB

Outgoing byte stream (where we write serialized messages)

§incoming: IB

Incoming byte stream (where we read and parse messages)

Implementations§

Source§

impl<OB, IB> ByteStreams<OB, IB>
where OB: AsyncWrite + Send + 'static, IB: AsyncRead + Send + 'static,

Source

pub fn new(outgoing: OB, incoming: IB) -> Self

Create a new byte stream transport.

Trait Implementations§

Source§

impl<OB, IB, L: JrLink> Component<L> for ByteStreams<OB, IB>
where OB: AsyncWrite + Send + 'static, IB: AsyncRead + Send + 'static,

Source§

async fn serve(self, client: impl Component<L::ConnectsTo>) -> Result<(), Error>

Serve this component by forwarding to a client component. Read more
Source§

fn into_server(self) -> (Channel, BoxFuture<'static, Result<(), Error>>)

Convert this component into a channel endpoint and server future. Read more

Auto Trait Implementations§

§

impl<OB, IB> Freeze for ByteStreams<OB, IB>
where OB: Freeze, IB: Freeze,

§

impl<OB, IB> RefUnwindSafe for ByteStreams<OB, IB>

§

impl<OB, IB> Send for ByteStreams<OB, IB>
where OB: Send, IB: Send,

§

impl<OB, IB> Sync for ByteStreams<OB, IB>
where OB: Sync, IB: Sync,

§

impl<OB, IB> Unpin for ByteStreams<OB, IB>
where OB: Unpin, IB: Unpin,

§

impl<OB, IB> UnwindSafe for ByteStreams<OB, IB>
where OB: UnwindSafe, IB: UnwindSafe,

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoMaybeUndefined<T> for T

Source§

impl<T> IntoOption<T> for T

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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