Struct RWops

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

Available on crate feature dep_sdl2 only.

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

Implementations

impl<'a> RWops<'a>

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

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

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

where P: AsRef<Path>,

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,

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> ImageRWops for RWops<'a>

fn load(&self) -> Result<Surface<'static>, String>

load as a surface. except TGA

fn load_typed(&self, _type: &str) -> Result<Surface<'static>, String>

load as a surface. This can load all supported image formats.

fn load_cur(&self) -> Result<Surface<'static>, String>

fn load_ico(&self) -> Result<Surface<'static>, String>

fn load_bmp(&self) -> Result<Surface<'static>, String>

fn load_pnm(&self) -> Result<Surface<'static>, String>

fn load_xpm(&self) -> Result<Surface<'static>, String>

fn load_xcf(&self) -> Result<Surface<'static>, String>

fn load_pcx(&self) -> Result<Surface<'static>, String>

fn load_gif(&self) -> Result<Surface<'static>, String>

fn load_jpg(&self) -> Result<Surface<'static>, String>

fn load_tif(&self) -> Result<Surface<'static>, String>

fn load_png(&self) -> Result<Surface<'static>, String>

fn load_tga(&self) -> Result<Surface<'static>, String>

fn load_lbm(&self) -> Result<Surface<'static>, String>

fn load_xv(&self) -> Result<Surface<'static>, String>

fn load_webp(&self) -> Result<Surface<'static>, String>

fn is_cur(&self) -> bool

fn is_ico(&self) -> bool

fn is_bmp(&self) -> bool

fn is_pnm(&self) -> bool

fn is_xpm(&self) -> bool

fn is_xcf(&self) -> bool

fn is_pcx(&self) -> bool

fn is_gif(&self) -> bool

fn is_jpg(&self) -> bool

fn is_tif(&self) -> bool

fn is_png(&self) -> bool

fn is_lbm(&self) -> bool

fn is_xv(&self) -> bool

fn is_webp(&self) -> bool

impl<'a> LoaderRWops<'a> for RWops<'a>

fn load_wav(&self) -> Result<Chunk, String>

Load src for use as a sample.

fn load_music(&self) -> Result<Music<'a>, String>

Load src for use as music.

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

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

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>

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

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

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

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

Reads 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)

Reads 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<'a> Seek for RWops<'a>

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

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>

Seeks relative to the current position.

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

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

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

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

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