Struct SearchArg

#[non_exhaustive]
pub struct SearchArg {
    pub path: PathROrId,
    pub query: String,
    pub start: u64,
    pub max_results: u64,
    pub mode: SearchMode,
}

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: PathROrId

The path in the user’s Dropbox to search. Should probably be a folder.

query: String

The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. “bat c” matches “bat cave” but not “batman car”).

start: u64

The starting index within the search results (used for paging).

max_results: u64

The maximum number of search results to return.

mode: SearchMode

The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

Implementations

impl SearchArg

pub fn new(path: PathROrId, query: String) -> Self

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

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

pub fn with_mode(self, value: SearchMode) -> Self

Trait Implementations

impl Clone for SearchArg

fn clone(&self) -> SearchArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchArg

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

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchArg

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

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

Serialize this value into the given Serde serializer.

impl Eq for SearchArg

impl StructuralPartialEq for SearchArg