Struct fuchsia_async::Socket

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

An I/O object representing a Socket.

Implementations

impl Socket

pub fn from_socket(socket: Socket) -> Self

Create a new Socket from a previously-created zx::Socket.

Panics

If called outside the context of an active async executor.

pub fn into_zx_socket(self) -> Socket

Consumes self and returns the underlying zx::Socket.

pub fn is_closed(&self) -> bool

Returns true if the socket received the OBJECT_PEER_CLOSED signal.

pub fn on_closed(&self) -> OnSignalsRef<'_>

Returns a future that completes when the socket received the OBJECT_PEER_CLOSED signal.

pub fn poll_read_ref( &self, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Status>>

Attempt to read from the socket, registering for wakeup if the socket doesn’t have any contents available. Used internally in the AsyncRead implementation, exposed for users who know the concrete type they’re using and don’t want to pin the socket.

pub fn poll_write_ref( &self, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Status>>

Attempt to write into the socket, registering for wakeup if the socket is not ready. Used internally in the AsyncWrite implementation, exposed for users who know the concrete type they’re using and don’t want to pin the socket.

pub fn poll_datagram( &self, cx: &mut Context<'_>, out: &mut Vec<u8>, ) -> Poll<Result<usize, Status>>

Polls for the next data on the socket, appending it to the end of |out| if it has arrived. Not very useful for a non-datagram socket as it will return all available data on the socket.

pub async fn read_datagram<'a>( &'a self, out: &'a mut Vec<u8>, ) -> Result<usize, Status>

Reads the next datagram that becomes available onto the end of |out|. Note: Using this multiple times concurrently is an error and the first one will never complete.

pub fn as_datagram_stream<'a>(&'a self) -> DatagramStream<&'a Self>

Use this socket as a stream of Result<Vec<u8>, zx::Status> datagrams.

Note: multiple concurrent streams from the same socket are not supported.

pub fn into_datagram_stream(self) -> DatagramStream<Self>

Convert this socket into a stream of Result<Vec<u8>, zx::Status> datagrams.

Trait Implementations

impl AsHandleRef for Socket

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) -> 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: Instant<MonotonicTimeline>, ) -> 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 AsRef<Socket> for Socket

fn as_ref(&self) -> &Socket

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> AsyncRead for &'a Socket

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncRead for Socket

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'a> AsyncWrite for &'a Socket

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl AsyncWrite for Socket

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for Socket

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

Formats the value using the given formatter.

impl ReadableHandle for Socket

fn poll_readable( &self, cx: &mut Context<'_>, ) -> Poll<Result<ReadableState, Status>>

If the object is ready for reading, returns Ready with the readable state. If the implementor returns Pending, it should first ensure that need_readable is called.

fn need_readable(&self, cx: &mut Context<'_>) -> Poll<Result<(), Status>>

Arranges for the current task to be woken when the object receives an OBJECT_READABLE or OBJECT_PEER_CLOSED signal. This can return Poll::Ready if the object has already been signaled in which case the waker will not be woken and it is the caller’s responsibility to not lose the signal.

impl WritableHandle for Socket

fn poll_writable( &self, cx: &mut Context<'_>, ) -> Poll<Result<WritableState, Status>>

If the object is ready for writing, returns Ready with the writable state. If the implementor returns Pending, it should first ensure that need_writable is called.

fn need_writable(&self, cx: &mut Context<'_>) -> Poll<Result<(), Status>>

Arranges for the current task to be woken when the object receives an OBJECT_WRITABLE or OBJECT_PEER_CLOSED signal. This can return Poll::Ready if the object has already been signaled in which case the waker will not be woken and it is the caller’s responsibility to not lose the signal.