Struct security_framework::item::ItemSearchOptions

pub struct ItemSearchOptions { /* private fields */ }

A builder type to search for items in keychains.

Implementations

impl ItemSearchOptions

pub fn new() -> Self

Creates a new builder with default options.

pub fn class(&mut self, class: ItemClass) -> &mut Self

Search only for items of the specified class.

pub fn key_class(&mut self, key_class: KeyClass) -> &mut Self

Search only for keys of the specified class. Also sets self.class to ItemClass::key().

pub fn load_refs(&mut self, load_refs: bool) -> &mut Self

Load Security Framework objects (SecCertificate, SecKey, etc) for the results.

pub fn load_attributes(&mut self, load_attributes: bool) -> &mut Self

Load Security Framework object attributes for the results.

pub fn load_data(&mut self, load_data: bool) -> &mut Self

Load Security Framework objects data for the results.

pub fn limit<T: Into<Limit>>(&mut self, limit: T) -> &mut Self

Limit the number of search results.

If this is not called, the default limit is 1.

pub fn label(&mut self, label: &str) -> &mut Self

Search for an item with the given label.

pub fn access_group_token(&mut self) -> &mut Self

Sets kSecAttrAccessGroup to kSecAttrAccessGroupToken

pub fn pub_key_hash(&mut self, pub_key_hash: &[u8]) -> &mut Self

Search for a certificate with the given public key hash.

This is only compatible with ItemClass::certificate, to search for a key by public key hash use ItemSearchOptions::application_label instead.

pub fn application_label(&mut self, app_label: &[u8]) -> &mut Self

Search for a key with the given public key hash.

This is only compatible with ItemClass::key, to search for a certificate by the public key hash use ItemSearchOptions::pub_key_hash instead.

pub fn search(&self) -> Result<Vec<SearchResult>>

Search for objects.

Trait Implementations

impl Default for ItemSearchOptions

fn default() -> ItemSearchOptions

Returns the “default value” for a type.

impl ItemSearchOptionsExt for ItemSearchOptions

fn keychains(&mut self, keychains: &[SecKeychain]) -> &mut Self

Search within the specified keychains.