Struct SecRequirement

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

Available on crate feature CSCommon only.

This is the type of a reference to a code requirement.

See also Apple’s documentation

Implementations

impl SecRequirement

pub unsafe fn create_with_data( data: &CFData, flags: SecCSFlags, requirement: NonNull<*mut SecRequirement>, ) -> i32

Available on crate feature SecRequirement only.

Create a SecRequirement object from binary form. This is the effective inverse of SecRequirementCopyData.

Parameter data: A binary blob obtained earlier from a valid SecRequirement object using the SecRequirementCopyData call. This is the only publicly supported way to get such a data blob.

Parameter flags: Optional flags. Pass kSecCSDefaultFlags for standard behavior.

Parameter requirement: On successful return, contains a reference to a SecRequirement object that behaves identically to the one the data blob was obtained from.

Returns: Upon success, errSecSuccess. Upon error, an OSStatus value documented in CSCommon.h or certain other Security framework headers.

pub unsafe fn create_with_string( text: &CFString, flags: SecCSFlags, requirement: NonNull<*mut SecRequirement>, ) -> i32

Available on crate feature SecRequirement only.

Create a SecRequirement object by compiling a valid text representation of a requirement.

Parameter text: A CFString containing the text form of a (single) Code Requirement.

Parameter flags: Optional flags. Pass kSecCSDefaultFlags for standard behavior.

Parameter requirement: On successful return, contains a reference to a SecRequirement object that implements the conditions described in text.

Returns: Upon success, errSecSuccess. Upon error, an OSStatus value documented in CSCommon.h or certain other Security framework headers.

pub unsafe fn create_with_string_and_errors( text: &CFString, flags: SecCSFlags, errors: *mut *mut CFError, requirement: NonNull<*mut SecRequirement>, ) -> i32

Available on crate feature SecRequirement only.

pub unsafe fn copy_data( self: &SecRequirement, flags: SecCSFlags, data: NonNull<*const CFData>, ) -> i32

Available on crate feature SecRequirement only.

Extracts a stable, persistent binary form of a SecRequirement. This is the effective inverse of SecRequirementCreateWithData.

Parameter requirement: A valid SecRequirement object.

Parameter flags: Optional flags. Pass kSecCSDefaultFlags for standard behavior.

Parameter data: On successful return, contains a reference to a CFData object containing a binary blob that can be fed to SecRequirementCreateWithData to recreate a SecRequirement object with identical behavior.

Returns: Upon success, errSecSuccess. Upon error, an OSStatus value documented in CSCommon.h or certain other Security framework headers.

pub unsafe fn copy_string( self: &SecRequirement, flags: SecCSFlags, text: NonNull<*const CFString>, ) -> i32

Available on crate feature SecRequirement only.

Converts a SecRequirement object into text form. This is the effective inverse of SecRequirementCreateWithString.

Repeated application of this function may produce text that differs in formatting, may contain different source comments, and may perform its validation functions in different order. However, it is guaranteed that recompiling the text using SecRequirementCreateWithString will produce a SecRequirement object that behaves identically to the one you start with.

Parameter requirement: A valid SecRequirement object.

Parameter flags: Optional flags. Pass kSecCSDefaultFlags for standard behavior.

Parameter text: On successful return, contains a reference to a CFString object containing a text representation of the requirement.

Returns: Upon success, errSecSuccess. Upon error, an OSStatus value documented in CSCommon.h or certain other Security framework headers.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Available on crate feature SecCustomTransform only.

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Available on crate feature SecCustomTransform only.

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for SecRequirement

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for SecRequirement

fn as_ref(&self) -> &CFType

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

impl AsRef<SecRequirement> for SecRequirement

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SecRequirement

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for SecRequirement

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for SecRequirement

Available on crate feature SecRequirement only.

fn type_id() -> CFTypeID

Returns the type identifier of all SecRequirement instances.

impl Debug for SecRequirement

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

Formats the value using the given formatter.

impl Deref for SecRequirement

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SecRequirement

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 SecRequirement

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for SecRequirement

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 SecRequirement

const ENCODING_REF: Encoding

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

impl Type for SecRequirement

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

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for SecRequirement