Struct Box

pub struct Box<T: Boxable>(/* private fields */);

A box for owning pointers to opaque types vended from the OpenThread API.

May be abbreviated as an OtBox to avoid confusion with std::boxed::Box.

Internally, an ot::Box contains the raw pointer to the underlying OpenThread object. Externally, the box appears to contain an instance of a type implementing ot::Boxable. References to the ot::Boxable type are created from the underlying pointer as needed.

When an ot::Box goes out of scope, the underlying object is finalized according to the OpenThread API for that type, via ot::Boxable::finalize.

The underlying pointer may be taken from the box without finalization by calling ot::Box::take_ot_ptr, which consumes the ot::Box and returns the pointer.

Safety

In general, the safety of this entire approach is dependent on the following assumptions on the language itself:

1. Casting from pointers to references: Transmuting a *mut Self::OtType to a &Self is not itself undefined behavior assuming the pointer pointed to a valid object.
2. Casting from references to pointers: Transmuting a &Self that was previously created by assumption 1 back into a *mut Self::OtType will always yield the original pointer value.
3. Behavior of Static Dispatch: Traits implemented on Self and called via static dispatch will have &self references that obey assumption #2.
4. No Spooky Stuff: No weird pointer/reference manipulation happens behind the scenes, like the spooky stuff C++ does.

Implementations

impl<T: Boxable> Box<T>

pub unsafe fn from_ot_ptr(ptr: *mut T::OtType) -> Option<Self>

Takes ownership of an OpenThread object by wrapping it in an OtBox instance. Unless subsequently removed by a call to [take_ot_ptr()], the pointed-to object will be finalized when the box goes out of scope.

Safety

This method is unsafe because it is effectively a deferred call to Boxable::ref_from_ot_ptr, which is also unsafe. When calling, care must be taken to ensure the following is true:

1. The given pointer points to a valid instance of T::OtType.
2. The caller has logical ownership of the object being pointed to.

pub fn take_ot_ptr(self) -> *mut T::OtType

Releases ownership of the contained OpenThread object, returning it’s pointer.

Trait Implementations

impl<T: Boxable> AsMut<T> for Box<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: Boxable> AsRef<T> for Box<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: BackboneRouter + Boxable> BackboneRouter for Box<T>

fn set_backbone_router_enabled(&self, enable: bool)

Functional equilvanet of otsys::otBackboneRouterSetEnabled.

fn multicast_listener_add(&self, addr: &Ip6Address, timeout: u32) -> Result

Functional equivalent of otsys::otBackboneRouterMulticastListenerAdd.

fn multicast_listener_clear(&self)

Functional equivalent of otsys::otBackboneRouterMulticastListenerClear.

fn multicast_listener_get_next( &self, listener_iter: &mut otBackboneRouterMulticastListenerIterator, ) -> Option<BackboneRouterMulticastListenerInfo>

Functional equivalent of otsys::otBackboneRouterMulticastListenerGetNext.

fn config_next_multicast_listener_registration_response(&self, status: u8)

Functional equivalent of otsys::otBackboneRouterConfigNextMulticastListenerRegistrationResponse.

fn set_multicast_listener_callback<'a, F>(&'a self, f: Option<F>)

where F: FnMut(BackboneRouterMulticastListenerEvent, &Ip6Address) + 'a,

Functional equivalent of otsys::otBackboneRouterSetMulticastListenerCallback.

fn iter_multicaster_listeners(&self) -> MulticastListenerIterator<'_, Self>

Returns an iterator for iterating over multicast listeners.

impl<T: BorderAgent + Boxable> BorderAgent for Box<T>

fn border_agent_get_state(&self) -> BorderAgentState

Functional equivalent of otsys::otBorderAgentGetState.

fn border_agent_get_udp_port(&self) -> u16

Functional equivalent of otsys::otBorderAgentUdpPort.

impl<T: BorderRouter + Boxable> BorderRouter for Box<T>

fn add_external_route(&self, route: &ExternalRouteConfig) -> Result

Functional equivalent of otsys::otBorderRouterAddRoute.

fn add_on_mesh_prefix(&self, route: &BorderRouterConfig) -> Result

Functional equivalent of otsys::otBorderRouterAddOnMeshPrefix.

fn remove_external_route(&self, prefix: &Ip6Prefix) -> Result

Functional equivalent of otsys::otBorderRouterRemoveRoute.

fn remove_on_mesh_prefix(&self, prefix: &Ip6Prefix) -> Result

Functional equivalent of otsys::otBorderRouterRemoveOnMeshPrefix.

fn border_router_register(&self) -> Result

Functional equivalent of otsys::otBorderRouterRegister.

fn border_routing_init(&self, infra_if: u32, infra_is_running: bool) -> Result

Functional equivalent of otsys::otBorderRoutingInit.

fn border_routing_set_enabled(&self, enabled: bool) -> Result

Functional equivalent of otsys::otBorderRoutingSetEnabled.

fn border_routing_dhcp6_pd_set_enabled(&self, enabled: bool)

Functional equivalent of otsys::otBorderRoutingDhcp6PdSetEnabled.

fn border_routing_dhcp6_pd_get_state(&self) -> BorderRoutingDhcp6PdState

Functional equivalent of otsys::otBorderRoutingDhcp6PdGetState.

fn border_routing_dhcp6_pd_set_request_fn<'a, F>(&'a self, f: Option<F>)

where F: FnMut(BorderRoutingDhcp6PdState) + 'a,

Functional equivalent of otsys::otBorderRoutingDhcp6PdSetRequestCallback.

fn border_routing_dhcp6_pd_state_change_stream( &self, ) -> BorderRoutingDhcp6PdStateChangedStream

Get the DHCPv6 PD state change stream

fn border_routing_get_pd_omr_prefix( &self, ) -> Result<BorderRoutingPrefixTableEntry>

Functional equivalent of otsys::otBorderRoutingGetPdOmrPrefix.

fn border_routing_get_omr_prefix(&self) -> Result<Ip6Prefix>

Functional equivalent of otsys::otBorderRoutingGetOmrPrefix.

fn border_routing_get_on_link_prefix(&self) -> Result<Ip6Prefix>

Functional equivalent of otsys::otBorderRoutingGetOnLinkPrefix.

fn border_routing_process_icmp6_ra( &self, message: &[u8], ) -> Result<(), WrongSize>

Functional equivalent of otsys::otPlatBorderRoutingProcessIcmp6Ra.

fn border_routing_get_pd_processed_ra_info(&self) -> PdProcessedRaInfo

Functional equivalent of otsys::otBorderRoutingGetPdProcessedRaInfo.

fn iter_next_local_external_route( &self, ot_iter: &mut otNetworkDataIterator, ) -> Option<ExternalRouteConfig>

Functional equivalent of otsys::otBorderRouterGetNextRoute.

fn iter_next_local_on_mesh_prefix( &self, ot_iter: &mut otNetworkDataIterator, ) -> Option<BorderRouterConfig>

Functional equivalent of otsys::otBorderRouterGetNextOnMeshPrefix.

fn iter_local_external_routes(&self) -> LocalExternalRouteIterator<'_, Self>

Returns an iterator for iterating over external routes.

fn iter_local_on_mesh_prefixes(&self) -> LocalOnMeshPrefixIterator<'_, Self>

Returns an iterator for iterating over on-mesh prefixes

impl<T: Cli + Boxable> Cli for Box<T>

fn cli_input_line(&self, line: &CStr)

Functional equivalent of otsys::otCliInputLine.

fn cli_init<'a, F>(&self, output_callback: F)

where F: FnMut(&CStr) + 'a,

Functional equivalent of otsys::otCliInit.

impl<T: Dataset + Boxable> Dataset for Box<T>

fn is_commissioned(&self) -> bool

Functional equivalent of otsys::otDatasetIsCommissioned.

fn dataset_create_new_network(&self, dataset: &mut OperationalDataset) -> Result

Functional equivalent of otsys::otDatasetCreateNewNetwork.

fn dataset_get_active(&self, dataset: &mut OperationalDataset) -> Result

Functional equivalent of otsys::otDatasetGetActive.

fn dataset_set_active(&self, dataset: &OperationalDataset) -> Result

Functional equivalent of otsys::otDatasetSetActive.

fn dataset_set_pending(&self, dataset: &OperationalDataset) -> Result

Functional equivalent of otsys::otDatasetSetPending.

fn dataset_get_active_tlvs(&self) -> Result<OperationalDatasetTlvs>

Functional equivalent of otsys::otDatasetGetActiveTlvs.

fn dataset_set_active_tlvs(&self, dataset: &OperationalDatasetTlvs) -> Result

Functional equivalent of otsys::otDatasetSetActiveTlvs.

fn dataset_get_pending_tlvs(&self) -> Result<OperationalDatasetTlvs>

Functional equivalent of otsys::otDatasetGetPendingTlvs.

fn dataset_set_pending_tlvs(&self, dataset: &OperationalDatasetTlvs) -> Result

Functional equivalent of otsys::otDatasetSetPendingTlvs.

fn dataset_send_mgmt_pending_set<'a, F>( &self, dataset: OperationalDataset, dataset_tlvs: &[u8], f: F, ) -> Result

where F: FnOnce(Result) + 'a,

Functional equivalent of otsys::otDatasetSendMgmtPendingSet.

fn dataset_send_mgmt_pending_set_async( &self, dataset: OperationalDataset, dataset_tlvs: &[u8], ) -> Receiver<Result>

Async version of [dataset_send_mgmt_pending_set].

impl<T: Boxable + Debug> Debug for Box<T>

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

Formats the value using the given formatter.

impl<T: Boxable> Deref for Box<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Boxable> DerefMut for Box<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: DnsUpstream + Boxable> DnsUpstream for Box<T>

fn plat_dns_upstream_query_done( &self, query_context: &PlatDnsUpstreamQuery, response: Box<Message<'_>>, )

Update DNS upstream query done

impl<T: Dnssd + Boxable> Dnssd for Box<T>

fn dnssd_get_next_query(&self, prev: Option<&DnssdQuery>) -> Option<&DnssdQuery>

Functional equivalent to otDnssdGetNextQuery.

fn dnssd_query_handle_discovered_host( &self, hostname: &CStr, addresses: &[Ip6Address], ttl: u32, )

Functional equivalent to otDnssdQueryHandleDiscoveredHost.

fn dnssd_query_handle_discovered_service_instance( &self, service_full_name: &CStr, addresses: &[Ip6Address], full_name: &CStr, host_name: &CStr, port: u16, priority: u16, ttl: u32, txt_data: &[u8], weight: u16, )

Functional equivalent to otDnssdQueryHandleDiscoveredServiceInstance.

fn dnssd_query_set_callbacks<'a, F>(&'a self, f: Option<F>)

where F: FnMut(bool, &CStr) + 'a,

Functional equivalent of otsys::otDnssdQuerySetCallbacks.

fn dnssd_get_counters(&self) -> &DnssdCounters

Functional equivalent of otsys::otDnssdGetCounters.

fn dnssd_upstream_query_is_enabled(&self) -> bool

Functional equivalent of otsys::otDnssdUpstreamQueryIsEnabled

fn dnssd_upstream_query_set_enabled(&self, enabled: bool)

Functional equivalent of otsys::otDnssdUpstreamQuerySetEnabled

impl<T: Boxable> Drop for Box<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: InfraInterface + Boxable> InfraInterface for Box<T>

fn plat_infra_if_on_state_changed(&self, id: u32, is_running: bool)

The infra interface driver calls this method to notify OpenThread of the interface state changes.

fn plat_infra_if_discover_nat64_prefix_done( &self, infra_if_idx: u32, ip6_prefix: Ip6Prefix, )

The infra interface driver calls this method to notify OpenThread that the discovery of NAT64 prefix is done.

impl<T: Ip6 + Boxable> Ip6 for Box<T>

fn ip6_send(&self, message: OtMessageBox<'_>) -> Result<()>

Functional equivalent of otsys::otIp6Send.

fn ip6_send_data(&self, data: &[u8]) -> Result

Similar to [ip6_send()], but takes a byte slice instead of an OtMessageBox.

fn ip6_send_data_direct(&self, data: &[u8]) -> Result

Similar to [ip6_send_data()], but sends the packet without layer-2 security.

fn ip6_is_enabled(&self) -> bool

Functional equivalent of otsys::otIp6IsEnabled.

fn ip6_set_enabled(&self, enabled: bool) -> Result

Functional equivalent of otsys::otIp6SetEnabled.

fn ip6_add_unicast_address(&self, addr: &NetifAddress) -> Result

Functional equivalent of otsys::otIp6AddUnicastAddress.

fn ip6_remove_unicast_address(&self, addr: &Ipv6Addr) -> Result

Functional equivalent of otsys::otIp6RemoveUnicastAddress.

fn ip6_join_multicast_group(&self, addr: &Ipv6Addr) -> Result

Functional equivalent of otsys::otIp6SubscribeMulticastAddress.

fn ip6_leave_multicast_group(&self, addr: &Ipv6Addr) -> Result

Functional equivalent of otsys::otIp6UnsubscribeMulticastAddress.

fn ip6_set_receive_fn<'a, F>(&'a self, f: Option<F>)

where F: FnMut(OtMessageBox<'_>) + 'a,

Sets the IPv6 receive callback closure. Functional equivalent of otsys::otIp6SetReceiveCallback.

fn ip6_set_address_fn<'a, F>(&'a self, f: Option<F>)

where F: for<'r> FnMut(Ip6AddressInfo<'r>, bool) + 'a,

Sets the IPv6 address callback closure. Functional equivalent of otsys::otIp6SetAddressCallback.

fn ip6_is_slaac_enabled(&self) -> bool

Functional equivalent of otsys::otIp6IsSlaacEnabled.

fn ip6_set_slaac_enabled(&self, enabled: bool)

Functional equivalent of otsys::otIp6SetSlaacEnabled.

fn icmp6_get_echo_mode(&self) -> Icmp6EchoMode

Functional equivalent of otsys::otIcmp6GetEchoMode.

fn icmp6_set_echo_mode(&self, mode: Icmp6EchoMode)

Functional equivalent of otsys::otIcmp6SetEchoMode.

fn ip6_set_receive_filter_enabled(&self, enabled: bool)

Functional equivalent of otsys::otIp6SetReceiveFilterEnabled.

fn ip6_is_receive_filter_enabled(&self) -> bool

Functional equivalent of otsys::otIp6IsReceiveFilterEnabled.

fn ip6_get_border_routing_counters(&self) -> &BorderRoutingCounters

Functional equivalent of otsys::otIp6GetBorderRoutingCounters.

fn ip6_get_unicast_addresses(&self) -> NetifAddressIterator<'_>

Functional equivalent of otsys::otIp6GetUnicastAddresses.

impl<T: Joiner + Boxable> Joiner for Box<T>

fn joiner_start<'a, F: FnOnce(Result) + 'a>( &self, pskd: &str, provisioning_url: Option<&str>, vendor_name: Option<&str>, vendor_model: Option<&str>, vendor_sw_version: Option<&str>, vendor_data: Option<&str>, callback: F, ) -> Result

Functional equivalent of otsys::otJoinerStart.

fn joiner_stop(&self)

Functional equivalent of otsys::otJoinerStop.

fn joiner_get_state(&self) -> JoinerState

Functional equivalent of otsys::otJoinerGetState.

fn joiner_start_async( &self, pskd: &str, provisioning_url: Option<&str>, vendor_name: Option<&str>, vendor_model: Option<&str>, vendor_sw_version: Option<&str>, vendor_data: Option<&str>, ) -> Receiver<Result>

Similar to [joiner_start()], but as an async method.

impl<T: Link + Boxable> Link for Box<T>

fn get_channel(&self) -> ChannelIndex

Functional equivalent of otsys::otLinkGetChannel.

fn set_channel(&self, index: ChannelIndex) -> Result

Functional equivalent of otsys::otLinkSetChannel.

fn link_get_counters(&self) -> &MacCounters

Functional equivalent of otsys::otLinkGetCounters.

fn get_extended_address(&self) -> &ExtAddress

Functional equivalent of otsys::otLinkGetExtendedAddress.

fn get_factory_assigned_ieee_eui_64(&self) -> ExtAddress

Functional equivalent of otsys::otLinkGetFactoryAssignedIeeeEui64.

fn get_pan_id(&self) -> PanId

Functional equivalent of otsys::otLinkGetPanId.

fn set_pan_id(&self, pan_id: PanId) -> Result<()>

Functional equivalent of otsys::otLinkSetPanId.

fn get_short_address(&self) -> ShortAddress

Functional equivalent of otsys::otLinkGetShortAddress.

fn link_is_enabled(&self) -> bool

Functional equivalent of otsys::otLinkIsEnabled.

fn link_set_enabled(&self, enabled: bool) -> Result

Functional equivalent of otsys::otLinkSetEnabled.

fn link_is_promiscuous(&self) -> bool

Functional equivalent of otsys::otLinkIsPromiscuous.

fn link_set_promiscuous(&self, promiscuous: bool) -> Result

Functional equivalent of otsys::otLinkSetPromiscuous.

fn is_energy_scan_in_progress(&self) -> bool

Functional equivalent of otsys::otLinkIsEnergyScanInProgress.

fn is_active_scan_in_progress(&self) -> bool

Functional equivalent of otsys::otLinkIsActiveScanInProgress.

fn get_supported_channel_mask(&self) -> ChannelMask

Functional equivalent of otsys::otLinkGetSupportedChannelMask.

fn start_active_scan<'a, F>( &self, channels: ChannelMask, dwell: Duration, f: F, ) -> Result

where F: FnMut(Option<&ActiveScanResult>) + 'a,

Starts an active scan. Functional equivalent of otsys::otLinkActiveScan.

fn start_energy_scan<'a, F>( &self, channels: ChannelMask, dwell: Duration, f: F, ) -> Result

where F: FnMut(Option<&EnergyScanResult>) + 'a,

Starts an energy scan. Functional equivalent of otsys::otLinkEnergyScan.

impl<T: LinkMetrics + Boxable> LinkMetrics for Box<T>

fn link_metrics_manager_is_enabled(&self) -> bool

Get Link Metrics Manager enabled/disabled state.

fn link_metrics_manager_set_enabled(&self, enabled: bool)

Enable or disable Link Metrics Manager.

fn link_metrics_manager_get_metrics_value_by_ext_addr( &self, ext_addr: &ExtAddress, ) -> Result<LinkMetricsValues>

Get Link Metrics data of a neighbor by its extended address.

impl<T: MessageBuffer + Boxable> MessageBuffer for Box<T>

fn get_buffer_info(&self) -> BufferInfo

Functional equivalent of otsys::otMessageGetBufferInfo.

impl<T: Nat64 + Boxable> Nat64 for Box<T>

fn nat64_set_enabled(&self, enabled: bool)

Enable or disable NAT64 functions.

fn nat64_set_ip4_cidr(&self, ip4_cidr: Ip4Cidr) -> Result

Sets the CIDR used when setting the source address of the outgoing translated IPv4 packets.

fn nat64_get_cidr(&self) -> Result<Ip4Cidr>

Get CIDR from OpenThread

fn nat64_set_receive_fn<'a, F>(&'a self, f: Option<F>)

where F: FnMut(OtMessageBox<'_>) + 'a,

Registers a callback to provide received IPv4 datagrams.

fn nat64_send(&self, message: OtMessageBox<'_>) -> Result

Send a message to NAT64 handler in OpenThread

fn nat64_send_data_slice(&self, data_slice: &[u8]) -> Result

Send data to NAT64 handler in OpenThread

fn nat64_infra_if_prefix_discover_done( &self, infra_if_idx: NetifIndex, ip6_prefix: otIp6Prefix, )

Return AIL prefix to OpenThread

fn nat64_init_address_mapping_iterator( &self, iter: &mut otNat64AddressMappingIterator, )

Init the NAT64 address mapping iterator

fn nat64_get_next_address_mapping( &self, iter: &mut otNat64AddressMappingIterator, mapping: &mut Nat64AddressMapping, ) -> Result

Get next NAT64 address mapping

fn nat64_get_translator_state(&self) -> Nat64State

Get NAT64 translator state

fn nat64_get_prefix_manager_state(&self) -> Nat64State

Get NAT64 prefix manager state

fn nat64_get_error_counters(&self) -> Nat64ErrorCounters

Get NAT64 error counters

fn nat64_get_counters(&self) -> Nat64ProtocolCounters

Get NAT64 protocol counters

fn nat64_get_address_mapping_iterator( &self, ) -> Nat64AddressMappingIterator<'_, Self>

Get the NAT64 address mapping iterator instance

impl<T: NetData + Boxable> NetData for Box<T>

fn net_data_get<'a>(&self, stable: bool, data: &'a mut [u8]) -> Result<&'a [u8]>

Functional equivalent of otsys::otNetDataGet.

fn net_data_get_version(&self) -> u8

Functional equivalent of otsys::otNetDataGetVersion.

fn net_data_get_stable_version(&self) -> u8

Functional equivalent of otsys::otNetDataGetStableVersion.

fn net_data_as_vec(&self, stable: bool) -> Result<Vec<u8>>

Same as [net_data_get], but returns the net data as a vector.

impl<T: PlatTrel + Boxable> PlatTrel for Box<T>

fn plat_trel_handle_received(&self, packet: &[u8])

This function is a callback from platform to notify of a received TREL UDP packet.

fn plat_trel_handle_discovered_peer_info( &self, peer_info: &PlatTrelPeerInfo<'_>, )

This is a callback function from platform layer to report a discovered TREL peer info.

impl<T: Radio + Boxable> Radio for Box<T>

fn get_coex_metrics(&self) -> Result<RadioCoexMetrics>

Functional equivalent of otsys::otPlatRadioGetCoexMetrics.

fn get_rssi(&self) -> Decibels

Functional equivalent of otsys::otPlatRadioGetRssi.

fn get_region(&self) -> Result<RadioRegion>

Functional equivalent of otsys::otPlatRadioGetRegion.

fn set_region(&self, region: RadioRegion) -> Result

Functional equivalent of otsys::otPlatRadioSetRegion.

fn get_transmit_power(&self) -> Result<Decibels>

Functional equivalent of otsys::otPlatRadioGetTransmitPower.

fn radio_get_version_string(&self) -> &str

Functional equivalent of otsys::otPlatRadioGetVersionString.

impl<T: Reset + Boxable> Reset for Box<T>

fn reset(&self)

Functional equivalent of otsys::otInstanceReset.

fn factory_reset(&self)

Functional equivalent of otsys::otInstanceFactoryReset.

fn erase_persistent_info(&self) -> Result

Functional equivalent of otsys::otInstanceErasePersistentInfo.

impl<T: SrpServer + Boxable> SrpServer for Box<T>

fn srp_server_get_address_mode(&self) -> SrpServerAddressMode

Functional equivalent of otsys::otSrpServerGetAddressMode.

fn srp_server_get_state(&self) -> SrpServerState

Functional equivalent of otsys::otSrpServerGetState.

fn srp_server_get_port(&self) -> u16

Functional equivalent of otsys::otSrpServerGetPort.

fn srp_server_set_auto_enable_mode(&self, enabled: bool)

Functional equivalent of otsys::otSrpServerSetEnabled.

fn srp_server_set_enabled(&self, enabled: bool)

Functional equivalent of otsys::otSrpServerSetEnabled.

fn srp_server_is_enabled(&self) -> bool

Returns true if the SRP server is enabled.

fn srp_server_is_auto_enable_mode(&self) -> bool

Returns true if SRP server auto-enable mode is enabled.

fn srp_server_is_running(&self) -> bool

Returns true if the SRP server is running, false if it is stopped or disabled.

fn srp_server_set_domain(&self, domain: &CStr) -> Result

Functional equivalent of otsys::otSrpServerSetDomain.

fn srp_server_get_domain(&self) -> &CStr

Functional equivalent of otsys::otSrpServerGetDomain.

fn srp_server_get_response_counters(&self) -> &SrpServerResponseCounters

Functional equivalent of otsys::otSrpServerGetResponseCounters.

fn srp_server_next_host<'a>( &'a self, prev: Option<&'a SrpServerHost>, ) -> Option<&'a SrpServerHost>

Functional equivalent of otsys::otSrpServerGetNextHost.

fn srp_server_handle_service_update_result( &self, id: SrpServerServiceUpdateId, result: Result, )

Functional equivalent of otsys::otSrpServerHandleServiceUpdateResult.

fn srp_server_set_service_update_fn<'a, F>(&'a self, f: Option<F>)

where F: FnMut(&'a Instance, SrpServerServiceUpdateId, &'a SrpServerHost, u32) + 'a,

Functional equivalent of otsys::otSrpServerSetServiceUpdateHandler.

fn srp_server_hosts(&self) -> SrpServerHostIterator<'_, Self>

where Self: Sized,

Returns an iterator over the SRP hosts.

impl<T: State + Boxable> State for Box<T>

fn set_state_changed_fn<F>(&self, f: Option<F>)

where F: FnMut(ChangedFlags) + 'static,

Functional equivalent to otsys::otSetStateChangedCallback.

fn state_changed_stream(&self) -> StateChangedStream

Returns an asynchronous stream for state-change events.

impl<T: Tasklets + Boxable> Tasklets for Box<T>

fn set_waker(&self, waker: Waker)

Sets the waker to be used to wake up the tasklet future.

fn wake_waker(&self)

Wakes the waker previously passed to [set_waker].

fn process(&self)

Functional equivalent to otsys::otTaskletsProcess.

fn has_pending(&self) -> bool

Functional equivalent to otsys::otTaskletsHasPending.

impl<T: Thread + Boxable> Thread for Box<T>

fn become_leader(&self) -> Result<()>

Functional equivalent of otsys::otThreadBecomeLeader.

fn become_router(&self) -> Result<()>

Functional equivalent of otsys::otThreadBecomeRouter.

fn get_child_info_by_id(&self, child_id: u16) -> Result<otChildInfo>

Functional equivalent of otsys::otThreadGetChildInfoById.

fn get_leader_data(&self) -> Result<LeaderData>

Functional equivalent of otsys::otThreadGetLeaderData.

fn get_leader_weight(&self) -> u8

Functional equivalent of otsys::otThreadGetLeaderWeight.

fn get_network_key(&self) -> NetworkKey

Functional equivalent of otsys::otThreadGetNetworkKey.

fn set_network_key(&self, key: &NetworkKey) -> Result

Functional equivalent of otsys::otThreadSetNetworkKey.

fn get_network_name_as_slice(&self) -> &[u8]

Functional equivalent of otsys::otThreadGetNetworkName.

fn set_network_name(&self, name: &NetworkName) -> Result

Functional equivalent of otsys::otThreadSetNetworkName.

fn is_singleton(&self) -> bool

Functional equivalent of otsys::otThreadIsSingleton.

fn get_extended_pan_id(&self) -> &ExtendedPanId

Functional equivalent of otsys::otThreadGetExtendedPanId.

fn set_extended_pan_id(&self, xpanid: &ExtendedPanId) -> Result

Functional equivalent of otsys::otThreadSetExtendedPanId.

fn thread_set_enabled(&self, enabled: bool) -> Result

Functional equivalent of otsys::otThreadSetEnabled.

fn get_device_role(&self) -> DeviceRole

Functional equivalent of otsys::otThreadGetDeviceRole.

fn get_partition_id(&self) -> u32

Functional equivalent of otsys::otThreadGetPartitionId.

fn get_rloc16(&self) -> u16

Functional equivalent of otsys::otThreadGetRloc16.

fn get_link_mode(&self) -> LinkModeConfig

Functional equivalent of otsys::otThreadGetLinkMode.

fn set_link_mode(&self, link_mode_config: LinkModeConfig) -> Result

Functional equivalent of otsys::otThreadSetLinkMode.

fn get_rloc(&self) -> Ipv6Addr

Gets the full RLOC address.

fn get_mesh_local_eid(&self) -> Ipv6Addr

Functional equivalent of otsys::otThreadGetMeshLocalEid.

fn get_link_local_addr(&self) -> Ipv6Addr

Functional equivalent of otsys::otThreadGetLinkLocalIp6Address.

fn get_link_local_all_nodes_multicast_addr(&self) -> Ipv6Addr

Functional equivalent of otsys::otThreadGetLinkLocalAllThreadNodesMulticastAddress.

fn get_mesh_local_prefix(&self) -> &MeshLocalPrefix

Functional equivalent of otsys::otThreadGetMeshLocalPrefix.

fn get_router_info(&self, router_id: u16) -> Result<RouterInfo>

Fucntional equivalent of otsys::otThreadGetRouterInfo.

fn get_ip6_counters(&self) -> &IpCounters

Functional equivalent of otsys::otThreadGetIp6Counters.

fn iter_next_neighbor_info( &self, ot_iter: &mut otNeighborInfoIterator, ) -> Option<NeighborInfo>

Functional equivalent of otsys::otThreadGetNextNeighborInfo.

fn get_network_name(&self) -> NetworkName

Similar to [get_network_name_as_slice], but returns an ot::NetworkName.

fn iter_neighbor_info(&self) -> NeighborInfoIterator<'_, Self>

Returns an iterator for iterating over external routes.

impl<T: Trel + Boxable> Trel for Box<T>

fn trel_set_enabled(&self, enabled: bool)

Enables or disables TREL operation.

fn trel_is_enabled(&self) -> bool

Returns true if TREL is enabled.

fn trel_get_counters(&self) -> Option<&TrelCounters>

Return all the TREL counters

fn trel_reset_counters(&self)

Reset TREL counters

fn trel_get_number_of_peers(&self) -> u16

Return the count of TREL peer

impl<T: Udp + Boxable> Udp for Box<T>

fn udp_get_sockets(&self) -> UdpSocketIterator<'_>

Functional equivalent of otsys::otUdpGetSockets.

impl<T: Uptime + Boxable> Uptime for Box<T>

fn get_uptime(&self) -> MonotonicDuration

Functional equivalent of otsys::otInstanceGetUptime.

impl<T: Boxable + InstanceInterface> InstanceInterface for Box<T>

impl<T: Boxable + Send> Send for Box<T>

impl<T: Boxable + Sync> Sync for Box<T>