Struct bdk_chain::bitcoin::io::Cursor

pub struct Cursor<T> { /* private fields */ }

Wraps an in memory reader providing the position function.

Implementations

impl<T> Cursor<T>

where T: AsRef<[u8]>,

pub fn new(inner: T) -> Cursor<T>

Creates a Cursor by wrapping inner.

pub fn position(&self) -> u64

Returns the position read up to thus far.

pub fn set_position(&mut self, position: u64)

Sets the internal position.

This method allows seeking within the wrapped memory by setting the position.

Note that setting a position that is larger than the buffer length will cause reads to return no bytes (EOF).

pub fn into_inner(self) -> T

Returns the inner buffer.

This is the whole wrapped buffer, including the bytes already read.

pub fn inner(&self) -> &T

Returns a reference to the inner buffer.

This is the whole wrapped buffer, including the bytes already read.

Trait Implementations

impl<T> BufRead for Cursor<T>

where T: AsRef<[u8]>,

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

Returns data read from this reader, filling the internal buffer if needed.

fn consume(&mut self, amount: usize)

Marks the buffered data up to amount as consumed.

impl<T> Read for Cursor<T>

where T: AsRef<[u8]>,

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

Reads bytes from source into buf.

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

Reads bytes from source until buf is full.

fn take(&mut self, limit: u64) -> Take<'_, Self>

Creates an adapter which will read at most limit bytes.

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

Attempts to read up to limit bytes from the reader, allocating space in buf as needed.