Struct thrift::transport::TFramedTransport

pub struct TFramedTransport { /* fields omitted */ }

Transport that communicates with endpoints using framed messages.

A TFramedTransport maintains a fixed-size internal write buffer. All writes are made to this buffer and are sent to the wrapped transport only when TTransport::flush() is called. On a flush a fixed-length header with a count of the buffered bytes is written, followed by the bytes themselves.

A TFramedTransport also maintains a fixed-size internal read buffer. On a call to TTransport::read(...) one full message - both fixed-length header and bytes - is read from the wrapped transport and buffered. Subsequent read calls are serviced from the internal buffer until it is exhausted, at which point the next full message is read from the wrapped transport.

Examples

Create and use a TFramedTransport.

use std::cell::RefCell;
use std::rc::Rc;
use std::io::{Read, Write};
use thrift::transport::{TFramedTransport, TTcpTransport, TTransport};

let mut t = TTcpTransport::new();
t.open("localhost:9090").unwrap();

let t = Rc::new(RefCell::new(Box::new(t) as Box<TTransport>));
let mut t = TFramedTransport::new(t);

// read
t.read(&mut vec![0u8; 1]).unwrap();

// write
t.write(&[0x00]).unwrap();
t.flush().unwrap();

Methods

impl TFramedTransport

fn new(inner: Rc<RefCell<Box<TTransport>>>) -> TFramedTransport

Create a TFramedTransport with default-sized internal read and write buffers that wraps an inner TTransport.

fn with_capacity(read_buffer_capacity: usize,
                 write_buffer_capacity: usize,
                 inner: Rc<RefCell<Box<TTransport>>>)
                 -> TFramedTransport

Create a TFramedTransport with an internal read buffer of size read_buffer_capacity and an internal write buffer of size write_buffer_capacity that wraps an inner TTransport.

Trait Implementations

impl Read for TFramedTransport

fn read(&mut self, b: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

Unstable (io)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Write for TFramedTransport

fn write(&mut self, b: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.