Struct bitcoin_primitives::AutoFile

pub struct AutoFile { /* private fields */ }

| Non-refcounted RAII wrapper for FILE* | | Will automatically close the file when | it goes out of scope if not null. | | If you’re returning the file pointer, | return file.release(). | | If you need to close the file early, use | file.fclose() instead of fclose(file). |

Implementations

impl AutoFile

pub fn new(filenew: *mut FILE, n_type_in: i32, n_version_in: i32) -> Self

pub fn fclose(&mut self)

pub fn release(&mut self) -> *mut FILE

| Get wrapped FILE* with transfer of ownership. | | ———– | @note | | This will invalidate the AutoFile | object, and makes it the responsibility | of the caller of this function to clean | up the returned FILE*. |

pub fn get(&self) -> *mut FILE

| Get wrapped FILE* without transfer | of ownership. | | ———– | @note | | Ownership of the FILE* will remain with | this class. Use this only if the scope | of the | | AutoFile outlives use of the passed | pointer. |

pub fn is_null(&self) -> bool

| Return true if the wrapped FILE* is nullptr, | false otherwise. |

pub fn get_type(&self) -> i32

pub fn get_version(&self) -> i32

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

pub fn ignore(&mut self, n_size: usize)

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

Trait Implementations

impl Drop for AutoFile

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Shl<&T> for AutoFile

type Output = AutoFile

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> Shr<T> for AutoFile

type Output = AutoFile

The resulting type after applying the >> operator.

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

Performs the >> operation.