Struct sdl2::rwops::RWops

pub struct RWops<'a> { /* fields omitted */ }

A structure that provides an abstract interface to stream I/O.

Methods

impl<'a> RWops<'a>

pub unsafe fn raw(&self) -> *mut SDL_RWops

Important traits for RWops<'a>

impl<'a> Read for RWops<'a>impl<'a> Write for RWops<'a>

pub unsafe fn from_ll<'b>(raw: *mut SDL_RWops) -> RWops<'b>

pub fn from_file<P: AsRef<Path>>(
    path: P,
    mode: &str
) -> Result<RWops<'static>, String>

Creates an SDL file stream.

pub fn from_bytes(buf: &'a [u8]) -> Result<RWops<'a>, String>

Prepares a read-only memory buffer for use with RWops.

This method can only fail if the buffer size is zero.

pub fn from_read<T>(
    r: &mut T,
    buffer: &'a mut Vec<u8>
) -> Result<RWops<'a>, String> where
    T: Read + Sized, 

Reads a Read object into a buffer and then passes it to RWops.from_bytes.

The buffer must be provided to this function and must live as long as the RWops, but the RWops does not take ownership of it.

pub fn from_bytes_mut(buf: &'a mut [u8]) -> Result<RWops<'a>, String>

Prepares a read-write memory buffer for use with RWops.

This method can only fail if the buffer size is zero.

pub fn len(&self) -> Option<usize>

Gets the stream's total size in bytes.

Returns None if the stream size can't be determined (either because it doesn't make sense for the stream type, or there was an error).

pub fn is_empty(&self) -> bool

Trait Implementations

impl<'a> Drop for RWops<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Read for RWops<'a>

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.

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

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

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

unsafe default fn initializer(&self) -> Initializer

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

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

default 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.

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

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

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

Read the exact number of bytes required to fill buf.

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

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

default fn bytes(self) -> Bytes<Self>

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

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a> Seek for RWops<'a>

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

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

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

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

Returns the length of this stream (in bytes).

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

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

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

impl<'a> Write for RWops<'a>

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.

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

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

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

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

Attempts to write an entire buffer into this writer.

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

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

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

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