Struct bore_cli::shared::Delimited

pub struct Delimited<U>(/* private fields */);

Transport stream with JSON frames delimited by null characters.

Implementations

impl<U: AsyncRead + AsyncWrite + Unpin> Delimited<U>

pub fn new(stream: U) -> Self

Construct a new delimited stream.

pub async fn recv<T: DeserializeOwned>(&mut self) -> Result<Option<T>>

Read the next null-delimited JSON instruction from a stream.

pub async fn recv_timeout<T: DeserializeOwned>(&mut self) -> Result<Option<T>>

Read the next null-delimited JSON instruction, with a default timeout.

This is useful for parsing the initial message of a stream for handshake or other protocol purposes, where we do not want to wait indefinitely.

pub async fn send<T: Serialize>(&mut self, msg: T) -> Result<()>

Send a null-terminated JSON instruction on a stream.

pub fn into_parts(self) -> FramedParts<U, AnyDelimiterCodec>

Consume this object, returning current buffers and the inner transport.