Struct SearchOptions

#[non_exhaustive]
pub struct SearchOptions {
    pub path: Option<PathROrId>,
    pub max_results: u64,
    pub order_by: Option<SearchOrderBy>,
    pub file_status: FileStatus,
    pub filename_only: bool,
    pub file_extensions: Option<Vec<String>>,
    pub file_categories: Option<Vec<FileCategory>>,
    pub account_id: Option<AccountId>,
}

Available on crate features sync_routes and dbx_files only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: Option<PathROrId>

Scopes the search to a path in the user’s Dropbox. Searches the entire Dropbox if not specified.

max_results: u64

The maximum number of search results to return.

order_by: Option<SearchOrderBy>

Specified property of the order of search results. By default, results are sorted by relevance.

file_status: FileStatus

Restricts search to the given file status.

filename_only: bool

Restricts search to only match on filenames.

file_extensions: Option<Vec<String>>

Restricts search to only the extensions specified. Only supported for active file search.

file_categories: Option<Vec<FileCategory>>

Restricts search to only the file categories specified. Only supported for active file search.

account_id: Option<AccountId>

Restricts results to the given account id.

Implementations

impl SearchOptions

pub fn with_path(self, value: PathROrId) -> Self

pub fn with_max_results(self, value: u64) -> Self

pub fn with_order_by(self, value: SearchOrderBy) -> Self

pub fn with_file_status(self, value: FileStatus) -> Self

pub fn with_filename_only(self, value: bool) -> Self

pub fn with_file_extensions(self, value: Vec<String>) -> Self

pub fn with_file_categories(self, value: Vec<FileCategory>) -> Self

pub fn with_account_id(self, value: AccountId) -> Self

Trait Implementations

impl Clone for SearchOptions

fn clone(&self) -> SearchOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchOptions

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

Formats the value using the given formatter.

impl Default for SearchOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchOptions

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchOptions

fn eq(&self, other: &SearchOptions) -> 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 Serialize for SearchOptions

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for SearchOptions

impl StructuralPartialEq for SearchOptions