Struct CLLocationManager 

pub struct CLLocationManager { /* private fields */ }

Available on crate feature CLLocationManager only.

Apple’s documentation

Implementations

impl CLLocationManager

pub unsafe fn locationServicesEnabled_class() -> bool

pub unsafe fn headingAvailable_class() -> bool

pub unsafe fn significantLocationChangeMonitoringAvailable() -> bool

pub unsafe fn isMonitoringAvailableForClass(region_class: &AnyClass) -> bool

Safety

region_class probably has further requirements.

pub unsafe fn regionMonitoringAvailable() -> bool

👎Deprecated

pub unsafe fn regionMonitoringEnabled() -> bool

👎Deprecated: Use +isMonitoringAvailableForClass: and -authorizationStatus instead

pub unsafe fn isRangingAvailable() -> bool

pub unsafe fn authorizationStatus(&self) -> CLAuthorizationStatus

pub unsafe fn authorizationStatus_class() -> CLAuthorizationStatus

👎Deprecated

pub unsafe fn accuracyAuthorization(&self) -> CLAccuracyAuthorization

pub unsafe fn isAuthorizedForWidgetUpdates(&self) -> bool

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn CLLocationManagerDelegate>>>

Available on crate feature CLLocationManagerDelegate only.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn CLLocationManagerDelegate>>, )

Available on crate feature CLLocationManagerDelegate only.

Setter for delegate.

This is a weak property.

pub unsafe fn locationServicesEnabled(&self) -> bool

👎Deprecated

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

👎Deprecated: Set the purpose string in Info.plist using key NSLocationUsageDescription

pub unsafe fn setPurpose(&self, purpose: Option<&NSString>)

👎Deprecated: Set the purpose string in Info.plist using key NSLocationUsageDescription

Setter for purpose.

This is copied when set.

pub unsafe fn activityType(&self) -> CLActivityType

pub unsafe fn setActivityType(&self, activity_type: CLActivityType)

Setter for activityType.

pub unsafe fn distanceFilter(&self) -> CLLocationDistance

Available on crate feature CLLocation only.

pub unsafe fn setDistanceFilter(&self, distance_filter: CLLocationDistance)

Available on crate feature CLLocation only.

Setter for distanceFilter.

pub unsafe fn desiredAccuracy(&self) -> CLLocationAccuracy

Available on crate feature CLLocation only.

pub unsafe fn setDesiredAccuracy(&self, desired_accuracy: CLLocationAccuracy)

Available on crate feature CLLocation only.

Setter for desiredAccuracy.

pub unsafe fn pausesLocationUpdatesAutomatically(&self) -> bool

pub unsafe fn setPausesLocationUpdatesAutomatically( &self, pauses_location_updates_automatically: bool, )

Setter for pausesLocationUpdatesAutomatically.

pub unsafe fn allowsBackgroundLocationUpdates(&self) -> bool

pub unsafe fn setAllowsBackgroundLocationUpdates( &self, allows_background_location_updates: bool, )

Setter for allowsBackgroundLocationUpdates.

pub unsafe fn showsBackgroundLocationIndicator(&self) -> bool

pub unsafe fn setShowsBackgroundLocationIndicator( &self, shows_background_location_indicator: bool, )

Setter for showsBackgroundLocationIndicator.

pub unsafe fn location(&self) -> Option<Retained<CLLocation>>

Available on crate feature CLLocation only.

pub unsafe fn headingAvailable(&self) -> bool

👎Deprecated

pub unsafe fn headingFilter(&self) -> CLLocationDegrees

Available on crate feature CLLocation only.

pub unsafe fn setHeadingFilter(&self, heading_filter: CLLocationDegrees)

Available on crate feature CLLocation only.

Setter for headingFilter.

pub unsafe fn headingOrientation(&self) -> CLDeviceOrientation

pub unsafe fn setHeadingOrientation( &self, heading_orientation: CLDeviceOrientation, )

Setter for headingOrientation.

pub unsafe fn heading(&self) -> Option<Retained<CLHeading>>

Available on crate feature CLHeading only.

pub unsafe fn maximumRegionMonitoringDistance(&self) -> CLLocationDistance

Available on crate feature CLLocation only.

pub unsafe fn monitoredRegions(&self) -> Retained<NSSet<CLRegion>>

Available on crate feature CLRegion only.

pub unsafe fn rangedRegions(&self) -> Retained<NSSet<CLRegion>>

👎Deprecated: Use -rangedBeaconConstraints

Available on crate feature CLRegion only.

pub unsafe fn rangedBeaconConstraints( &self, ) -> Retained<NSSet<CLBeaconIdentityConstraint>>

Available on crate features CLBeaconIdentityCondition and CLBeaconIdentityConstraint and CLCondition only.

pub unsafe fn requestWhenInUseAuthorization(&self)

pub unsafe fn requestAlwaysAuthorization(&self)

pub unsafe fn requestTemporaryFullAccuracyAuthorizationWithPurposeKey_completion( &self, purpose_key: &NSString, completion: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub unsafe fn requestTemporaryFullAccuracyAuthorizationWithPurposeKey( &self, purpose_key: &NSString, )

pub unsafe fn startUpdatingLocation(&self)

pub unsafe fn stopUpdatingLocation(&self)

pub unsafe fn requestLocation(&self)

pub unsafe fn startUpdatingHeading(&self)

pub unsafe fn stopUpdatingHeading(&self)

pub unsafe fn dismissHeadingCalibrationDisplay(&self)

pub unsafe fn startMonitoringSignificantLocationChanges(&self)

pub unsafe fn stopMonitoringSignificantLocationChanges(&self)

pub unsafe fn startMonitoringLocationPushesWithCompletion( &self, completion: Option<&DynBlock<dyn Fn(*mut NSData, *mut NSError)>>, )

Available on crate feature block2 only.

pub unsafe fn stopMonitoringLocationPushes(&self)

pub unsafe fn startMonitoringForRegion_desiredAccuracy( &self, region: &CLRegion, accuracy: CLLocationAccuracy, )

👎Deprecated

Available on crate features CLLocation and CLRegion only.

pub unsafe fn stopMonitoringForRegion(&self, region: &CLRegion)

👎Deprecated

Available on crate feature CLRegion only.

pub unsafe fn startMonitoringForRegion(&self, region: &CLRegion)

👎Deprecated

Available on crate feature CLRegion only.

pub unsafe fn requestStateForRegion(&self, region: &CLRegion)

👎Deprecated

Available on crate feature CLRegion only.

pub unsafe fn startRangingBeaconsInRegion(&self, region: &CLBeaconRegion)

👎Deprecated: Use -startRangingBeaconsSatisfyingConstraint:

Available on crate features CLBeaconRegion and CLRegion only.

pub unsafe fn stopRangingBeaconsInRegion(&self, region: &CLBeaconRegion)

👎Deprecated: Use -stopRangingBeaconsSatisfyingConstraint:

Available on crate features CLBeaconRegion and CLRegion only.

pub unsafe fn startRangingBeaconsSatisfyingConstraint( &self, constraint: &CLBeaconIdentityConstraint, )

Available on crate features CLBeaconIdentityCondition and CLBeaconIdentityConstraint and CLCondition only.

pub unsafe fn stopRangingBeaconsSatisfyingConstraint( &self, constraint: &CLBeaconIdentityConstraint, )

Available on crate features CLBeaconIdentityCondition and CLBeaconIdentityConstraint and CLCondition only.

pub unsafe fn allowDeferredLocationUpdatesUntilTraveled_timeout( &self, distance: CLLocationDistance, timeout: NSTimeInterval, )

👎Deprecated: You can remove calls to this method

Available on crate feature CLLocation only.

pub unsafe fn disallowDeferredLocationUpdates(&self)

👎Deprecated: You can remove calls to this method

pub unsafe fn deferredLocationUpdatesAvailable() -> bool

👎Deprecated: You can remove calls to this method

pub unsafe fn requestHistoricalLocationsWithPurposeKey_sampleCount_completionHandler( &self, purpose_key: &NSString, sample_count: NSInteger, handler: &DynBlock<dyn Fn(NonNull<NSArray<CLLocation>>, *mut NSError)>, )

Available on crate features CLLocation and block2 only.

impl CLLocationManager

Methods declared on superclass NSObject.

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

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

impl CLLocationManager

CLVisitExtensions.

pub unsafe fn startMonitoringVisits(&self)

Available on crate feature CLLocationManager_CLVisitExtensions only.

pub unsafe fn stopMonitoringVisits(&self)

Available on crate feature CLLocationManager_CLVisitExtensions only.

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 CLLocationManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CLLocationManager> for CLLocationManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CLLocationManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CLLocationManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CLLocationManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CLLocationManager

const NAME: &'static str = "CLLocationManager"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CLLocationManager 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 Debug for CLLocationManager

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

Formats the value using the given formatter.

impl Deref for CLLocationManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CLLocationManager

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 CLLocationManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CLLocationManager

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 PartialEq for CLLocationManager

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 CLLocationManager

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

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

impl DowncastTarget for CLLocationManager

impl Eq for CLLocationManager