Struct stack_buffer::StackBufWriter[][src]

pub struct StackBufWriter<W: Write, const N: usize = 8192_usize> { /* fields omitted */ }
Expand description

Wraps a writer and buffers its output.

See BufWriter for more details.

Examples

Let’s write the numbers one through ten to a TcpStream:

use std::io::prelude::*;
use std::net::TcpStream;

let mut stream = TcpStream::connect("127.0.0.1:34254").unwrap();

for i in 0..10 {
    stream.write(&[i+1]).unwrap();
}

Because we’re not buffering, we write each one in turn, incurring the overhead of a system call per byte written. We can fix this with a StackBufWriter<W, N>:

use std::io::prelude::*;
use std::net::TcpStream;
use stack_buffer::StackBufWriter;

let mut stream = StackBufWriter::<_, 8192>::new(TcpStream::connect("127.0.0.1:34254").unwrap());

for i in 0..10 {
    stream.write(&[i+1]).unwrap();
}
stream.flush().unwrap();

By wrapping the stream with a StackBufWriter<W, N>, these ten writes are all grouped together by the buffer and will all be written out in one system call when the stream is flushed.

Implementations

Creates a new StackBufWriter<W, N>.

Examples
use std::net::TcpStream;
use stack_buffer::StackBufWriter;

let mut buffer = StackBufWriter::<_, 8192>::new(TcpStream::connect("127.0.0.1:34254").unwrap());

Gets a reference to the underlying writer.

Examples
use std::net::TcpStream;
use stack_buffer::StackBufWriter;

let mut buffer = StackBufWriter::<_, 8192>::new(TcpStream::connect("127.0.0.1:34254").unwrap());

// we can use reference just like buffer
let reference = buffer.get_ref();

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

Examples
use std::net::TcpStream;
use stack_buffer::StackBufWriter;

let mut buffer = StackBufWriter::<_, 8192>::new(TcpStream::connect("127.0.0.1:34254").unwrap());

// we can use reference just like buffer
let reference = buffer.get_mut();

Returns a reference to the internally buffered data.

Examples
use std::net::TcpStream;
use stack_buffer::StackBufWriter;

let buf_writer = StackBufWriter::<_, 8192>::new(TcpStream::connect("127.0.0.1:34254").unwrap());

// See how many bytes are currently buffered
let bytes_buffered = buf_writer.buffer().len();

Returns the number of bytes the internal buffer can hold without flushing.

Examples
use std::net::TcpStream;
use stack_buffer::StackBufWriter;

let buf_writer = StackBufWriter::<_, 8192>::new(TcpStream::connect("127.0.0.1:34254").unwrap());

// Check the capacity of the inner buffer
let capacity = buf_writer.capacity();
// Calculate how many bytes can be written without flushing
let without_flush = capacity - buf_writer.buffer().len();

Trait Implementations

Formats the value using the given formatter. Read more

Executes the destructor for this type. Read more

Seek to the offset, in bytes, in the underlying writer.

Seeking always writes out the internal buffer before seeking.

Rewind to the beginning of a stream. Read more

🔬 This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes). Read more

Returns the current seek position from the start of the stream. Read more

Write a buffer into this writer, returning how many bytes were written. Read more

Like write, except that it writes from a slice of buffers. Read more

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation. Read more

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

Attempts to write an entire buffer into this writer. Read more

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer. Read more

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

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.