Struct bore_cli::shared::Delimited

source · [−]

pub struct Delimited<U>(_);

Expand description

Transport stream with JSON frames delimited by null characters.

Implementations

source

impl<U: AsyncRead + AsyncWrite + Unpin> Delimited

source

pub fn new(stream: U) -> Self

Construct a new delimited stream.

source

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

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

source

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.

source

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

Send a null-terminated JSON instruction on a stream.

source

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

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

Auto Trait Implementations

impl RefUnwindSafe for Delimited where
U: RefUnwindSafe,

impl Send for Delimited where
U: Send,

impl Sync for Delimited where
U: Sync,

impl Unpin for Delimited where
U: Unpin,

impl UnwindSafe for Delimited where
U: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct bore_cli::shared::Delimited

Implementations

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

pub fn new(stream: U) -> Self

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

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

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

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

Auto Trait Implementations

impl<U> RefUnwindSafe for Delimited<U> where
U: RefUnwindSafe,

impl<U> Send for Delimited<U> where
U: Send,

impl<U> Sync for Delimited<U> where
U: Sync,

impl<U> Unpin for Delimited<U> where
U: Unpin,

impl<U> UnwindSafe for Delimited<U> where
U: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct bore_cli::shared::Delimited

Implementations

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

pub fn new(stream: U) -> Self

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

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

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

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

Auto Trait Implementations

impl<U> RefUnwindSafe for Delimited<U> where U: RefUnwindSafe,

impl<U> Send for Delimited<U> where U: Send,

impl<U> Sync for Delimited<U> where U: Sync,

impl<U> Unpin for Delimited<U> where U: Unpin,

impl<U> UnwindSafe for Delimited<U> where U: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<U> RefUnwindSafe for Delimited<U> where
U: RefUnwindSafe,

impl<U> Send for Delimited<U> where
U: Send,

impl<U> Sync for Delimited<U> where
U: Sync,

impl<U> Unpin for Delimited<U> where
U: Unpin,

impl<U> UnwindSafe for Delimited<U> where
U: UnwindSafe,

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

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

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

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

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

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

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