Struct rich_sdl2_rust::file::RwOps

pub struct RwOps<'a> { /* private fields */ }

A file handler, how to read and write from file on SDL2.

Implementations

impl<'a> RwOps<'a>

pub unsafe fn ptr(&self) -> NonNull<SDL_RWops>

Returns the raw pointer of the file handler.

Safety

Dereferencing the pointer and using the field is not recommended. Please use carefully.

pub fn from_file(file_name: &str, mode: OpenMode) -> Result<RwOps<'static>>

Constructs from file name with the open mode.

Panics

Panics if file_name was empty.

Errors

Returns Err if failed to open the file with mode.

pub fn from_mem(buf: &'a [u8]) -> Result<Self>

Constructs from the buffer &[u8].

Errors

Returns Err if failed to make it a read-only memory buffer.

pub fn from_mem_mut(buf: &'a mut [u8]) -> Result<Self>

Constructs from the mutable buffer &mut [u8].

Errors

Returns Err if failed to make it a read-write memory buffer.

pub fn size(&self) -> Result<usize>

Returns the size of the read/write target.

Errors

Returns Err if failed to get the size of buffer.

pub fn tell(&mut self) -> Result<u64>

Returns the current position of seeking.

Errors

Returns Err if failed to seek to get the current position.

pub fn read_u8(&mut self) -> u8

Reads and pops the 8-bits value.

pub fn read_be16(&mut self) -> u16

Reads and pops the big endian 16-bits value.

pub fn read_le16(&mut self) -> u16

Reads and pops the little endian 16-bits value.

pub fn read_be32(&mut self) -> u32

Reads and pops the big endian 32-bits value.

pub fn read_le32(&mut self) -> u32

Reads and pops the little endian 32-bits value.

pub fn read_be64(&mut self) -> u64

Reads and pops the big endian 64-bits value.

pub fn read_le64(&mut self) -> u64

Reads and pops the little endian 64-bits value.

pub fn write_u8(&mut self, value: u8) -> bool

Writes the 8-bits value.

pub fn write_be16(&mut self, value: u16) -> bool

Writes the big endian 16-bits value.

pub fn write_le16(&mut self, value: u16) -> bool

Writes the little endian 16-bits value.

pub fn write_be32(&mut self, value: u32) -> bool

Writes the big endian 32-bits value.

pub fn write_le32(&mut self, value: u32) -> bool

Writes the little endian 32-bits value.

pub fn write_be64(&mut self, value: u64) -> bool

Writes the big endian 64-bits value.

pub fn write_le64(&mut self, value: u64) -> bool

Writes the little endian 64-bits value.

Trait Implementations

impl Debug for RwOps<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for RwOps<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Read for RwOps<'_>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

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

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

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

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Seek for RwOps<'_>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

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

Seeks relative to the current position.

impl Write for RwOps<'_>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.