Struct SearchRequest 

pub struct SearchRequest {
    pub query: Option<String>,
    pub neural: bool,
    pub mime: Option<StringMime>,
    pub include_name: bool,
    pub include_content: bool,
    pub created_at: Option<SearchRange>,
    pub created_by: Option<String>,
    pub folder_id: Option<Uuid>,
    pub size: Option<u16>,
    pub offset: Option<u64>,
    pub max_pages: Option<u16>,
    pub pages_offset: Option<u64>,
}

Request to search within a document box

Fields

query: Option<String>

The search query

neural: bool

Enable searching with AI

mime: Option<StringMime>

Search only include a specific mime type

include_name: bool

Whether to include document names

include_content: bool

Whether to include document content

created_at: Option<SearchRange>

Creation date range search

created_by: Option<String>

Search by a created user

folder_id: Option<Uuid>

Enforce search to a specific folder, empty for all folders

size: Option<u16>

Number of items to include in the response

offset: Option<u64>

Offset to start results from

max_pages: Option<u16>

Maximum number of pages too return per file

pages_offset: Option<u64>

Offset to start at when aggregating page results

Trait Implementations

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 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 ToSchema for SearchRequest

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Validate for SearchRequest

type Context = ()

A user-provided context.

fn validate_into( &self, __garde_user_ctx: &<SearchRequest as Validate>::Context, __garde_path: &mut dyn FnMut() -> Path, __garde_report: &mut Report, )

Validates Self, aggregating all validation errors into Report.

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

where Self::Context: Default,

Validates Self, returning an Err with an aggregate of all errors if the validation failed.

fn validate_with(&self, ctx: &Self::Context) -> Result<(), Report>

Validates Self, returning an Err with an aggregate of all errors if the validation failed.