Struct NEHotspotConfiguration

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

The NEHotspotConfiguration class represents set of properties that are required to configure a Wi-Fi Network.

See also Apple’s documentation

Implementations

impl NEHotspotConfiguration

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

SSID of the Wi-Fi Network.

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

Prefix string of SSID of the Wi-Fi Network.

pub unsafe fn joinOnce(&self) -> bool

if set to YES the configuration will not be persisted. Default is NO.

pub unsafe fn setJoinOnce(&self, join_once: bool)

Setter for joinOnce.

pub unsafe fn lifeTimeInDays(&self) -> Retained<NSNumber>

The lifetime of the configuration in days. The configuration is stored for the number of days specified by this property. The minimum value is 1 day and maximum value is 365 days. A configuration does not get deleted automatically if this property is not set or set to an invalid value. This property does not apply to Enterprise and HS2.0 networks.

pub unsafe fn setLifeTimeInDays(&self, life_time_in_days: &NSNumber)

Setter for lifeTimeInDays.

pub unsafe fn hidden(&self) -> bool

if set to YES the system will perform active scan of the SSID. Default is NO.

pub unsafe fn setHidden(&self, hidden: bool)

Setter for hidden.

pub unsafe fn initWithSSID( this: Allocated<Self>, ssid: &NSString, ) -> Retained<Self>

A designated initializer to instantiate a new NEHotspotConfiguration object. This initializer is used to configure open Wi-Fi Networks.

Parameter SSID: The SSID of the open Wi-Fi Network. Length of SSID must be between 1 and 32 characters.

pub unsafe fn initWithSSID_passphrase_isWEP( this: Allocated<Self>, ssid: &NSString, passphrase: &NSString, is_wep: bool, ) -> Retained<Self>

A designated initializer to instantiate a new NEHotspotConfiguration object. This initializer is used configure either WEP or WPA/WPA2 Personal Wi-Fi Networks.

Parameter SSID: The SSID of the WEP or WPA/WPA2 Personal Wi-Fi Network

Parameter passphrase: The passphrase credential. For WPA/WPA2 Personal networks: between 8 and 63 characters. For Static WEP(64bit) : 10 Hex Digits For Static WEP(128bit) : 26 Hex Digits

Parameter isWEP: YES specifies WEP Wi-Fi Network else WPA/WPA2 Personal Wi-Fi Network

pub unsafe fn initWithSSID_eapSettings( this: Allocated<Self>, ssid: &NSString, eap_settings: &NEHotspotEAPSettings, ) -> Retained<Self>

A designated initializer to instantiate a new NEHotspotConfiguration object. This initializer is used configure WPA/WPA2 Enterprise Wi-Fi Networks.

Parameter SSID: The SSID of WPA/WPA2 Enterprise Wi-Fi Network

Parameter eapSettings: EAP configuration

pub unsafe fn initWithHS20Settings_eapSettings( this: Allocated<Self>, hs20_settings: &NEHotspotHS20Settings, eap_settings: &NEHotspotEAPSettings, ) -> Retained<Self>

A designated initializer to instantiate a new NEHotspotConfiguration object. This initializer is used configure HS2.0 Wi-Fi Networks.

Parameter hs20Settings: Hotspot 2.0 configuration

Parameter eapSettings: EAP configuration

pub unsafe fn initWithSSIDPrefix( this: Allocated<Self>, ssid_prefix: &NSString, ) -> Retained<Self>

A designated initializer to instantiate a new NEHotspotConfiguration object. This initializer is used to configure open Wi-Fi Networks.

Parameter SSIDPrefix: The prefix string of SSID of the open Wi-Fi Network. Length of SSIDPrefix must be between 3 and 32 characters.

pub unsafe fn initWithSSIDPrefix_passphrase_isWEP( this: Allocated<Self>, ssid_prefix: &NSString, passphrase: &NSString, is_wep: bool, ) -> Retained<Self>

A designated initializer to instantiate a new NEHotspotConfiguration object. This initializer is used configure either WEP or WPA/WPA2 Personal Wi-Fi Networks.

Parameter SSIDPrefix: The prefix string of SSID of the WEP or WPA/WPA2 Personal Wi-Fi Network. Length of SSIDPrefix must be between 3 and 32 characters.

Parameter passphrase: The passphrase credential. For WPA/WPA2 Personal networks: between 8 and 63 characters. For Static WEP(64bit) : 10 Hex Digits For Static WEP(128bit) : 26 Hex Digits

Parameter isWEP: YES specifies WEP Wi-Fi Network else WPA/WPA2 Personal Wi-Fi Network

impl NEHotspotConfiguration

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NEHotspotConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NEHotspotConfiguration> for NEHotspotConfiguration

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NEHotspotConfiguration

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NEHotspotConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NEHotspotConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NEHotspotConfiguration

const NAME: &'static str = "NEHotspotConfiguration"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NEHotspotConfiguration as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for NEHotspotConfiguration

type Result = NEHotspotConfiguration

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NEHotspotConfiguration

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

Formats the value using the given formatter.

impl Deref for NEHotspotConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NEHotspotConfiguration

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for NEHotspotConfiguration

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NEHotspotConfiguration

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NEHotspotConfiguration

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for NEHotspotConfiguration

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NEHotspotConfiguration

fn eq(&self, other: &Self) -> 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 RefEncode for NEHotspotConfiguration

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for NEHotspotConfiguration

impl Eq for NEHotspotConfiguration

impl NSCoding for NEHotspotConfiguration