abstract struct Meilisearch::Crystal::Resource

• Meilisearch::Crystal::Resource
• Struct
• Value
• Object

Overview

Base value type for stable Meilisearch response schemas.

Included Modules

• JSON::Serializable

Direct Known Subclasses

• Meilisearch::Crystal::Batch
• Meilisearch::Crystal::Embedder
• Meilisearch::Crystal::ExperimentalFeatures
• Meilisearch::Crystal::FacetHit
• Meilisearch::Crystal::Faceting
• Meilisearch::Crystal::FacetSearchRequest
• Meilisearch::Crystal::FacetSearchResponse
• Meilisearch::Crystal::FacetStats
• Meilisearch::Crystal::FederationOptions
• Meilisearch::Crystal::Health
• Meilisearch::Crystal::Hybrid
• Meilisearch::Crystal::Index
• Meilisearch::Crystal::Index::Settings
• Meilisearch::Crystal::Index::Stats
• Meilisearch::Crystal::Key
• Meilisearch::Crystal::List(T)
• Meilisearch::Crystal::LocalizedAttribute
• Meilisearch::Crystal::MultiSearch::Federation
• Meilisearch::Crystal::MultiSearch::FederationMetadata
• Meilisearch::Crystal::MultiSearch::Response(T)
• Meilisearch::Crystal::NetworkConfig
• Meilisearch::Crystal::Pagination
• Meilisearch::Crystal::Query
• Meilisearch::Crystal::SearchResponse(T)
• Meilisearch::Crystal::Settings
• Meilisearch::Crystal::Stats
• Meilisearch::Crystal::Task::CountDetails
• Meilisearch::Crystal::Task::DocumentDetails
• Meilisearch::Crystal::Task::DumpDetails
• Meilisearch::Crystal::Task::IndexDetails
• Meilisearch::Crystal::Task::SettingsDetails
• Meilisearch::Crystal::Task::SwapDetails
• Meilisearch::Crystal::TypoTolerance
• Meilisearch::Crystal::TypoWordSize
• Meilisearch::Crystal::Version

Defined in:

meilisearch/crystal/resource.cr

Constructors

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

Macro Summary

• define(name, &block)

  Declares a named resource without repeating the base type and JSON mixin.

• field(declaration)

  Defines a required JSON field and maps snake_case Crystal names to the lower-camel-case keys used by Meilisearch.

• field!(declaration)

  Defines a field that may be absent in JSON but exposes a non-nil bang accessor.

• field?(declaration)

  Defines a boolean JSON field with an idiomatic predicate getter.

Constructor Detail

Macro Detail