Struct Socket

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

A socket in a remote FDomain.

Implementations

impl Socket

pub fn read<'a>( &self, buf: &'a mut [u8], ) -> impl Future<Output = Result<usize, Error>> + 'a

Read up to the given buffer’s length from the socket.

pub fn write_all(&self, bytes: &[u8]) -> impl Future<Output = Result<(), Error>>

Write all of the given data to the socket.

pub fn set_socket_disposition( &self, disposition: Option<SocketDisposition>, disposition_peer: Option<SocketDisposition>, ) -> impl Future<Output = Result<(), Error>>

Set the disposition of this socket and/or its peer.

pub fn stream(self) -> Result<(SocketReadStream, SocketWriter), Error>

Split this socket into a streaming reader and a writer. This is more efficient on the read side if you intend to consume all of the data from the socket. However it will prevent you from transferring the handle in the future. It also means data will build up in the buffer, so it may lead to memory issues if you don’t intend to use the data from the socket as fast as it comes.

Trait Implementations

impl AsHandleRef for Socket

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

fn object_type() -> ObjectType

fn signal_handle( &self, set: Signals, clear: Signals, ) -> impl Future<Output = Result<(), Error>>

fn domain(&self) -> Arc<Client>

Get the client supporting this handle. See fidl::Proxy::domain.

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 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>, _cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, _cx: &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 EncodableAsHandle for Socket

type Dialect = FDomainResourceDialect

What resource dialect can encode this object as a handle.

impl From<Handle> for Socket

fn from(other: Handle) -> Socket

Converts to this type from the input type.

impl From<Socket> for Handle

fn from(other: Socket) -> Handle

Converts to this type from the input type.

impl HandleBased for Socket

fn close(self) -> impl Future<Output = Result<(), Error>>

Closes this handle. Surfaces errors that dropping the handle will not.

fn duplicate_handle( &self, rights: Rights, ) -> impl Future<Output = Result<Self, Error>>

Duplicate this handle.

fn replace_handle( self, rights: Rights, ) -> impl Future<Output = Result<Self, Error>>

Replace this handle with an equivalent one with different rights.

fn into_handle(self) -> Handle

Convert this handle-based value into a pure Handle.

fn from_handle(handle: Handle) -> Self

Construct a new handle-based value from a Handle.

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

Turn this handle-based value into one of a different type.

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

Turn another handle-based type into this one.

impl Hash for Socket

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 Socket

fn cmp(&self, other: &Socket) -> 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 Socket

fn eq(&self, other: &Socket) -> 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 Socket

fn partial_cmp(&self, other: &Socket) -> 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 Peered for Socket

fn signal_peer( &self, set: Signals, clear: Signals, ) -> impl Future<Output = Result<(), Error>>

Assert and deassert signals on this handle’s peer.

impl Eq for Socket

impl StructuralPartialEq for Socket