Struct keyring_search::Search

pub struct Search { /* private fields */ }

Implementations

impl Search

The implementation of the Search structures methods.

The default search types are: Target, User, and Service. On linux-keyutils these all default to searching the ‘session’ keyring. If searching in a different keyring, utilize the platform specific search_by_keyring function

pub fn new() -> Result<Search>

Create a new instance of the Credential Search.

The default credential search is used.

pub fn by_target(&self, query: &str) -> CredentialSearchResult

Specifies searching by target and the query string

Can return: SearchError NoResults Unexpected

Example

let search = keyring_search::Search::new().unwrap();
let results = search.by_target("Foo.app");

pub fn by_user(&self, query: &str) -> CredentialSearchResult

Specifies searching by user and the query string

Can return: SearchError NoResults Unexpected

Example

let search = keyring_search::Search::new().unwrap();
let results = search.by_user("Mr. Foo Bar");

pub fn by_service(&self, query: &str) -> CredentialSearchResult

Specifies searching by service and the query string

Can return: SearchError NoResults Unexpected

Example

let search = keyring_search::Search::new().unwrap();
let results = search.by_service("Bar inc.");