Struct EapClientConfig 

pub struct EapClientConfig { /* private fields */ }

Available on crate feature unstable only.

Configuration for an EAP (Extensible Authentication Protocol) client.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations

impl EapClientConfig

pub fn with_ssid(self, ssid: String) -> Self

Available on crate feature wifi only.

Assign the given value to the ssid field.

pub fn ssid(&self) -> &String

Available on crate feature wifi only.

The SSID of the network the client is connecting to.

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

Available on crate feature wifi only.

Assign the given value to the bssid field.

pub fn with_bssid_none(self) -> Self

Available on crate feature wifi only.

Set the value of bssid to None.

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

Available on crate feature wifi only.

The BSSID (MAC Address) of the specific access point.

pub fn with_auth_method(self, auth_method: AuthMethod) -> Self

Available on crate feature wifi only.

Assign the given value to the auth_method field.

pub fn auth_method(&self) -> AuthMethod

Available on crate feature wifi only.

The authentication method used for EAP.

pub fn with_identity(self, identity: String) -> Self

Available on crate feature wifi only.

Assign the given value to the identity field.

pub fn with_identity_none(self) -> Self

Available on crate feature wifi only.

Set the value of identity to None.

pub fn identity(&self) -> &Option<String>

Available on crate feature wifi only.

The identity used during authentication.

pub fn with_username(self, username: String) -> Self

Available on crate feature wifi only.

Assign the given value to the username field.

pub fn with_username_none(self) -> Self

Available on crate feature wifi only.

Set the value of username to None.

pub fn username(&self) -> &Option<String>

Available on crate feature wifi only.

The username used for inner authentication. Some EAP methods require a username for authentication.

pub fn with_password(self, password: String) -> Self

Available on crate feature wifi only.

Assign the given value to the password field.

pub fn with_password_none(self) -> Self

Available on crate feature wifi only.

Set the value of password to None.

pub fn password(&self) -> &Option<String>

Available on crate feature wifi only.

The password used for inner authentication.

pub fn with_new_password(self, new_password: String) -> Self

Available on crate feature wifi only.

Assign the given value to the new_password field.

pub fn with_new_password_none(self) -> Self

Available on crate feature wifi only.

Set the value of new_password to None.

pub fn new_password(&self) -> &Option<String>

Available on crate feature wifi only.

A new password to be set during the authentication process. Some methods support password changes during authentication.

pub fn with_eap_fast_config(self, eap_fast_config: EapFastConfig) -> Self

Available on crate feature wifi only.

Assign the given value to the eap_fast_config field.

pub fn with_eap_fast_config_none(self) -> Self

Available on crate feature wifi only.

Set the value of eap_fast_config to None.

pub fn eap_fast_config(&self) -> &Option<EapFastConfig>

Available on crate feature wifi only.

Configuration for EAP-FAST.

pub fn with_pac_file(self, pac_file: &'static [u8]) -> Self

Available on crate feature wifi only.

Assign the given value to the pac_file field.

pub fn with_pac_file_none(self) -> Self

Available on crate feature wifi only.

Set the value of pac_file to None.

pub fn pac_file(&self) -> Option<&'static [u8]>

Available on crate feature wifi only.

A PAC (Protected Access Credential) file for EAP-FAST.

pub fn with_time_check(self, time_check: bool) -> Self

Available on crate feature wifi only.

Assign the given value to the time_check field.

pub fn time_check(&self) -> bool

Available on crate feature wifi only.

A boolean flag indicating whether time checking is enforced during authentication.

pub fn with_ca_cert(self, ca_cert: &'static [u8]) -> Self

Available on crate feature wifi only.

Assign the given value to the ca_cert field.

pub fn with_ca_cert_none(self) -> Self

Available on crate feature wifi only.

Set the value of ca_cert to None.

pub fn ca_cert(&self) -> Option<&'static [u8]>

Available on crate feature wifi only.

A CA (Certificate Authority) certificate for validating the authentication server’s certificate.

pub fn with_certificate_and_key( self, certificate_and_key: (&'static [u8], &'static [u8], Option<&'static [u8]>), ) -> Self

Available on crate feature wifi only.

Assign the given value to the certificate_and_key field.

pub fn with_certificate_and_key_none(self) -> Self

Available on crate feature wifi only.

Set the value of certificate_and_key to None.

pub fn certificate_and_key( &self, ) -> Option<(&'static [u8], &'static [u8], Option<&'static [u8]>)>

Available on crate feature wifi only.

A tuple containing the client’s certificate, private key, and an intermediate certificate.

pub fn with_ttls_phase2_method( self, ttls_phase2_method: TtlsPhase2Method, ) -> Self

Available on crate feature wifi only.

Assign the given value to the ttls_phase2_method field.

pub fn with_ttls_phase2_method_none(self) -> Self

Available on crate feature wifi only.

Set the value of ttls_phase2_method to None.

pub fn ttls_phase2_method(&self) -> &Option<TtlsPhase2Method>

Available on crate feature wifi only.

The Phase 2 authentication method used for EAP-TTLS.

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

Available on crate feature wifi only.

Assign the given value to the channel field.

pub fn with_channel_none(self) -> Self

Available on crate feature wifi only.

Set the value of channel to None.

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

Available on crate feature wifi only.

The specific Wi-Fi channel to use for the connection.

pub fn with_protocols(self, protocols: EnumSet<Protocol>) -> Self

Available on crate feature wifi only.

Assign the given value to the protocols field.

pub fn protocols(&self) -> EnumSet<Protocol>

Available on crate feature wifi only.

The set of protocols supported by the access point.

pub fn with_listen_interval(self, listen_interval: u16) -> Self

Assign the given value to the listen_interval field.

pub fn listen_interval(&self) -> u16

Interval for station to listen to beacon from AP.

The unit of listen interval is one beacon interval. For example, if beacon interval is 100 ms and listen interval is 3, the interval for station to listen to beacon is 300 ms

pub fn with_beacon_timeout(self, beacon_timeout: u16) -> Self

Assign the given value to the beacon_timeout field.

pub fn beacon_timeout(&self) -> u16

Time to disconnect from AP if no data is received.

Must be between 6 and 31.

pub fn with_failure_retry_cnt(self, failure_retry_cnt: u8) -> Self

Assign the given value to the failure_retry_cnt field.

pub fn failure_retry_cnt(&self) -> u8

Number of connection retries station will do before moving to next AP.

scan_method should be set as ScanMethod::AllChannels to use this config.

Note: Enabling this may cause connection time to increase in case the best AP doesn’t behave properly.

pub fn with_scan_method(self, scan_method: ScanMethod) -> Self

Assign the given value to the scan_method field.

pub fn scan_method(&self) -> ScanMethod

Scan method.

Trait Implementations

impl Clone for EapClientConfig

Available on crate feature wifi only.

fn clone(&self) -> EapClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EapClientConfig

Available on crate features wifi and wifi-eap only.

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

Formats the value using the given formatter.

impl Default for EapClientConfig

Available on crate features wifi and wifi-eap only.

fn default() -> Self

Returns the “default value” for a type.

impl Format for EapClientConfig

Available on crate features wifi and defmt and wifi-eap only.

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

Writes the defmt representation of self to fmt.

impl PartialEq for EapClientConfig

Available on crate feature wifi only.

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

Available on crate feature wifi only.

impl StructuralPartialEq for EapClientConfig

Available on crate feature wifi only.