Struct GrepRequest 

pub struct GrepRequest {
    pub pattern: String,
    pub case_insensitive: bool,
    pub path_prefix: Option<AbsolutePath>,
    pub cursor: Option<String>,
    pub limit: Option<u32>,
    pub allow_stale: bool,
    pub allow_scan: bool,
}

One content-search request.

Fields

pattern: String

The pattern, in the Rust regex crate’s dialect (no backreferences or lookaround). Patterns that require no literal bytes are rejected with query_unindexable unless allow_scan is set.

case_insensitive: bool

Match case-insensitively. Verification is exact; the index remains consulted through its case-folded grams.

path_prefix: Option<AbsolutePath>

Restrict matches to files under this complete absolute path, resolved to a directory inode before candidates are filtered.

cursor: Option<String>

Resume cursor from a previous page. The cursor resumes strictly after the last candidate the issuing page finished scanning and is bound to that page’s request; each page is evaluated against the namespace head at page time.

limit: Option<u32>

Maximum matches per page.

allow_stale: bool

When the unindexed tail exceeds the scan budget, return indexed-only results (reported via tail_scanned: false) instead of failing with index_lagging.

allow_scan: bool

Permit a capped exhaustive scan when the pattern yields no required grams. Refused beyond the server’s scan budget.

Implementations

impl GrepRequest

pub fn fingerprint(&self) -> u64

Fingerprint of the fields that select results, binding cursors to the request that issued them. Not a durable format: cursors are opaque and short-lived, so this may change between builds.

Trait Implementations

impl Clone for GrepRequest

fn clone(&self) -> GrepRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GrepRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GrepRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GrepRequest

impl PartialEq for GrepRequest

fn eq(&self, other: &GrepRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for GrepRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GrepRequest