Struct mysql_common::proto::sync_framed::MySyncFramed

pub struct MySyncFramed<T> { /* private fields */ }

Synchronous framed stream for MySql protocol.

This type is a synchronous alternative to tokio_codec::Framed.

Implementations

impl<T> MySyncFramed<T>

pub fn new(stream: T) -> Self

Creates new instance with the given stream.

pub fn get_ref(&self) -> &T

Returns reference to a stream.

pub fn get_mut(&mut self) -> &mut T

Returns mutable reference to a stream.

pub fn codec(&self) -> &PacketCodec

Returns reference to a codec.

pub fn codec_mut(&mut self) -> &mut PacketCodec

Returns mutable reference to a codec.

pub fn destruct(self) -> (BytesMut, BytesMut, PacketCodec, T)

Consumes self and returns wrapped buffers, codec and stream.

pub fn construct( in_buf: BytesMut, out_buf: BytesMut, codec: PacketCodec, stream: T ) -> Self

Creates new instance from given buffers, codec and stream.

impl<T> MySyncFramed<T>where T: Write,

pub fn write<U: Buf>(&mut self, item: &mut U) -> Result<(), PacketCodecError>

Will write packets into the stream. Stream may not be flushed.

pub fn flush(&mut self) -> Result<(), PacketCodecError>

Will flush wrapped stream.

pub fn send<U: Buf>(&mut self, item: &mut U) -> Result<(), PacketCodecError>

Will send packets into the stream. Stream will be flushed.

impl<T> MySyncFramed<T>where T: Read,

pub fn next_packet<U>(&mut self, dst: &mut U) -> Result<bool, PacketCodecError>where U: AsRef<[u8]> + BufMut,

Returns true if dst contains the next packet.

false means, that the dst is empty and the stream is at eof.

Trait Implementations

impl<T: Debug> Debug for MySyncFramed<T>

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

Formats the value using the given formatter.