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

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<Stream, Status>

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>

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) -> Unowned<'_, Handle>

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

fn raw_handle(&self) -> u32

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: Time ) -> 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<CString, Status>

Get the [Property::NAME] property for this object. Read more
§

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

Set the [Property::NAME] property for this object. Read more
§

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<(), Error>

Formats the value using the given formatter. Read more
§

impl From<Handle> for Stream

§

fn from(handle: Handle) -> Stream

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. Read more
§

fn into_raw(self) -> u32

Converts the handle into it’s raw representation. Read more
§

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more
§

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

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

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

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>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl Ord for Stream

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for Stream

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method 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. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl Eq for Stream

§

impl StructuralPartialEq for Stream

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, const OBJECT_TYPE: u32, const RIGHTS: u32> Decode<HandleType<T, OBJECT_TYPE, RIGHTS>> for T
where T: 'static + HandleBased,

source§

fn new_empty() -> T

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.
source§

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, _depth: Depth ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self. Read more
source§

impl<T> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T, const OBJECT_TYPE: u32, const RIGHTS: u32> Encode<HandleType<T, OBJECT_TYPE, RIGHTS>> for T
where T: 'static + HandleBased,

source§

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more