Skip to main content

Take

Struct Take 

Source
pub struct Take<T> { /* private fields */ }
Expand description

Reader adapter which limits the bytes read from an underlying reader.

This struct is generally created by calling take on a reader. Please see the documentation of take for more details.

See std::io::Take for more details.

Implementations§

Source§

impl<T> Take<T>

Source

pub fn limit(&self) -> u64

Returns the number of bytes that can be read before this instance will return EOF.

Source

pub fn position(&self) -> u64

Returns the number of bytes read so far.

Source

pub fn set_limit(&mut self, limit: u64)

Sets the number of bytes that can be read before this instance will return EOF. This is the same as constructing a new Take instance, so the amount of bytes read and the previous limit value don’t matter when calling this method.

Source

pub fn into_inner(self) -> T

Consumes the Take, returning the wrapped reader.

Source

pub fn get_ref(&self) -> &T

Gets a reference to the underlying reader.

Care should be taken to avoid modifying the internal I/O state of the underlying reader as doing so may corrupt the internal limit of this Take.

Source

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying reader.

Care should be taken to avoid modifying the internal I/O state of the underlying reader as doing so may corrupt the internal limit of this Take.

Trait Implementations§

Source§

impl<T: BufRead> BufRead for Take<T>

Source§

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.
Source§

fn consume(&mut self, amt: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.
Source§

fn has_data_left(&mut self) -> Result<bool>

Checks if there is any data left to be read.
Source§

fn skip_until(&mut self, byte: u8) -> Result<usize>

Skips all bytes until the delimiter byte or EOF is reached.
Source§

impl<T: Debug> Debug for Take<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: IoBuf> IoBuf for Take<T>

Source§

fn remaining(&self) -> usize

Returns the number of bytes between the current position and the end of the buffer.
Source§

fn is_empty(&self) -> bool

Returns true if there are no remaining bytes in the buffer.
Source§

impl<T: Read> Read for Take<T>

Source§

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.
Source§

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

Pull some bytes from this source into the specified buffer. Read more
Source§

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

Read the exact number of bytes required to fill buf.
Source§

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

Reads the exact number of bytes required to fill cursor. Read more
Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

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

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

Creates an adapter which will chain this stream with another. Read more
Source§

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

Creates an adapter which will read at most limit bytes from it. Read more
Source§

impl<T: Seek> Seek for Take<T>

Source§

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more
Source§

fn stream_len(&mut self) -> Result<u64>

Returns the length of this stream (in bytes).
Source§

fn stream_position(&mut self) -> Result<u64>

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

fn seek_relative(&mut self, offset: i64) -> Result<()>

Seeks relative to the current position.
Source§

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

Rewind to the beginning of a stream. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Take<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Take<T>
where T: RefUnwindSafe,

§

impl<T> Send for Take<T>
where T: Send,

§

impl<T> Sync for Take<T>
where T: Sync,

§

impl<T> Unpin for Take<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Take<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Take<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IoBufExt for T
where T: Read + IoBuf + ?Sized,

Source§

fn write_to<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<usize>

Reads some bytes from this buffer and writes them into writer.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.