Struct bitcoin_primitives::BufferedFile

pub struct BufferedFile { /* private fields */ }

| Non-refcounted RAII wrapper around | a FILE* that implements a ring buffer | to deserialize from. It guarantees | the ability to rewind a given number | of bytes. | | Will automatically close the file when | it goes out of scope if not null. | | If you need to close the file early, use | file.fclose() instead of fclose(file). |

Implementations

impl BufferedFile

pub fn fill(&mut self) -> bool

| read data from the source to fill the | buffer |

pub fn new( file_in: *mut FILE, n_buf_size: u64, n_rewind_in: u64, n_type_in: i32, n_version_in: i32 ) -> Self

pub fn get_version(&self) -> i32

pub fn get_type(&self) -> i32

pub fn fclose(&mut self)

pub fn eof(&self) -> bool

| check whether we’re at the end of the | source file |

pub fn read(&mut self, pch: *mut u8, n_size: usize)

| read a number of bytes |

pub fn get_pos(&self) -> u64

| return the current reading position |

pub fn set_pos(&mut self, n_pos: u64) -> bool

| rewind to a given reading position |

pub fn set_limit(&mut self, n_pos: Option<u64>) -> bool

| prevent reading beyond a certain position | no argument removes the limit |

pub fn find_byte(&mut self, ch: u8)

| search for a given byte in the stream, | and remain positioned on it |

Trait Implementations

impl Drop for BufferedFile

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Shr<T> for BufferedFile

type Output = BufferedFile

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> Self::Output

Performs the >> operation.