Struct Stream

pub struct Stream(/* private fields */);

An object representing a Zircon stream.

As essentially a subtype of Handle, it can be freely interconverted.

Implementations

impl Stream

pub fn create( options: StreamOptions, vmo: &Vmo, offset: u64, ) -> Result<Self, Status>

See zx_stream_create

pub unsafe fn readv( &self, options: StreamReadOptions, iovecs: &mut [zx_iovec_t], ) -> Result<usize, Status>

Wraps the zx_stream_readv syscall.

Safety

The caller is responsible for ensuring that the buffers in iovecs point to valid (albeit not necessarily initialized) memory.

pub fn read_uninit( &self, options: StreamReadOptions, buffer: &mut [MaybeUninit<u8>], ) -> Result<usize, Status>

Attempts to read buffer.len() bytes from the stream starting at the stream’s current seek offset. Only the number of bytes read from the stream will be initialized in buffer. Returns the number of bytes read from the stream.

See zx_stream_readv.

pub fn read_to_vec( &self, options: StreamReadOptions, length: usize, ) -> Result<Vec<u8>, Status>

Attempts to read length bytes from the stream starting at the stream’s current seek offset. Returns the read bytes as a Vec.

See zx_stream_readv.

pub unsafe fn readv_at( &self, options: StreamReadOptions, offset: u64, iovecs: &mut [zx_iovec_t], ) -> Result<usize, Status>

Wraps the zx_stream_readv_at syscall.

Safety

The caller is responsible for ensuring that the buffers in iovecs point to valid (albeit not necessarily initialized) memory.

pub fn read_at_uninit( &self, options: StreamReadOptions, offset: u64, buffer: &mut [MaybeUninit<u8>], ) -> Result<usize, Status>

Attempts to read buffer.len() bytes from the stream starting at offset. Only the number of bytes read from the stream will be initialized in buffer. Returns the number of bytes read from the stream.

See zx_stream_readv_at.

pub fn read_at_to_vec( &self, options: StreamReadOptions, offset: u64, length: usize, ) -> Result<Vec<u8>, Status>

Attempts to read length bytes from the stream starting at offset. Returns the read bytes as a Vec.

See zx_stream_readv_at.

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

See zx_stream_seek

pub fn writev( &self, options: StreamWriteOptions, iovecs: &[zx_iovec_t], ) -> Result<usize, Status>

Wraps the zx_stream_writev syscall.

pub fn write( &self, options: StreamWriteOptions, buffer: &[u8], ) -> Result<usize, Status>

Writes buffer to the stream at the stream’s current seek offset. Returns the number of bytes written.

See zx_stream_writev.

pub fn writev_at( &self, options: StreamWriteOptions, offset: u64, iovecs: &[zx_iovec_t], ) -> Result<usize, Status>

Wraps the zx_stream_writev_at syscall.

pub fn write_at( &self, options: StreamWriteOptions, offset: u64, buffer: &[u8], ) -> Result<usize, Status>

Writes buffer to the stream at `offset``. Returns the number of bytes written.

See zx_stream_writev_at.

impl Stream

pub fn get_mode_append(&self) -> Result<u8, Status>

impl Stream

pub fn set_mode_append(&self, val: &u8) -> Result<(), Status>

Trait Implementations

impl AsHandleRef for Stream

fn as_handle_ref(&self) -> HandleRef<'_>

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> zx_handle_t

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

fn signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.

fn wait_handle( &self, signals: Signals, deadline: MonotonicInstant, ) -> Result<Signals, Status>

Waits on a handle. Wraps the zx_object_wait_one syscall.

fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. zx_object_wait_async syscall.

fn get_name(&self) -> Result<Name, Status>

Get the Property::NAME property for this object.

fn set_name(&self, name: &Name) -> Result<(), Status>

Set the Property::NAME property for this object.

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.

impl Debug for Stream

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

Formats the value using the given formatter.

impl From<Handle> for Stream

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<Stream> for Handle

fn from(x: Stream) -> Handle

Converts to this type from the input type.

impl HandleBased for Stream

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the zx_handle_replace syscall.

fn into_handle(self) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation.

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle.

fn into_handle_based<H: HandleBased>(self) -> H

Creates an instance of another handle-based type from this value’s inner handle.

fn from_handle_based<H: HandleBased>(h: H) -> Self

Creates an instance of this type from the inner handle of another handle-based type.

fn is_invalid_handle(&self) -> bool

impl Hash for Stream

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Stream

fn cmp(&self, other: &Stream) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Stream

fn eq(&self, other: &Stream) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Stream

fn partial_cmp(&self, other: &Stream) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Read for Stream

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>

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 Seek for Stream

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>

Seeks relative to the current position.

impl Write for Stream

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

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

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

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

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

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

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.

impl Eq for Stream

impl StructuralPartialEq for Stream