Struct SearchInput 

pub struct SearchInput {
    pub query: String,
    pub community: Option<String>,
    pub mode: Option<SearchMode>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
}

Input for searching posts

Fields

query: String

What to look for: words for a keyword search, or a description of the topic for a semantic one

community: Option<String>

A community name to search within; leave it out to search them all

mode: Option<SearchMode>

keyword (the default, always available) matches the words; semantic finds posts about the same thing even when they use other words, and falls back to keyword (see degraded on the result) when the server’s embedding backend is unavailable

limit: Option<u32>

Max results (default 25, at most 100)

offset: Option<u32>

Results to skip, for paging (default 0)

Implementations

impl SearchInput

pub const DEFAULT_LIMIT: u32 = 25

The server’s default page size

pub const MAX_LIMIT: u32 = 100

The server’s largest page

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

A keyword search for query, every other option left to the server

Trait Implementations

impl Clone for SearchInput

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 SearchInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SearchInput

impl PartialEq for SearchInput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SearchInput

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 SearchInput