Struct TextQueryOptions 

pub struct TextQueryOptions {
    pub text_field: Option<String>,
    pub limit: Option<usize>,
    pub offset: Option<usize>,
}

Text field and result options.

The default leaves field, limit, and offset unset. Select a text field on the request when the backend requires one; configuration does not provide a universal text-field fallback.

Examples

use storage_kit::database::query::TextQueryOptions;
let mut options = TextQueryOptions::default();
options.set_field("body");
options.set_limit(5);
assert_eq!(options.text_field.as_deref(), Some("body"));
assert_eq!(options.limit, Some(5));

Fields

text_field: Option<String>

Text field.

limit: Option<usize>

Maximum hits.

offset: Option<usize>

Hit offset.

Implementations

impl TextQueryOptions

pub fn set_field(&mut self, field: impl Into<String>)

Selects a text field.

Examples

use storage_kit::database::query::TextQueryOptions;
let mut options = TextQueryOptions::default();
options.set_field("body");
assert_eq!(options.text_field.as_deref(), Some("body"));

pub fn set_limit(&mut self, limit: usize)

Sets maximum hits.

Examples

use storage_kit::database::query::TextQueryOptions;
let mut options = TextQueryOptions::default();
options.set_limit(5);
assert_eq!(options.limit, Some(5));

pub fn set_offset(&mut self, offset: usize)

Sets hit offset.

Examples

use storage_kit::database::query::TextQueryOptions;
let mut options = TextQueryOptions::default();
options.set_offset(10);
assert_eq!(options.offset, Some(10));

Trait Implementations

impl Clone for TextQueryOptions

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 TextQueryOptions

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

Formats the value using the given formatter.

impl Default for TextQueryOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextQueryOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TextQueryOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TextQueryOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextQueryOptions