Struct SearchParams 

pub struct SearchParams {
    pub query: String,
    pub fields: Vec<String>,
}

Query parameters for full-text search on a collection endpoint.

query is the search string. fields optionally scopes the search to specific fields; when omitted the backend decides which fields to search.

{"query": "annual report", "fields": ["title", "description"]}

Fields

query: String

The search string. Must not exceed 500 characters.

fields: Vec<String>

Optional list of field names to scope the search to.

Implementations

impl SearchParams

pub fn new(query: impl Into<String>) -> Self

Create search params targeting all fields.

Examples

use api_bones::query::SearchParams;

let s = SearchParams::new("annual report");
assert_eq!(s.query, "annual report");
assert!(s.fields.is_empty());

pub fn try_new(query: impl Into<String>) -> Result<Self, ValidationError>

Create validated search params — enforces 1–500 char constraint without validator feature.

Examples

use api_bones::query::SearchParams;

let s = SearchParams::try_new("annual report").unwrap();
assert_eq!(s.query, "annual report");

assert!(SearchParams::try_new("").is_err());
assert!(SearchParams::try_new("a".repeat(501)).is_err());

pub fn try_with_fields( query: impl Into<String>, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Result<Self, ValidationError>

Create validated search params scoped to specific fields.

Examples

use api_bones::query::SearchParams;

let s = SearchParams::try_with_fields("report", ["title"]).unwrap();
assert_eq!(s.fields, vec!["title"]);

assert!(SearchParams::try_with_fields("", ["title"]).is_err());

pub fn with_fields( query: impl Into<String>, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Create search params scoped to specific fields.

Examples

use api_bones::query::SearchParams;

let s = SearchParams::with_fields("report", ["title", "description"]);
assert_eq!(s.query, "report");
assert_eq!(s.fields, vec!["title", "description"]);

Trait Implementations

impl Clone for SearchParams

fn clone(&self) -> SearchParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchParams

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for SearchParams

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for SearchParams

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl Eq for SearchParams

impl StructuralPartialEq for SearchParams