Struct olin::Resource

pub struct Resource(_);

Resources are maybe readable, maybe writable, maybe flushable and closable streams of bytes. A resource is backed by implementation in the containing runtime based on the URL scheme used in the open call.

Resources do not always have to be backed by things that exist. Resources may contain the transient results of API calls. Once the data in a Resource has been read, that may be the only time that data can ever be read.

Please take this into consideration when consuming the results of Resources.

The implementation of this type uses the functions at https://github.com/CommonWA/cwa-spec/blob/master/ns/resource.md

Implementations

impl Resource

pub fn open(url: &str) -> Result<Resource, Error>

pub unsafe fn from_raw(handle: i32) -> Resourceⓘ

Important traits for Resource

impl Read for Resourceimpl Write for Resource

For the few times you actually do know the file descriptor.

The CommonWA spec doesn't mandate any properties about file descriptors. The implementation in Olin uses random file descriptors, meaning that unless the stdio module is used, this function should probably never be called unless you really know what you are doing.

Passing an invalid file descriptor to this function will result in a handle that returns errors on every call to it. This behavior may be useful.

Trait Implementations

impl Debug for Resource

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

Formats the value using the given formatter.

impl Drop for Resource

fn drop(&mut self)

Executes the destructor for this type.

impl Read for Resource

fn read(&mut self, out: &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.

unsafe fn initializer(&self) -> Initializer

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

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

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 by_ref(&mut self) -> &mut Self

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

fn bytes(self) -> Bytes<Self>

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

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for Resource

fn write(&mut self, data: &[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 Writeer 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

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