Skip to main content

StdioTransport

Struct StdioTransport 

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

Stdio transport for JSON-RPC communication

Supports two modes:

  1. Native mode: Uses process stdin/stdout directly
  2. Child mode: Communicates with a spawned child process

Implementations§

Source§

impl StdioTransport

Source

pub fn new() -> Self

Create a new stdio transport using stdin/stdout

This is used for server-side communication where the process reads from stdin and writes to stdout.

Source

pub fn with_config(config: TransportConfig) -> Self

Create a new stdio transport with custom configuration

Source

pub fn from_streams<R, W>(reader: R, writer: W, config: TransportConfig) -> Self
where R: AsyncRead + Send + Unpin + 'static, W: AsyncWrite + Send + Unpin + 'static,

Create a stdio transport from async read/write streams

Wraps the reader in a BufReader for efficient reading.

Source

pub async fn spawn_child(command: &mut Command) -> Result<Self>

Spawn a child process and create a transport to communicate with it

The child process should implement the JSON-RPC protocol over stdio.

Source

pub async fn spawn_child_with_config( command: &mut Command, config: TransportConfig, ) -> Result<Self>

Spawn a child process with custom configuration

Source

pub fn with_tokio_stdio() -> Self

Initialize with tokio stdin/stdout

Must be called within a tokio runtime context.

Source

pub fn child(&mut self) -> Option<&mut Child>

Get the child process if this transport was created via spawn_child

Source

pub fn is_child_running(&mut self) -> bool

Check if there’s a child process and if it’s still running

Source

pub async fn wait_child(&mut self) -> Result<Option<ExitStatus>>

Wait for the child process to exit and return its status

Trait Implementations§

Source§

impl Default for StdioTransport

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Transport for StdioTransport

Source§

fn send<'life0, 'life1, 'async_trait>( &'life0 mut self, message: &'life1 JsonRpcMessage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send a message through the transport
Source§

fn receive<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<JsonRpcMessage>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Receive a message from the transport
Source§

fn close<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Close the transport
Source§

fn is_closed(&self) -> bool

Check if the transport is closed

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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