Struct NewClientParams

pub struct NewClientParams {
    pub interface_id: Option<u64>,
    pub address: Option<Ipv6SocketAddress>,
    pub config: Option<ClientConfig>,
    pub duid: Option<Duid>,
    /* private fields */
}

Parameters to start a new DHCPv6 client with.

Fields

interface_id: Option<u64>

The ID of the interface the client will run on.

Required.

address: Option<Ipv6SocketAddress>

The socket address to use when communicating with servers.

DHCPv6 servers listen for link-local multicasts, so not using a link-local address here may cause interoperability issues.

Client creation will fail with INVALID_ARGS if:

• a multicast address is provided;
• or a link-local address is provided, and its zone index doesn’t match interface_id (Fuchsia has a 1:1 mapping from zone index to interface ID).

Client creation will fail if it fails to bind a socket to this address.

Required.

config: Option<ClientConfig>

Configuration for starting the DHCPv6 client.

If the configuration requests both addresses and other configuration parameters, all information is requested in the same message exchange, running in stateful mode. If only configuration parameters are requested (no addresses or prefixes), the client runs in stateless mode, as described in RFC 8415, Section 6.1.

Client creation will fail if config is not requesting any information (all fields are empty), or if it contains invalid fields.

Required.

duid: Option<Duid>

DHCP Unique Identifier (DUID) configuration.

The DUID is used by the client to identify itself to servers as defined in RFC 8415, section 11. The field must be present if and only if the client is started in stateful mode, otherwise client creation will fail and the pipelined channel will be closed.

Trait Implementations

impl Clone for NewClientParams

fn clone(&self) -> NewClientParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NewClientParams

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<NewClientParams, D> for NewClientParams

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<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

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

impl Default for NewClientParams

fn default() -> NewClientParams

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<NewClientParams, D> for &NewClientParams

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

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

type Owned = NewClientParams

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 ValueTypeMarker for NewClientParams

type Borrowed<'a> = &'a NewClientParams

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

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for NewClientParams

impl StructuralPartialEq for NewClientParams