pub struct RWops<'a> { /* private fields */ }
Expand description
A structure that provides an abstract interface to stream I/O.
Implementations
sourceimpl<'a> RWops<'a>
impl<'a> RWops<'a>
pub unsafe fn raw(&self) -> *mut SDL_RWops
pub unsafe fn from_ll<'b>(raw: *mut SDL_RWops) -> RWops<'b> ⓘ
sourcepub fn from_file<P: AsRef<Path>>(
path: P,
mode: &str
) -> Result<RWops<'static>, String>
pub fn from_file<P: AsRef<Path>>(
path: P,
mode: &str
) -> Result<RWops<'static>, String>
Creates an SDL file stream.
sourcepub fn from_bytes(buf: &'a [u8]) -> Result<RWops<'a>, String>
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.
sourcepub fn from_read<T>(
r: &mut T,
buffer: &'a mut Vec<u8>
) -> Result<RWops<'a>, String>where
T: Read + Sized,
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.
sourcepub fn from_bytes_mut(buf: &'a mut [u8]) -> Result<RWops<'a>, String>
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.
sourcepub fn len(&self) -> Option<usize>
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
sourceimpl<'a> Read for RWops<'a>
impl<'a> Read for RWops<'a>
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
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. Read more
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
Read all bytes until EOF in this source, placing them into
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
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. Read more
sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
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
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moresourceimpl<'a> Seek for RWops<'a>
impl<'a> Seek for RWops<'a>
sourcefn seek(&mut self, pos: SeekFrom) -> Result<u64>
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
Seek to an offset, in bytes, in a stream. Read more
1.55.0 · sourcefn rewind(&mut self) -> Result<(), Error>
fn rewind(&mut self) -> Result<(), Error>
Rewind to the beginning of a stream. Read more
sourceimpl<'a> Write for RWops<'a>
impl<'a> Write for RWops<'a>
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
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. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for RWops<'a>
impl<'a> !Send for RWops<'a>
impl<'a> !Sync for RWops<'a>
impl<'a> Unpin for RWops<'a>
impl<'a> UnwindSafe for RWops<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more