Struct CharWhitelist

pub struct CharWhitelist<T>
where
    T: Read,
{ /* private fields */ }

Removes all non-whitelisted characters from the wrapped stream.

Non-utf8 characters are lost due to internal string conversions using String::from_utf8_lossy().

use readfilter::CharWhitelist;
use std::io::Read;
let buf = "aabbccddee".as_bytes();
let mut wrapped = CharWhitelist::new(buf, "ace");
let mut s = String::new();
wrapped.read_to_string(&mut s).unwrap();
assert_eq!(&s, "aaccee");

use readfilter::CharWhitelist;
use std::fs::OpenOptions;
use std::io::Read;
let mut output = vec![];
let fd = OpenOptions::new().read(true).open("input.txt").unwrap();
let mut input = CharWhitelist::new(fd, "01");
input.read_to_end(&mut output);
// output only contains the '0' and '1' characters from input.txt

Implementations

impl<T> CharWhitelist<T>

where T: Read,

pub fn new(source: T, allowed_chars: &str) -> Self

Trait Implementations

impl<T> Read for CharWhitelist<T>

where T: Read,

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

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

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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