[][src]Enum ggez::filesystem::File

pub enum File {
    VfsFile(Box<dyn VFile>),
}

Represents a file, either in the filesystem, or in the resources zip file, or whatever.

Variants

VfsFile(Box<dyn VFile>)

A wrapper for a VFile trait object.

Trait Implementations

impl Debug for File[src]

impl Read for File[src]

default fn read_vectored(
    &mut self,
    bufs: &mut [IoVecMut]
) -> Result<usize, Error>
[src]

🔬 This is a nightly-only experimental API. (iovec)

Like read, except that it reads into a slice of buffers. Read more

unsafe default fn initializer(&self) -> Initializer[src]

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory. Read more

default fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
[src]

Read all bytes until EOF in this source, placing them into buf. Read more

default fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
[src]

Read all bytes until EOF in this source, appending them to buf. Read more

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

Read the exact number of bytes required to fill buf. Read more

default fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

Creates a "by reference" adaptor for this instance of Read. Read more

default fn bytes(self) -> Bytes<Self>
1.0.0
[src]

Transforms this Read instance to an [Iterator] over its bytes. Read more

default fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read
1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

default fn take(self, limit: u64) -> Take<Self>
1.0.0
[src]

Creates an adaptor which will read at most limit bytes from it. Read more

impl Write for File[src]

default fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>[src]

🔬 This is a nightly-only experimental API. (iovec)

Like write, except that it writes from a slice of buffers. Read more

default fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
[src]

Attempts to write an entire buffer into this writer. Read more

default fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
[src]

Writes a formatted string into this writer, returning any error encountered. Read more

default fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

Creates a "by reference" adaptor for this instance of Write. Read more

Auto Trait Implementations

impl !Send for File

impl !Sync for File

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf for SP where
    SS: SubsetOf<SP>, 

impl<R> ReadBytesExt for R where
    R: Read + ?Sized

default fn read_u8(&mut self) -> Result<u8, Error>

Reads an unsigned 8 bit integer from the underlying reader. Read more

default fn read_i8(&mut self) -> Result<i8, Error>

Reads a signed 8 bit integer from the underlying reader. Read more

default fn read_u16<T>(&mut self) -> Result<u16, Error> where
    T: ByteOrder, 

Reads an unsigned 16 bit integer from the underlying reader. Read more

default fn read_i16<T>(&mut self) -> Result<i16, Error> where
    T: ByteOrder, 

Reads a signed 16 bit integer from the underlying reader. Read more

default fn read_u24<T>(&mut self) -> Result<u32, Error> where
    T: ByteOrder, 

Reads an unsigned 24 bit integer from the underlying reader. Read more

default fn read_i24<T>(&mut self) -> Result<i32, Error> where
    T: ByteOrder, 

Reads a signed 24 bit integer from the underlying reader. Read more

default fn read_u32<T>(&mut self) -> Result<u32, Error> where
    T: ByteOrder, 

Reads an unsigned 32 bit integer from the underlying reader. Read more

default fn read_i32<T>(&mut self) -> Result<i32, Error> where
    T: ByteOrder, 

Reads a signed 32 bit integer from the underlying reader. Read more

default fn read_u48<T>(&mut self) -> Result<u64, Error> where
    T: ByteOrder, 

Reads an unsigned 48 bit integer from the underlying reader. Read more

default fn read_i48<T>(&mut self) -> Result<i64, Error> where
    T: ByteOrder, 

Reads a signed 48 bit integer from the underlying reader. Read more

default fn read_u64<T>(&mut self) -> Result<u64, Error> where
    T: ByteOrder, 

Reads an unsigned 64 bit integer from the underlying reader. Read more

default fn read_i64<T>(&mut self) -> Result<i64, Error> where
    T: ByteOrder, 

Reads a signed 64 bit integer from the underlying reader. Read more

default fn read_u128<T>(&mut self) -> Result<u128, Error> where
    T: ByteOrder, 

Reads an unsigned 128 bit integer from the underlying reader. Read more

default fn read_i128<T>(&mut self) -> Result<i128, Error> where
    T: ByteOrder, 

Reads a signed 128 bit integer from the underlying reader. Read more

default fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error> where
    T: ByteOrder, 

Reads an unsigned n-bytes integer from the underlying reader. Read more

default fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error> where
    T: ByteOrder, 

Reads a signed n-bytes integer from the underlying reader. Read more

default fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error> where
    T: ByteOrder, 

Reads an unsigned n-bytes integer from the underlying reader.

default fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error> where
    T: ByteOrder, 

Reads a signed n-bytes integer from the underlying reader.

default fn read_f32<T>(&mut self) -> Result<f32, Error> where
    T: ByteOrder, 

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more

default fn read_f64<T>(&mut self) -> Result<f64, Error> where
    T: ByteOrder, 

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more

default fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more

default fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more

default fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more

default fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more

default fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of signed 16 bit integers from the underlying reader. Read more

default fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of signed 32 bit integers from the underlying reader. Read more

default fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of signed 64 bit integers from the underlying reader. Read more

default fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of signed 128 bit integers from the underlying reader. Read more

default fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more

default fn read_f32_into_unchecked<T>(
    &mut self,
    dst: &mut [f32]
) -> Result<(), Error> where
    T: ByteOrder, 

Deprecated since 1.2.0:

please use read_f32_into instead

DEPRECATED. Read more

default fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error> where
    T: ByteOrder, 

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more

default fn read_f64_into_unchecked<T>(
    &mut self,
    dst: &mut [f64]
) -> Result<(), Error> where
    T: ByteOrder, 

Deprecated since 1.2.0:

please use read_f64_into instead

DEPRECATED. Read more

impl<W> WriteBytesExt for W where
    W: Write + ?Sized

default fn write_u8(&mut self, n: u8) -> Result<(), Error>

Writes an unsigned 8 bit integer to the underlying writer. Read more

default fn write_i8(&mut self, n: i8) -> Result<(), Error>

Writes a signed 8 bit integer to the underlying writer. Read more

default fn write_u16<T>(&mut self, n: u16) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned 16 bit integer to the underlying writer. Read more

default fn write_i16<T>(&mut self, n: i16) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed 16 bit integer to the underlying writer. Read more

default fn write_u24<T>(&mut self, n: u32) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned 24 bit integer to the underlying writer. Read more

default fn write_i24<T>(&mut self, n: i32) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed 24 bit integer to the underlying writer. Read more

default fn write_u32<T>(&mut self, n: u32) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned 32 bit integer to the underlying writer. Read more

default fn write_i32<T>(&mut self, n: i32) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed 32 bit integer to the underlying writer. Read more

default fn write_u48<T>(&mut self, n: u64) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned 48 bit integer to the underlying writer. Read more

default fn write_i48<T>(&mut self, n: i64) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed 48 bit integer to the underlying writer. Read more

default fn write_u64<T>(&mut self, n: u64) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned 64 bit integer to the underlying writer. Read more

default fn write_i64<T>(&mut self, n: i64) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed 64 bit integer to the underlying writer. Read more

default fn write_u128<T>(&mut self, n: u128) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned 128 bit integer to the underlying writer.

default fn write_i128<T>(&mut self, n: i128) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed 128 bit integer to the underlying writer.

default fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned n-bytes integer to the underlying writer. Read more

default fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed n-bytes integer to the underlying writer. Read more

default fn write_uint128<T>(
    &mut self,
    n: u128,
    nbytes: usize
) -> Result<(), Error> where
    T: ByteOrder, 

Writes an unsigned n-bytes integer to the underlying writer. Read more

default fn write_int128<T>(
    &mut self,
    n: i128,
    nbytes: usize
) -> Result<(), Error> where
    T: ByteOrder, 

Writes a signed n-bytes integer to the underlying writer. Read more

default fn write_f32<T>(&mut self, n: f32) -> Result<(), Error> where
    T: ByteOrder, 

Writes a IEEE754 single-precision (4 bytes) floating point number to the underlying writer. Read more

default fn write_f64<T>(&mut self, n: f64) -> Result<(), Error> where
    T: ByteOrder, 

Writes a IEEE754 double-precision (8 bytes) floating point number to the underlying writer. Read more

impl<T> Erased for T

impl<T> SetParameter for T

default fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
    T: Parameter<Self>, 

Sets value as a parameter of self.

impl<W> WritePodExt for W where
    W: Write

impl<R> ReadPodExt for R where
    R: Read