Struct chomp::buffer::Source
[−]
[src]
pub struct Source<S: DataSource, B: Buffer<S::Item>> { /* fields omitted */ }
Manages a buffer and data source pair, enabling efficient parsing from a streaming source.
Methods
impl<R: Read> Source<ReadDataSource<R>, FixedSizeBuffer<u8>>
[src]
fn new(source: R) -> Self
Creates a new Source
from a Read
instance with the default FixedSizeBuffer
settings.
impl<R: Read, B: Buffer<u8>> Source<ReadDataSource<R>, B>
[src]
fn from_read(source: R, buffer: B) -> Self
Creates a new Source
from Read
and buffer instances.
impl<RW: Read + Write> Source<RWDataSource<RW>, FixedSizeBuffer<u8>>
[src]
fn new_rw(rwsource: RW) -> Self
Creates a new Source
from Read
+Write
with the default FixedSizeBuffer
settings.
impl<RW: Read + Write, B: Buffer<u8>> Source<RWDataSource<RW>, B>
[src]
fn from_read_write(source: RW, buffer: B) -> Self
Creates a new Source
from Read
+Write
and buffer instances.
impl<I: Iterator, B: Buffer<I::Item>> Source<IteratorDataSource<I>, B> where
I::Item: Copy + PartialEq,
[src]
I::Item: Copy + PartialEq,
fn from_iter(source: I, buffer: B) -> Self
Creates a new Source
from Iterator
and Buffer
instances.
impl<S: DataSource, B: Buffer<S::Item>> Source<S, B>
[src]
fn with_buffer(source: S, buffer: B) -> Self
Creates a new Source
from DataSource
and Buffer
instances.
fn fill(&mut self) -> Result<usize>
Attempts to fill the buffer to satisfy the last call to parse()
.
fn len(&self) -> usize
Returns the number of bytes left in the buffer which have not yet been parsed.
fn is_empty(&self) -> bool
If the buffer is empty and the reader has reached the end.
fn capacity(&self) -> usize
Returns the capacity of the underlying buffer.
This is the maximum number of input items the buffer can store.
fn buffer(&self) -> &[S::Item]
Borrows the remainder of the buffer.
fn reset(&mut self)
Resets the buffer state, keeping the current buffer contents and cursor position.
This is useful when streaming data and more data has been made available on a socket/stream.
fn set_autofill(&mut self, value: bool)
Changes the setting automatic fill feature, true
will make the buffer automatically
call fill()
on the next call to parse()
after a Retry
was encountered.
Trait Implementations
impl<S: Debug + DataSource, B: Debug + Buffer<S::Item>> Debug for Source<S, B>
[src]
impl<S: DataSource<Item = u8>, B: Buffer<u8>> Read for Source<S, B>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
fn chars(self) -> Chars<Self>
🔬 This is a nightly-only experimental API. (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 char
s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<S: DataSource<Item = u8>, B: Buffer<u8>> BufRead for Source<S, B>
[src]
fn fill_buf(&mut self) -> Result<&[u8]>
Fills the internal buffer of this object, returning the buffer contents. Read more
fn consume(&mut self, num: usize)
Tells this buffer that amt
bytes have been consumed from the buffer, so they should no longer be returned in calls to read
. Read more
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes into buf
until the delimiter byte
or EOF is reached. Read more
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more
fn split(self, byte: u8) -> Split<Self>
1.0.0
Returns an iterator over the contents of this reader split on the byte byte
. Read more
fn lines(self) -> Lines<Self>
1.0.0
Returns an iterator over the lines of this reader. Read more
impl<RW: Read + Write, B: Buffer<u8>> Write for Source<RWDataSource<RW>, B>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more
impl<'a, S: DataSource, B: Buffer<S::Item>> Stream<'a, 'a> for Source<S, B> where
S::Item: 'a,
[src]
S::Item: 'a,
type Input = InputBuf<'a, S::Item>
The input item type, usually depending on which DataSource
is used.
fn parse<F, T, E>(
&'a mut self,
f: F
) -> Result<T, StreamError<<Self::Input as Input>::Buffer, E>> where
F: FnOnce(Self::Input) -> ParseResult<Self::Input, T, E>,
T: 'a,
E: 'a,
&'a mut self,
f: F
) -> Result<T, StreamError<<Self::Input as Input>::Buffer, E>> where
F: FnOnce(Self::Input) -> ParseResult<Self::Input, T, E>,
T: 'a,
E: 'a,
Attempts to run the supplied parser F
once on the currently populated data in this stream, providing a borrow of the inner data storage. Read more