Struct NEHotspotNetwork

Source

#[repr(C)]
pub struct NEHotspotNetwork { /* private fields */ }

Expand description

The NEHotspotNetwork class provides a class method to get the SSID and BSSID of the current Wi-Fi network.

NEHotspotNetwork is part of NetworkExtension.framework

Implementations§

Source §

impl NEHotspotNetwork

Source

pub unsafe fn SSID(&self) -> Retained<NSString>

The SSID of the Wi-Fi network.

Source

pub unsafe fn BSSID(&self) -> Retained<NSString>

The BSSID of the Wi-Fi network.

Source

pub unsafe fn securityType(&self) -> NEHotspotNetworkSecurityType

The security type of the Wi-Fi network.

Source

pub unsafe fn fetchCurrentWithCompletionHandler( completion_handler: &DynBlock<dyn Fn(*mut NEHotspotNetwork)>, )

Available on crate feature block2 only.

This method returns SSID, BSSID and security type of the current Wi-Fi network when the requesting application meets one of following 4 requirements -.

application is using CoreLocation API and has user’s authorization to access precise location.
application has used NEHotspotConfiguration API to configure the current Wi-Fi network.
application has active VPN configurations installed.
application has active NEDNSSettingsManager configuration installed. An application will receive nil if it fails to meet any of the above 4 requirements. An application will receive nil if does not have the “com.apple.developer.networking.wifi-info” entitlement.

Parameter completionHandler: A block that will be executed when current Wi-Fi network details are obtained from the system. The NEHotspotNetwork object passed to this block will be nil if the requesting application fails to meet above requirements, non-nil otherwise. NEHotspotNetwork object contains only valid SSID, BSSID and security type values, when the block is passed non-nil object.This block is executed on application’s main queue.

Source §

impl NEHotspotNetwork

Methods declared on superclass NSObject.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Source §

impl NEHotspotNetwork

HotspotHelper. Extends NEHotspotNetwork class to support conveying information about the network to the HotspotHelper. When the HotspotHelper is asked to evaluate the current network or filter the Wi-Fi scan list, it annotates the NEHotspotNetwork via the setConfidence method.

Source

pub unsafe fn signalStrength(&self) -> c_double

The signal strength for the Wi-Fi network. The value lies within the range 0.0 (weak/no signal) to 1.0 (strong signal).

Source

pub unsafe fn isSecure(&self) -> bool

Indicates whether the network is secure

Source

pub unsafe fn didAutoJoin(&self) -> bool

Indicates whether the network was joined automatically (YES) or joined by the user (NO).

Source

pub unsafe fn didJustJoin(&self) -> bool

Indicates whether the network was just joined. Useful in the Maintaining state to differentiate whether the Maintain command is for the initial join, or the subsequent periodic callback.

Source

pub unsafe fn isChosenHelper(&self) -> bool

Indicates whether the HotspotHelper is the chosen helper for the network. The NEHotspotNetwork must have been instantiated via a call to the +[NEHotspotHelper supportedNetworkInterfaces] method. This is useful to restore state after the HotspotHelper application is quit and restarted.

Source

pub unsafe fn setConfidence(&self, confidence: NEHotspotHelperConfidence)

Indicate the confidence in being able to handle the network.

Use this method to indicate the confidence in being able to successfully authenticate to the given network. Used in the response to the kNEHotspotHelperCommandTypeEvaluate and kNEHotspotHelperCommandTypeFilterScanList commands.

Source

pub unsafe fn setPassword(&self, password: &NSString)

Provide the password for a secure network

The HotspotHelper may set a password for a secure network. The format password string must adhere to IEEE 802.11 guidelines appropriate for the particular security scheme.

Used only in the response to the kNEHotspotHelperCommandTypeFilterScanList command.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}