Struct fidl_fuchsia_net_interfaces_admin::ControlProxy

pub struct ControlProxy { /* private fields */ }

Implementations

impl ControlProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.net.interfaces.admin/Control.

pub fn take_event_stream(&self) -> ControlEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn add_address( &self, address: &Subnet, parameters: &AddressParameters, address_state_provider: ServerEnd<AddressStateProviderMarker> ) -> Result<(), Error>

Assigns an address to the interface.

Errors are communicated via [fuchsia.net.interfaces.admin/AddressStateProvider.OnAddressRemoved].

• request address the address to assign to the interface.
• request parameters additional address-specific options.
• request address_state_provider provides address assignment state and enables updating address properties.

pub fn remove_address( &self, address: &Subnet ) -> QueryResponseFut<ControlRemoveAddressResult>

Removes an address from the interface.

• request address the address to remove.

• response did_remove true iff address was removed from the interface as a consequence of this call.

pub fn get_id(&self) -> QueryResponseFut<u64>

Gets the interface identifier.

• response id the interface identifier.

pub fn set_configuration( &self, config: &Configuration ) -> QueryResponseFut<ControlSetConfigurationResult>

Sets the configuration for the interface.

Only set fields that are supported in the provided Configuration will be set; unset fields will be left unmodified. The server will return a Configuration which holds the previous configuration for fields that the interface supports and set, even if the call did not update the configuration’s value.

• request config the configuration fields to update on the interface.

• response previous_config a snapshot of the interface’s previous configuration. Only supported fields present in config will be set.

pub fn get_configuration( &self ) -> QueryResponseFut<ControlGetConfigurationResult>

Gets a snapshot of the interface’s configuration.

The server will populate the returned Configuration with the configuration for features/protocols that the interface supports. That is, fields for unsupported configurations will be unset in the returned Configuration.

• response config a snapshot of the interface’s configuration.

pub fn enable(&self) -> QueryResponseFut<ControlEnableResult>

Enables the interface.

• response did_enable true iff the interface moved from disabled to enabled as a consequence of this call.

pub fn disable(&self) -> QueryResponseFut<ControlDisableResult>

Disables the interface.

• response did_disable true iff the interface moved from enabled to disabled as a consequence of this call.

pub fn detach(&self) -> Result<(), Error>

Detaches the client end from the interface’s lifetime.

After calling Detach, closing this client end no longer causes the interface to be removed.

pub fn get_authorization_for_interface( &self ) -> QueryResponseFut<GrantForInterfaceAuthorization>

Get an authentication credential for this interface.

The credential contains a [zx::handle::EVENT], whose entangled partner is held by the server. This credential can be converted into a ProofOfInterfaceAuthorization and then passed into fuchsia.net.* API calls to prove ownership of this interface. The EVENT is stable throughout the lifetime of the interface. Clients may duplicate this EVENT to make multiple API calls, or transfer the EVENT to other clients.

• response credential the authorization credential for this interface.

pub fn remove(&self) -> QueryResponseFut<ControlRemoveResult>

Initiates interface removal.

This method returns success once interface removal has started. When the interface is removed, a USER removed reason is issued in [OnInterfaceRemoved] and the server end is closed.

Trait Implementations

impl Clone for ControlProxy

fn clone(&self) -> ControlProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ControlProxyInterface for ControlProxy

fn add_address( &self, address: &Subnet, parameters: &AddressParameters, address_state_provider: ServerEnd<AddressStateProviderMarker> ) -> Result<(), Error>

type RemoveAddressResponseFut = QueryResponseFut<Result<bool, ControlRemoveAddressError>>

fn remove_address(&self, address: &Subnet) -> Self::RemoveAddressResponseFut

type GetIdResponseFut = QueryResponseFut<u64>

fn get_id(&self) -> Self::GetIdResponseFut

type SetConfigurationResponseFut = QueryResponseFut<Result<Configuration, ControlSetConfigurationError>>

fn set_configuration( &self, config: &Configuration ) -> Self::SetConfigurationResponseFut

type GetConfigurationResponseFut = QueryResponseFut<Result<Configuration, ControlGetConfigurationError>>

fn get_configuration(&self) -> Self::GetConfigurationResponseFut

type EnableResponseFut = QueryResponseFut<Result<bool, ControlEnableError>>

fn enable(&self) -> Self::EnableResponseFut

type DisableResponseFut = QueryResponseFut<Result<bool, ControlDisableError>>

fn disable(&self) -> Self::DisableResponseFut

fn detach(&self) -> Result<(), Error>

type GetAuthorizationForInterfaceResponseFut = QueryResponseFut<GrantForInterfaceAuthorization>

fn get_authorization_for_interface( &self ) -> Self::GetAuthorizationForInterfaceResponseFut

type RemoveResponseFut = QueryResponseFut<Result<(), ControlRemoveError>>

fn remove(&self) -> Self::RemoveResponseFut

impl Debug for ControlProxy

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

Formats the value using the given formatter.

impl Proxy for ControlProxy

type Protocol = ControlMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.