Struct SearchRequest 

pub struct SearchRequest {
    pub part: Option<ScopeDecl>,
    pub query: Option<String>,
    pub offer: Option<SearchOffer>,
    pub action: Option<String>,
    pub anchor: Option<Anchor>,
}

A request to open the platform search from inside an app.

Fields

part: Option<ScopeDecl>

The part of the app to search (see ScopeDecl); the whole app when absent.

query: Option<String>

Text the search field starts with, selected so typing replaces it: the argument an asked action starts from (SearchRequest::asking).

offer: Option<SearchOffer>

One of the system’s own actions the app prepares for the person: search opens on it with these arguments, and nothing runs until the person confirms it there. A host that offers no such action opens a plain search.

action: Option<String>

One of the app’s own published actions, on the resource the scope names: search opens on it, asking for its arguments, a parameter picked from the workspace on its picker. Nothing runs until the person has answered them.

anchor: Option<Anchor>

A resource of the app’s to open on, selected: the row that shows it is the one under the cursor, so pressing Enter opens it (see SearchRequest::on). A host that does not know the resource opens a plain search of the app.

Implementations

impl SearchRequest

pub fn this_app() -> SearchRequest

Search everything this app publishes.

pub fn within(scope: ScopeDecl) -> SearchRequest

Search one part of this app.

pub fn on( resource: impl Into<String>, query: impl Into<String>, ) -> SearchRequest

Open search on resource, a resource of this app’s, with query the text that finds its row: that row is under the cursor, so one Enter opens it. How an app shows the person something it has instead of describing it.

pub fn asking(scope: ScopeDecl, action: impl Into<String>) -> SearchRequest

Open search on action, a published action of the resource scope names, asking for its arguments (see SearchRequest::action): a button whose action needs what the person picks (“Link a note”) opens straight on the picker.

pub fn asked(&self) -> Option<ActionAddress>

The action this request opens search on, by its address (SearchRequest::asking).

pub fn offering<K, V>( action: impl Into<String>, arguments: impl IntoIterator<Item = (K, V)>, ) -> SearchRequest

where K: Into<String>, V: Into<String>,

Open search on the system’s action action, with arguments filled in for the person to confirm (see SearchRequest::offer).

pub fn with_query(self, query: impl Into<String>) -> SearchRequest

Start the search with query already typed.

pub fn anchored(&self) -> Option<&Anchor>

The resource this search opens on (SearchRequest::on), when the host should select it: a resource and a query both named.

pub fn part(&self) -> Option<&ScopeDecl>

pub fn arguments(&self) -> Map<String, Value>

The request as the open action’s arguments.

pub fn from_arguments(arguments: &Map<String, Value>) -> SearchRequest

The request the open action’s arguments describe. Unknown or mistyped arguments read as absent.

Trait Implementations

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl Default for SearchRequest

fn default() -> SearchRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchRequest

where SearchRequest: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SearchRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SearchRequest

impl StructuralPartialEq for SearchRequest