struct Meilisearch::Crystal::SearchResponse(T)

Overview

Typed search results and response metadata.

Included Modules

Defined in:

meilisearch/crystal/search.cr

Constructors

Instance Method Summary

Constructor methods inherited from struct Meilisearch::Crystal::Resource

new(pull : JSON::PullParser)
new(*, __pull_for_json_serializable pull : JSON::PullParser)
new

Macros inherited from struct Meilisearch::Crystal::Resource

define(name, &block) define, field(declaration) field, field!(declaration) field!, field?(declaration) field?

Constructor Detail

def self.new(pull : JSON::PullParser) #

Typed search results and response metadata.


[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def each(& : T -> ) : Nil #
Description copied from module Enumerable(T)

Must yield this collection's elements to the block.


[View source]
def estimated_total_hits : Int64 | Nil #

def facet_distribution : Hash(String, Hash(String, Int64)) | Nil #

def facet_stats : Hash(String, FacetStats) | Nil #

def facets_by_index : Hash(String, JSON::Any) | Nil #

def hits : Array(T) #

def hits_per_page : Int32 | Nil #

def index_uid : String | Nil #

def limit : Int32 | Nil #

def offset : Int32 | Nil #

def page : Int32 | Nil #

def processing_time : Time::Span #

[View source]
def query : String | Nil #

def total_hits : Int64 | Nil #

def total_pages : Int32 | Nil #