Struct LookupQuery 

pub struct LookupQuery {
    pub text: String,
    pub scope: LookupScope,
    pub within: Option<LookupWithin>,
    pub locale: Option<String>,
    pub limit: usize,
}

A lookup request.

Fields

text: String

The name or guess to resolve: an OPY spelling, a canonical Workshop id, a Workshop display name, or a settings path prefix. Empty text applies no text constraint and lists the in-scope entries instead of scoring them.

scope: LookupScope

The namespaces the query searches; LookupScope::ALL is the default. within selects its own namespace when set.

within: Option<LookupWithin>

Restricts the answer to the children of one named scope instead of searching every candidate in scope.

locale: Option<String>

The display-name locale to read; only en-US is supported. Localized display names remain workshop-rs-owned and are answered as LookupOutcome::Unsupported, not silently returned in English.

limit: usize

The maximum number of returned hits; 0 selects DEFAULT_LIMIT.

Implementations

impl LookupQuery

pub fn new(text: impl Into<String>) -> LookupQuery

A query across every namespace.

Trait Implementations

impl Clone for LookupQuery

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LookupQuery

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

Formats the value using the given formatter.

impl PartialEq for LookupQuery

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LookupQuery