Struct fidl::handle::fuchsia_handles::Socket

source ·
pub struct Socket(/* private fields */);
Expand description

An object representing a Zircon socket

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

Implementations§

source§

impl Socket

source

pub fn create_stream() -> (Socket, Socket)

Create a streaming socket, accessed through a pair of endpoints. Data written into one may be read from the other.

Wraps zx_socket_create.

§Panics

If the process’ job policy denies socket creation or the kernel reports no memory available to create a new socket.

source

pub fn create_datagram() -> (Socket, Socket)

Create a datagram socket, accessed through a pair of endpoints. Data written into one may be read from the other.

Wraps zx_socket_create.

§Panics

If the process’ job policy denies socket creation or the kernel reports no memory available to create a new socket.

source

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

Write the given bytes into the socket.

Return value (on success) is number of bytes actually written.

Wraps zx_socket_write.

source

pub unsafe fn write_raw( &self, bytes: *const u8, len: usize, ) -> Result<usize, Status>

Write the given bytes into the socket.

Return value (on success) is number of bytes actually written.

§Safety

bytes must be valid to read from for len bytes.

Wraps zx_socket_write.

source

pub fn write_opts( &self, bytes: &[u8], opts: SocketWriteOpts, ) -> Result<usize, Status>

Write the given bytes into the socket, with options.

Return value (on success) is number of bytes actually written.

Wraps zx_socket_write.

source

pub unsafe fn write_raw_opts( &self, bytes: *const u8, len: usize, opts: SocketWriteOpts, ) -> Result<usize, Status>

Write the given bytes into the socket, with options.

Return value (on success) is number of bytes actually written.

§Safety

bytes must be valid to read from for len bytes.

Wraps zx_socket_write.

source

pub fn read(&self, bytes: &mut [u8]) -> Result<usize, Status>

Read the given bytes from the socket. Return value (on success) is number of bytes actually read.

Wraps zx_socket_read.

source

pub fn read_opts( &self, bytes: &mut [u8], opts: SocketReadOpts, ) -> Result<usize, Status>

Read the given bytes from the socket, with options. Return value (on success) is number of bytes actually read.

Wraps zx_socket_read.

source

pub unsafe fn read_raw( &self, bytes: *mut u8, len: usize, ) -> Result<usize, Status>

Read the given bytes from the socket.

Return value (on success) is number of bytes actually read.

§Safety

bytes must be valid to write to for len bytes.

Wraps zx_socket_read.

source

pub unsafe fn read_raw_opts( &self, bytes: *mut u8, len: usize, opts: SocketReadOpts, ) -> Result<usize, Status>

Read the given bytes from the socket, with options.

Return value (on success) is number of bytes actually read.

§Safety

bytes must be valid to write to for len bytes.

Wraps zx_socket_read.

source

pub fn read_uninit<'a>( &self, bytes: &'a mut [MaybeUninit<u8>], ) -> Result<&'a mut [u8], Status>

Like Socket::read_uninit_opts with default options.

source

pub fn read_uninit_opts<'a>( &self, bytes: &'a mut [MaybeUninit<u8>], opts: SocketReadOpts, ) -> Result<&'a mut [u8], Status>

Same as Socket::read_opts, but reads into memory that might not be initialized, returning an initialized slice of bytes on success.

source

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

Close half of the socket, so attempts by the other side to write will fail.

Implements the ZX_SOCKET_DISPOSITION_WRITE_DISABLED option of zx_socket_set_disposition.

source

pub fn set_disposition( &self, disposition: Option<SocketWriteDisposition>, disposition_peer: Option<SocketWriteDisposition>, ) -> Result<(), Status>

Sets the disposition of write calls for a socket handle and its peer.

Wraps zx_socket_set_disposition.

source

pub fn outstanding_read_bytes(&self) -> Result<usize, Status>

Returns the number of bytes available on the socket.

source

pub fn info(&self) -> Result<SocketInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_SOCKET topic.

source§

impl Socket

source§

impl Socket

source

pub fn set_rx_threshold(&self, val: &usize) -> Result<(), Status>

source§

impl Socket

source§

impl Socket

source

pub fn set_tx_threshold(&self, val: &usize) -> Result<(), Status>

Trait Implementations§

source§

impl AsHandleRef for Socket

source§

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.
source§

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).
source§

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.
source§

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

Waits on a handle. Wraps the zx_object_wait_one syscall.
source§

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.
source§

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

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

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

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

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.
source§

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.
source§

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.
source§

impl Debug for Socket

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Handle> for Socket

source§

fn from(handle: Handle) -> Socket

Converts to this type from the input type.
source§

impl From<Socket> for Handle

source§

fn from(x: Socket) -> Handle

Converts to this type from the input type.
source§

impl HandleBased for Socket

source§

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

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

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.
source§

fn into_handle(self) -> Handle

Converts the value into its inner handle. Read more
source§

fn into_raw(self) -> u32

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

fn from_handle(handle: Handle) -> Self

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

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

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

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.
source§

fn is_invalid_handle(&self) -> bool

source§

impl Hash for Socket

source§

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
source§

impl Ord for Socket

source§

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

impl PartialEq for Socket

source§

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

impl PartialOrd for Socket

source§

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

impl Peered for Socket

source§

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

Set and clear userspace-accessible signal bits on the object’s peer. Wraps the zx_object_signal_peer syscall.
source§

fn is_closed(&self) -> Result<bool, Status>

Returns true if the handle has received the PEER_CLOSED signal. Read more
source§

impl Eq for Socket

source§

impl StructuralPartialEq for Socket

Auto Trait Implementations§

§

impl Freeze for Socket

§

impl RefUnwindSafe for Socket

§

impl Send for Socket

§

impl Sync for Socket

§

impl Unpin for Socket

§

impl UnwindSafe for Socket

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> EncodableAsHandle for T
where T: HandleBased,

§

type Dialect = DefaultFuchsiaResourceDialect

What resource dialect can encode this object as a handle.
source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _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, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _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