Skip to main content

SearchParams

Struct SearchParams 

Source
pub struct SearchParams {
    pub q: Option<String>,
    pub sort: Option<String>,
    pub per_page: Option<i32>,
    pub org_slug: Option<String>,
    pub org_type: Option<String>,
    pub keyword: Vec<String>,
    pub spatial_filter: Option<String>,
    pub spatial_geometry: Option<Value>,
    pub spatial_within: Option<bool>,
    pub after: Option<String>,
    pub slug: Option<String>,
}
Expand description

Parameters for CatalogClient::search.

Constructed with a builder: start from SearchParams::new and chain setters. All fields are optional; the server defaults apply when a field is left unset.

Fields§

§q: Option<String>

Full-text query.

§sort: Option<String>

Sort order (relevance, popularity, distance, last_harvested_date).

§per_page: Option<i32>

Results per page.

§org_slug: Option<String>

Filter by organization slug (e.g. nasa).

§org_type: Option<String>

Filter by organization type (e.g. Federal Government).

§keyword: Vec<String>

Exact-match keyword filters. Repeated on the wire.

§spatial_filter: Option<String>

geospatial or non-geospatial.

§spatial_geometry: Option<Value>

GeoJSON geometry used for bounding-box / shape queries.

§spatial_within: Option<bool>

Whether to require containment (true) vs. intersection (false).

§after: Option<String>

Opaque cursor from a previous SearchResponse::after.

§slug: Option<String>

Exact-match slug filter (single dataset lookup).

Implementations§

Source§

impl SearchParams

Source

pub fn new() -> Self

Construct empty SearchParams.

Source

pub fn q(self, q: impl Into<String>) -> Self

Set the full-text query.

Source

pub fn sort(self, sort: impl Into<String>) -> Self

Set the sort order.

Source

pub fn per_page(self, per_page: i32) -> Self

Set page size.

Source

pub fn org_slug(self, slug: impl Into<String>) -> Self

Filter by organization slug.

Source

pub fn org_type(self, org_type: impl Into<String>) -> Self

Filter by organization type.

Source

pub fn keyword(self, keyword: impl Into<String>) -> Self

Append a keyword filter (exact match).

Source

pub fn keywords<I, S>(self, keywords: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Replace the keyword list.

Source

pub fn spatial_filter(self, mode: impl Into<String>) -> Self

Set the spatial-filter mode.

Source

pub fn spatial_geometry(self, geometry: Value) -> Self

Set the GeoJSON geometry for spatial queries.

Source

pub fn spatial_within(self, within: bool) -> Self

Require containment vs. intersection for spatial matches.

Source

pub fn after(self, after: impl Into<String>) -> Self

Set the pagination cursor.

Source

pub fn slug(self, slug: impl Into<String>) -> Self

Filter to an exact slug match (single-dataset lookup).

Trait Implementations§

Source§

impl Clone for SearchParams

Source§

fn clone(&self) -> SearchParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SearchParams

Source§

fn default() -> SearchParams

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more