pub struct Everything;
Expand description
A wrapper around the Everything API.
Calls cleanup on drop.
Implementations§
Source§impl Everything
impl Everything
Sourcepub fn get_last_error() -> EverythingResult<()>
pub fn get_last_error() -> EverythingResult<()>
Sourcepub fn wait_db_loaded(timeout: Duration) -> EverythingResult<()>
pub fn wait_db_loaded(timeout: Duration) -> EverythingResult<()>
Sleep the current thread until the Everything database is loaded.
See https://www.voidtools.com/support/everything/sdk/everything_isdbloaded/
Sourcepub fn set_search(&self, search: &str)
pub fn set_search(&self, search: &str)
Set the query to be used by the next call to query.
See https://www.voidtools.com/support/everything/sdk/everything_setsearch/
Sourcepub fn get_search(&self) -> EverythingResult<String>
pub fn get_search(&self) -> EverythingResult<String>
Get the current query.
See https://www.voidtools.com/support/everything/sdk/everything_getsearch/
Search Syntax reference can be seen here
https://www.voidtools.com/support/everything/searching/
More search functions can be found on the forums.
https://www.voidtools.com/forum/viewtopic.php?t=10091
https://www.voidtools.com/forum/viewtopic.php?t=10176
https://www.voidtools.com/forum/viewtopic.php?t=10099
https://www.voidtools.com/forum/viewtopic.php?t=10860
Sourcepub fn set_sort(&self, sort: EverythingSort)
pub fn set_sort(&self, sort: EverythingSort)
Set the sorting to be used by the next call to query.
See https://www.voidtools.com/support/everything/sdk/everything_setsort/
Sourcepub fn get_sort(&self) -> Option<EverythingSort>
pub fn get_sort(&self) -> Option<EverythingSort>
Get the current sorting.
See https://www.voidtools.com/support/everything/sdk/everything_getsort/
Sourcepub fn is_fast_sort(&self, sort: EverythingSort) -> bool
pub fn is_fast_sort(&self, sort: EverythingSort) -> bool
Check if the sort type is indexed.
See https://www.voidtools.com/support/everything/sdk/everything_isfastsort/
Sourcepub fn is_result_file(&self, index: DWORD) -> bool
pub fn is_result_file(&self, index: DWORD) -> bool
Sourcepub fn is_result_folder(&self, index: DWORD) -> bool
pub fn is_result_folder(&self, index: DWORD) -> bool
Sourcepub fn is_result_volume(&self, index: DWORD) -> bool
pub fn is_result_volume(&self, index: DWORD) -> bool
Sourcepub fn get_num_results(&self) -> DWORD
pub fn get_num_results(&self) -> DWORD
Returns the number of visible results in everything’s memory.
Will be 0 until the first call to query.
Then will equal the number of max results specified by set_max_results.
See https://www.voidtools.com/support/everything/sdk/everything_getnumresults/
Sourcepub fn get_total_results(&self) -> DWORD
pub fn get_total_results(&self) -> DWORD
Returns the number of results returned by the query.
See https://www.voidtools.com/support/everything/sdk/everything_gettotresults/
Sourcepub fn set_max_results(&self, max_results: DWORD)
pub fn set_max_results(&self, max_results: DWORD)
Limit’s the number of results returned by the everything.
See https://www.voidtools.com/support/everything/sdk/everything_setmax/
Sourcepub fn get_max_results(&self) -> DWORD
pub fn get_max_results(&self) -> DWORD
Returns the current maximum number of results.
See https://www.voidtools.com/support/everything/sdk/everything_getmax/
Sourcepub fn set_result_offset(&self, offset_results: DWORD)
pub fn set_result_offset(&self, offset_results: DWORD)
Set the index offset that everything will start its result window from.
See https://www.voidtools.com/support/everything/sdk/everything_setoffset/
Sourcepub fn get_result_offset(&self) -> DWORD
pub fn get_result_offset(&self) -> DWORD
Returns the current result offset.
See https://www.voidtools.com/support/everything/sdk/everything_getoffset/
Sourcepub fn set_request_flags(&self, request_flags: EverythingRequestFlags)
pub fn set_request_flags(&self, request_flags: EverythingRequestFlags)
Set the type of data that the everything service will load.
See https://www.voidtools.com/support/everything/sdk/everything_setreplywindow/
Sourcepub fn get_request_flags(&self) -> EverythingRequestFlags
pub fn get_request_flags(&self) -> EverythingRequestFlags
Returns the current request flags.
See https://www.voidtools.com/support/everything/sdk/everything_getrequestflags/
pub fn query(&self) -> EverythingResult<()>
Sourcepub fn reset(&self)
pub fn reset(&self)
Reset the query state.
See https://www.voidtools.com/support/everything/sdk/everything_reset/
Sourcepub fn get_result_count(&self) -> u32
pub fn get_result_count(&self) -> u32
Returns the total number of indexes in the everything result window.
See https://www.voidtools.com/support/everything/sdk/everything_getnumfileresults/
Sourcepub fn get_result_full_path(&self, index: u32) -> EverythingResult<String>
pub fn get_result_full_path(&self, index: u32) -> EverythingResult<String>
Creates a owned string from full path slice for a result at an index.
See https://www.voidtools.com/support/everything/sdk/everything_getresultfullpathname/
Sourcepub fn full_path_iter(
&self,
) -> impl Iterator<Item = EverythingResult<String>> + '_
pub fn full_path_iter( &self, ) -> impl Iterator<Item = EverythingResult<String>> + '_
Returns an iterator over the full paths of the results.
See https://www.voidtools.com/support/everything/sdk/everything_getresultfullpathname/
Sourcepub fn get_result_file_name(&self, index: u32) -> EverythingResult<String>
pub fn get_result_file_name(&self, index: u32) -> EverythingResult<String>
Iterates from the pointer to find a null terminator returning an owned string.
See https://www.voidtools.com/support/everything/sdk/everything_getresultfilename/
Sourcepub fn name_iter(&self) -> impl Iterator<Item = EverythingResult<String>> + '_
pub fn name_iter(&self) -> impl Iterator<Item = EverythingResult<String>> + '_
Returns an iterator over the file names of the results.
See https://www.voidtools.com/support/everything/sdk/everything_getresultfilename/
Sourcepub fn get_result_created_date(&self, index: u32) -> EverythingResult<u64>
pub fn get_result_created_date(&self, index: u32) -> EverythingResult<u64>
Returns the created date of the result at the index.
See https://www.voidtools.com/support/everything/sdk/everything_getresultdatecreated/
Sourcepub fn get_result_count_modified_date(
&self,
index: u32,
) -> EverythingResult<u64>
pub fn get_result_count_modified_date( &self, index: u32, ) -> EverythingResult<u64>
Returns the modified date of the result at the index.
See https://www.voidtools.com/support/everything/sdk/everything_getresultdatemodified/
Sourcepub fn get_result_size(&self, index: u32) -> EverythingResult<u64>
pub fn get_result_size(&self, index: u32) -> EverythingResult<u64>
Returns the last accessed date of the result at the index.
See https://www.voidtools.com/support/everything/sdk/everything_getresultdateaccessed/
Sourcepub fn get_result_extension(&self, index: u32) -> EverythingResult<String>
pub fn get_result_extension(&self, index: u32) -> EverythingResult<String>
Returns the extension of the result at the index.
iterates from a string pointer to find a null terminator returning an owned string.
See https://www.voidtools.com/support/everything/sdk/everything_getresultextension/
Sourcepub fn new() -> Everything
pub fn new() -> Everything
Waits for the Everything database to be fully loaded before returning an instance.