Struct SocketCreationOptions

pub struct SocketCreationOptions {
    pub marks: Option<Marks>,
    pub group: Option<WakeGroupToken>,
    /* private fields */
}

Options that can be provided at socket creation.

Fields

marks: Option<Marks>

The marks for the created socket. If a mark is missing from the table, it will remain unset for the created socket.

group: Option<WakeGroupToken>

A wake group to add the socket to on creation.

If absent, the socket is not added to any wake group. If the token provided does not correspond to an existing wake group, socket creation fails with fuchsia.posix/Errno.EINVAL.

Trait Implementations

impl Debug for SocketCreationOptions

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

Formats the value using the given formatter.

impl Decode<SocketCreationOptions, DefaultFuchsiaResourceDialect> for SocketCreationOptions

fn new_empty() -> Self

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

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

Decodes an object of type T from the decoder’s buffers into self.

impl Default for SocketCreationOptions

fn default() -> SocketCreationOptions

Returns the “default value” for a type.

impl Encode<SocketCreationOptions, DefaultFuchsiaResourceDialect> for &mut SocketCreationOptions

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

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

impl PartialEq for SocketCreationOptions

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

type Borrowed<'a> = &'a mut SocketCreationOptions

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned, ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for SocketCreationOptions

type Owned = SocketCreationOptions

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl Standalone<DefaultFuchsiaResourceDialect> for SocketCreationOptions

impl StructuralPartialEq for SocketCreationOptions