Skip to main content

ScanConfig

Struct ScanConfig 

Source
#[non_exhaustive]
pub struct ScanConfig { /* private fields */ }
Available on crate feature wifi only.
Expand description

Scan configuration.

Implementations§

Source§

impl ScanConfig

Source

pub fn ssid(&self) -> Option<Ssid>

SSID to filter for. If [None] is passed, all SSIDs will be returned. If [Some] is passed, only the APs matching the given SSID will be returned.

Source

pub fn with_bssid(self, bssid: [u8; 6]) -> Self

Assign the given value to the bssid field.

Source

pub fn with_bssid_none(self) -> Self

Set the value of bssid to None.

Source

pub fn bssid(&self) -> Option<[u8; 6]>

BSSID to filter for. If [None] is passed, all BSSIDs will be returned. If [Some] is passed, only the APs matching the given BSSID will be returned.

Source

pub fn with_channel(self, channel: u8) -> Self

Assign the given value to the channel field.

Source

pub fn with_channel_none(self) -> Self

Set the value of channel to None.

Source

pub fn channel(&self) -> Option<u8>

Channel to filter for. If [None] is passed, all channels will be returned. If [Some] is passed, only the APs on the given channel will be returned.

Source

pub fn with_show_hidden(self, show_hidden: bool) -> Self

Assign the given value to the show_hidden field.

Source

pub fn show_hidden(&self) -> bool

Whether to show hidden networks.

Source

pub fn with_scan_type(self, scan_type: ScanTypeConfig) -> Self

Assign the given value to the scan_type field.

Source

pub fn scan_type(&self) -> ScanTypeConfig

Scan type, active or passive.

Source

pub fn with_max(self, max: usize) -> Self

Assign the given value to the max field.

Source

pub fn with_max_none(self) -> Self

Set the value of max to None.

Source

pub fn max(&self) -> Option<usize>

The maximum number of networks to return when scanning. If [None] is passed, all networks will be returned. If [Some] is passed, the specified number of networks will be returned.

Source§

impl ScanConfig

Source

pub fn with_ssid(self, ssid: impl Into<Ssid>) -> Self

Set the SSID of the access point.

Source

pub fn with_ssid_none(self) -> Self

Clears the SSID.

Trait Implementations§

Source§

impl Clone for ScanConfig

Source§

fn clone(&self) -> ScanConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable)§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ScanConfig

Source§

impl Debug for ScanConfig

Source§

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

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

impl Default for ScanConfig

Source§

fn default() -> ScanConfig

Returns the “default value” for a type. Read more
Source§

impl Eq for ScanConfig

Source§

impl Format for ScanConfig
where Option<Ssid>: Format, Option<[u8; 6]>: Format, Option<u8>: Format, ScanTypeConfig: Format, Option<usize>: Format,

Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
Source§

impl PartialEq for ScanConfig

Source§

fn eq(&self, other: &ScanConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable)§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ScanConfig

Auto Trait Implementations§

§

impl Freeze for ScanConfig

§

impl RefUnwindSafe for ScanConfig

§

impl Send for ScanConfig

§

impl Sync for ScanConfig

§

impl Unpin for ScanConfig

§

impl UnsafeUnpin for ScanConfig

§

impl UnwindSafe for ScanConfig

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

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

§

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

The type returned in the event of a conversion error.
§

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

Performs the conversion.