Struct SearchOptions 

pub struct SearchOptions {
    pub limit: Option<usize>,
    pub include_item_types: Option<Vec<String>>,
    pub search_term: Option<String>,
    pub scope: Option<SearchScope>,
}

Options for search queries

Fields

limit: Option<usize>

include_item_types: Option<Vec<String>>

search_term: Option<String>

scope: Option<SearchScope>

Opaque scope selected by the UI. When set it wins over include_item_types, which remains for the non-search get_items callers that legitimately request a single concrete type.

Implementations

impl SearchOptions

pub fn resolve_scope(&mut self)

Expand scope into include_item_types in place.

Call this once, in the search command, before dispatching to the cache and server paths — both already honour include_item_types, and resolving in one place keeps online and offline results identical.

TRACES: UR-049 | DR-063

Trait Implementations

impl Clone for SearchOptions

fn clone(&self) -> SearchOptions

Returns a duplicate 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() -> SearchOptions

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for SearchOptions

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to [Type::inline] but returns a [NamedDataType] instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a [NamedDataType] instead.

impl Serialize for SearchOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for SearchOptions

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Flatten for SearchOptions