Struct glommio::io::StreamReaderBuilder

pub struct StreamReaderBuilder { /* fields omitted */ }

Builds a StreamReader, allowing linear read access to a BufferedFile

Implementations

impl StreamReaderBuilder

#[must_use = "The builder must be built to be useful"]pub fn new(file: BufferedFile) -> StreamReaderBuilder

Creates a new StreamReaderBuilder, given a BufferedFile

Various properties can be set by using its with methods.

A StreamReader can later be constructed from it by calling build

Examples

use glommio::io::{BufferedFile, StreamReaderBuilder};
use glommio::LocalExecutor;

let ex = LocalExecutor::make_default();
ex.run(async {
    let file = BufferedFile::open("myfile.txt").await.unwrap();
    let _reader = StreamReaderBuilder::new(file).build();
});

pub fn with_start_pos(self, start: u64) -> Self

Define a starting position.

Reads from the StreamReader will start from this position

pub fn with_end_pos(self, end: u64) -> Self

Define an end position.

Reads from the StreamReader will end at this position even if the file is larger.

pub fn with_buffer_size(self, buffer_size: usize) -> Self

Define the buffer size that will be used by the StreamReader

pub fn build(self) -> StreamReader

Builds a StreamReader with the properties defined by this StreamReaderBuilder

Trait Implementations

impl Debug for StreamReaderBuilder

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

Formats the value using the given formatter.