Struct SFAuthorization

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

Available on crate feature SFAuthorization only.

SFAuthorization APIs are used for implementing access control in applications and daemons. It has NSCoder support for proxied objects SFAuthorization is a wrapper for using the Authorization API.

See also Apple’s documentation

Implementations

impl SFAuthorization

pub unsafe fn authorization() -> Option<Retained<AnyObject>>

Returns an authorization object initialized with a default environment, flags and rights.

pub unsafe fn authorizationRef(&self) -> AuthorizationRef

Available on crate feature objc2-security only.

Returns the AuthorizationRef for this SFAuthorization.

pub unsafe fn authorizationWithFlags_rights_environment( flags: AuthorizationFlags, rights: *const AuthorizationRights, environment: *const AuthorizationEnvironment, ) -> Option<Retained<AnyObject>>

Available on crate feature objc2-security only.

Returns an authorization object initialized with the specified flags, rights and environment.

Parameter flags: Authorization flags.

Parameter rights: (input/optional) An AuthorizationItemSet containing rights for which authorization is being requested. If none are specified the resulting AuthorizationRef will authorize nothing at all.

Parameter environment: (input/optional) An AuthorizationItemSet containing enviroment state used when making the autorization decision. See the AuthorizationEnvironment type for details.

pub unsafe fn initWithFlags_rights_environment( this: Allocated<Self>, flags: AuthorizationFlags, rights: *const AuthorizationRights, environment: *const AuthorizationEnvironment, ) -> Option<Retained<Self>>

Available on crate feature objc2-security only.

Initializes an authorization object specified flags, rights and environment.

Parameter flags: Authorization flags.

Parameter rights: (input/optional) An AuthorizationItemSet containing rights for which authorization is being requested. If none are specified the resulting AuthorizationRef will authorize nothing at all.

Parameter environment: (input/optional) An AuthorizationItemSet containing enviroment state used when making the autorization decision. See the AuthorizationEnvironment type for details.

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

Initializes an authorization object initialized with a default environment, flags and rights.

pub unsafe fn invalidateCredentials(&self)

Calling this will prevent any rights that were obtained by this object to be preserved. It effectively locks down all potentially shared authorizations.

pub unsafe fn obtainWithRight_flags_error( &self, right_name: AuthorizationString, flags: AuthorizationFlags, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate feature objc2-security only.

Call obtainWithRight to gain a right to have access to a privilege operation. On success, YES is returned.

Parameter rightName: The name of an authorization right.

Parameter flags: Authorization flags.

Parameter error: Resulting error.

pub unsafe fn obtainWithRights_flags_environment_authorizedRights_error( &self, rights: *const AuthorizationRights, flags: AuthorizationFlags, environment: *const AuthorizationEnvironment, authorized_rights: *mut *mut AuthorizationRights, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate feature objc2-security only.

Call obtainWithRights to gain the rights to have access to privileged operations. On success, YES is returned.

Parameter flags: Authorization flags.

Parameter rights: (input) A rights set (see AuthorizationCreate).

Parameter environment: (input/optional) An AuthorizationItemSet containing enviroment state used when making the autorization decision. See the AuthorizationEnvironment type for details.

Parameter authorizedRights: (output/optional) A pointer to a newly allocated AuthorizationInfoSet in which the authorized subset of rights are returned (authorizedRights should be deallocated by calling AuthorizationFreeInfoSet() when it is no longer needed). If NULL the only information returned is the status. Note that if the kAuthorizationFlagPreAuthorize flag was specified rights that could not be preauthorized are returned in authorizedRights, but their flags contains the kAuthorizationFlagCanNotPreAuthorize bit.

Parameter error: Resulting error.

impl SFAuthorization

Methods declared on superclass NSObject.

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

impl SFAuthorization

SFAuthorizationDeprecated.

pub unsafe fn permitWithRights_flags_environment_authorizedRights( &self, rights: *const AuthorizationRights, flags: AuthorizationFlags, environment: *const AuthorizationEnvironment, authorized_rights: *mut AuthorizationRights, ) -> i32

👎Deprecated

Available on crate feature objc2-security only.

DEPRECATED: Use obtainWithRights:flags:environment:authorizedRights:error:

Call permitWithRights to gain the rights to have access to privileged operations and to obtain the result.

Parameter flags: Authorization flags.

Parameter rights: (input) A rights set (see AuthorizationCreate).

Parameter environment: (input/optional) An AuthorizationItemSet containing enviroment state used when making the autorization decision. See the AuthorizationEnvironment type for details.

Parameter authorizedRights: (output/optional) A pointer to a newly allocated AuthorizationInfoSet in which the authorized subset of rights are returned (authorizedRights should be deallocated by calling AuthorizationFreeInfoSet() when it is no longer needed). If NULL the only information returned is the status. Note that if the kAuthorizationFlagPreAuthorize flag was specified rights that could not be preauthorized are returned in authorizedRights, but their flags contains the kAuthorizationFlagCanNotPreAuthorize bit.

pub unsafe fn permitWithRight_flags( &self, right_name: AuthorizationString, flags: AuthorizationFlags, ) -> i32

👎Deprecated

Available on crate feature objc2-security only.

DEPRECATED: Use obtainWithRight:flags:error:

Call permitWithRight to gain a right to have access to a privilege operation.

Parameter rightName: The name of an authorization right.

Parameter flags: Authorization flags.

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 SFAuthorization

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SFAuthorization

fn as_ref(&self) -> &NSObject

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

impl AsRef<SFAuthorization> for SFAuthorization

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SFAuthorization

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SFAuthorization

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SFAuthorization

const NAME: &'static str = "SFAuthorization"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SFAuthorization 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 SFAuthorization

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

Formats the value using the given formatter.

impl Deref for SFAuthorization

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SFAuthorization

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 SFAuthorization

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SFAuthorization

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 SFAuthorization

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SFAuthorization

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 SFAuthorization

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

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

impl DowncastTarget for SFAuthorization

impl Eq for SFAuthorization

impl NSCoding for SFAuthorization