Struct zircon_object::vm::Stream

pub struct Stream { /* fields omitted */ }

A readable, writable, seekable interface to some underlying storage

SYNOPSIS

A stream is an interface for reading and writing data to some underlying storage, typically a VMO.

Implementations

impl Stream

pub fn create(vmo: Arc<VmObject>, seek: usize, options: u32) -> Arc<Self>

Create a stream from a VMO

pub fn read(&self, data: &mut [u8]) -> ZxResult<usize>

Read data from the stream at the current seek offset

pub fn read_at(&self, data: &mut [u8], offset: usize) -> ZxResult<usize>

Read data from the stream at a given offset

pub fn write(&self, data: &[u8], append: bool) -> ZxResult<usize>

write data to the stream at the current seek offset or append data at the end of content

pub fn write_at(&self, data: &[u8], offset: usize) -> ZxResult<usize>

Write data to the stream at a given offset

pub fn seek(&self, whence: SeekOrigin, offset: isize) -> ZxResult<usize>

Modify the current seek offset of the stream

pub fn get_info(&self) -> StreamInfo

Get information of the socket.

Trait Implementations

impl Debug for Stream

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

Formats the value using the given formatter.

impl KernelObject for Stream

fn id(&self) -> KoID

Get object’s KoID.

fn type_name(&self) -> &str

Get the name of the type of the kernel object.

fn name(&self) -> String

Get object’s name.

fn set_name(&self, name: &str)

Set object’s name.

fn signal(&self) -> Signal

Get the signal status.

fn signal_set(&self, signal: Signal)

Assert signal.

fn signal_clear(&self, signal: Signal)

Deassert signal.

fn signal_change(&self, clear: Signal, set: Signal)

Change signal status: first clear then set indicated bits.

fn add_signal_callback(&self, callback: SignalHandler)

Add callback for signal status changes.

fn get_child(&self, _id: KoID) -> ZxResult<Arc<dyn KernelObject>>

Attempt to find a child of the object with given KoID.

fn peer(&self) -> ZxResult<Arc<dyn KernelObject>>

Attempt to get the object’s peer.

fn related_koid(&self) -> KoID

If the object is related to another (such as the other end of a channel, or the parent of a job), returns the KoID of that object, otherwise returns zero.

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.