pub struct FileEncoder {
    buf: Box<[MaybeUninit<u8>]>,
    buffered: usize,
    flushed: usize,
    file: File,
    res: Result<(), Error>,
}
Expand description

FileEncoder encodes data to file via fixed-size buffer.

When encoding large amounts of data to a file, using FileEncoder may be preferred over using MemEncoder to encode to a Vec, and then writing the Vec to file, as the latter uses as much memory as there is encoded data, while the former uses the fixed amount of memory allocated to the buffer. FileEncoder also has the advantage of not needing to reallocate as data is appended to it, but the disadvantage of requiring more error handling, which has some runtime overhead.

Fields§

§buf: Box<[MaybeUninit<u8>]>

The input buffer. For adequate performance, we need more control over buffering than BufWriter offers. If BufWriter ever offers a raw buffer access API, we can use it, and remove buf and buffered.

§buffered: usize§flushed: usize§file: File§res: Result<(), Error>

Implementations§

source§

impl FileEncoder

source

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self>

source

pub fn with_capacity<P: AsRef<Path>>(path: P, capacity: usize) -> Result<Self>

source

pub fn position(&self) -> usize

source

pub fn flush(&mut self)

source

pub fn file(&self) -> &File

source

fn capacity(&self) -> usize

source

fn write_one(&mut self, value: u8)

source

fn write_all(&mut self, buf: &[u8])

source

fn write_all_unbuffered(&mut self, buf: &[u8])

source

pub fn finish(self) -> Result<usize, Error>

Trait Implementations§

source§

impl Drop for FileEncoder

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Encodable<FileEncoder> for [u8]

source§

fn encode(&self, e: &mut FileEncoder)

source§

impl Encodable<FileEncoder> for IntEncodedWithFixedSize

source§

fn encode(&self, e: &mut FileEncoder)

source§

impl Encoder for FileEncoder

source§

fn emit_usize(&mut self, v: usize)

source§

fn emit_u128(&mut self, v: u128)

source§

fn emit_u64(&mut self, v: u64)

source§

fn emit_u32(&mut self, v: u32)

source§

fn emit_u16(&mut self, v: u16)

source§

fn emit_u8(&mut self, v: u8)

source§

fn emit_isize(&mut self, v: isize)

source§

fn emit_i128(&mut self, v: i128)

source§

fn emit_i64(&mut self, v: i64)

source§

fn emit_i32(&mut self, v: i32)

source§

fn emit_i16(&mut self, v: i16)

source§

fn emit_i8(&mut self, v: i8)

source§

fn emit_bool(&mut self, v: bool)

source§

fn emit_f64(&mut self, v: f64)

source§

fn emit_f32(&mut self, v: f32)

source§

fn emit_char(&mut self, v: char)

source§

fn emit_str(&mut self, v: &str)

source§

fn emit_raw_bytes(&mut self, s: &[u8])

source§

fn emit_enum_variant<F>(&mut self, v_id: usize, f: F)where
    F: FnOnce(&mut Self),

source§

fn emit_fieldless_enum_variant<const ID: usize>(&mut self)

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes