nrf-softdevice-s112

Crates

git

Versions

default

Flavors

#[repr(C)]
pub struct ble_gap_opt_ch_map_t { pub conn_handle: u16, pub ch_map: [u8; 5], }
Expand description

@brief Channel Map option.

@details Used with @ref sd_ble_opt_get to get the current channel map or @ref sd_ble_opt_set to set a new channel map. When setting the channel map, it applies to all current and future connections. When getting the current channel map, it applies to a single connection and the connection handle must be supplied.

@note Setting the channel map may take some time, depending on connection parameters. The time taken may be different for each connection and the get operation will return the previous channel map until the new one has taken effect.

@note After setting the channel map, by spec it can not be set again until at least 1 s has passed. See Bluetooth Specification Version 4.1 Volume 2, Part E, Section 7.3.46.

@retval ::NRF_SUCCESS Get or set successful. @retval ::NRF_ERROR_INVALID_PARAM One or more of the following is true: - Less then two bits in @ref ch_map are set. - Bits for primary advertising channels (37-39) are set. @retval ::NRF_ERROR_BUSY Channel map was set again before enough time had passed. @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid connection handle supplied for get. @retval ::NRF_ERROR_NOT_SUPPORTED Returned by @ref sd_ble_opt_set in peripheral-only SoftDevices.

Fields§

§conn_handle: u16

< Connection Handle (only applicable for get)

§ch_map: [u8; 5]

< Channel Map (37-bit).

Trait Implementations§

source§

impl Clone for ble_gap_opt_ch_map_t

source§

fn clone(&self) -> ble_gap_opt_ch_map_t

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ble_gap_opt_ch_map_t

source§

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

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

impl Copy for ble_gap_opt_ch_map_t

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · 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.

source§

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.