opt

package
v3.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 9, 2020 License: MIT Imports: 8 Imported by: 37

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AdvancedEqual 

func AdvancedEqual(o1, o2 *AdvancedOption) bool

AdvancedEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AdvancedSyntaxEqual 

func AdvancedSyntaxEqual(o1, o2 *AdvancedSyntaxOption) bool

AdvancedSyntaxEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AdvancedSyntaxFeaturesEqual 

func AdvancedSyntaxFeaturesEqual(o1, o2 *AdvancedSyntaxFeaturesOption) bool

AdvancedSyntaxFeaturesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AllowCompressionOfIntegerArrayEqual 

func AllowCompressionOfIntegerArrayEqual(o1, o2 *AllowCompressionOfIntegerArrayOption) bool

AllowCompressionOfIntegerArrayEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AllowTyposOnNumericTokensEqual 

func AllowTyposOnNumericTokensEqual(o1, o2 *AllowTyposOnNumericTokensOption) bool

AllowTyposOnNumericTokensEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AlternativesAsExactEqual 

func AlternativesAsExactEqual(o1, o2 *AlternativesAsExactOption) bool

AlternativesAsExactEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AnalyticsEqual 

func AnalyticsEqual(o1, o2 *AnalyticsOption) bool

AnalyticsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AnalyticsTagsEqual 

func AnalyticsTagsEqual(o1, o2 *AnalyticsTagsOption) bool

AnalyticsTagsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AnchoringEqual 

func AnchoringEqual(o1, o2 *AnchoringOption) bool

AnchoringEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AroundLatLngEqual 

func AroundLatLngEqual(o1, o2 *AroundLatLngOption) bool

AroundLatLngEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AroundLatLngViaIPEqual 

func AroundLatLngViaIPEqual(o1, o2 *AroundLatLngViaIPOption) bool

AroundLatLngViaIPEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AroundPrecisionEqual 

func AroundPrecisionEqual(o1, o2 *AroundPrecisionOption) bool

AroundPrecisionEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AroundRadiusEqual 

func AroundRadiusEqual(o1, o2 *AroundRadiusOption) bool

AroundRadiusEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AttributeCriteriaComputedByMinProximityEqual 

func AttributeCriteriaComputedByMinProximityEqual(o1, o2 *AttributeCriteriaComputedByMinProximityOption) bool

AttributeCriteriaComputedByMinProximityEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AttributeForDistinctEqual 

func AttributeForDistinctEqual(o1, o2 *AttributeForDistinctOption) bool

AttributeForDistinctEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AttributesForFacetingEqual 

func AttributesForFacetingEqual(o1, o2 *AttributesForFacetingOption) bool

AttributesForFacetingEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AttributesToHighlightEqual 

func AttributesToHighlightEqual(o1, o2 *AttributesToHighlightOption) bool

AttributesToHighlightEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AttributesToRetrieveEqual 

func AttributesToRetrieveEqual(o1, o2 *AttributesToRetrieveOption) bool

AttributesToRetrieveEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AttributesToSnippetEqual 

func AttributesToSnippetEqual(o1, o2 *AttributesToSnippetOption) bool

AttributesToSnippetEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func AutoGenerateObjectIDIfNotExistEqual 

func AutoGenerateObjectIDIfNotExistEqual(o1, o2 *AutoGenerateObjectIDIfNotExistOption) bool

AutoGenerateObjectIDIfNotExistEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func CamelCaseAttributesEqual 

func CamelCaseAttributesEqual(o1, o2 *CamelCaseAttributesOption) bool

CamelCaseAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ClearExistingRulesEqual 

func ClearExistingRulesEqual(o1, o2 *ClearExistingRulesOption) bool

ClearExistingRulesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ClickAnalyticsEqual 

func ClickAnalyticsEqual(o1, o2 *ClickAnalyticsOption) bool

ClickAnalyticsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ClusterEqual added in v3.5.0 

func ClusterEqual(o1, o2 *ClusterOption) bool

ClusterEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func CreateIfNotExistsEqual 

func CreateIfNotExistsEqual(o1, o2 *CreateIfNotExistsOption) bool

CreateIfNotExistsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func CustomNormalizationEqual added in v3.5.0 

func CustomNormalizationEqual(o1, o2 *CustomNormalizationOption) bool

CustomNormalizationEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func CustomRankingEqual 

func CustomRankingEqual(o1, o2 *CustomRankingOption) bool

CustomRankingEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func DecompoundedAttributesEqual 

func DecompoundedAttributesEqual(o1, o2 *DecompoundedAttributesOption) bool

DecompoundedAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func DisableExactOnAttributesEqual 

func DisableExactOnAttributesEqual(o1, o2 *DisableExactOnAttributesOption) bool

DisableExactOnAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func DisablePrefixOnAttributesEqual 

func DisablePrefixOnAttributesEqual(o1, o2 *DisablePrefixOnAttributesOption) bool

DisablePrefixOnAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func DisableTypoToleranceOnAttributesEqual 

func DisableTypoToleranceOnAttributesEqual(o1, o2 *DisableTypoToleranceOnAttributesOption) bool

DisableTypoToleranceOnAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func DisableTypoToleranceOnWordsEqual 

func DisableTypoToleranceOnWordsEqual(o1, o2 *DisableTypoToleranceOnWordsOption) bool

DisableTypoToleranceOnWordsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func DistinctEqual 

func DistinctEqual(o1, o2 *DistinctOption) bool

DistinctEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func EnableABTestEqual added in v3.5.0 

func EnableABTestEqual(o1, o2 *EnableABTestOption) bool

EnableABTestEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func EnablePersonalizationEqual 

func EnablePersonalizationEqual(o1, o2 *EnablePersonalizationOption) bool

EnablePersonalizationEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func EnableRulesEqual 

func EnableRulesEqual(o1, o2 *EnableRulesOption) bool

EnableRulesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func EnabledEqual 

func EnabledEqual(o1, o2 *EnabledOption) bool

EnabledEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ExactOnSingleWordQueryEqual 

func ExactOnSingleWordQueryEqual(o1, o2 *ExactOnSingleWordQueryOption) bool

ExactOnSingleWordQueryEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ExplainEqual 

func ExplainEqual(o1, o2 *ExplainOption) bool

ExplainEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ExtraHeadersEqual 

func ExtraHeadersEqual(o1, o2 *ExtraHeadersOption) bool

ExtraHeadersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ExtraOptionsEqual 

func ExtraOptionsEqual(o1, o2 *ExtraOptionsOption) bool

ExtraOptionsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ExtraURLParamsEqual 

func ExtraURLParamsEqual(o1, o2 *ExtraURLParamsOption) bool

ExtraURLParamsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func FacetFiltersEqual 

func FacetFiltersEqual(o1, o2 *FacetFiltersOption) bool

FacetFiltersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func FacetingAfterDistinctEqual 

func FacetingAfterDistinctEqual(o1, o2 *FacetingAfterDistinctOption) bool

FacetingAfterDistinctEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func FacetsEqual 

func FacetsEqual(o1, o2 *FacetsOption) bool

FacetsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func FilterPromotesEqual added in v3.5.0 

func FilterPromotesEqual(o1, o2 *FilterPromotesOption) bool

FilterPromotesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func FiltersEqual 

func FiltersEqual(o1, o2 *FiltersOption) bool

FiltersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ForwardToReplicasEqual 

func ForwardToReplicasEqual(o1, o2 *ForwardToReplicasOption) bool

ForwardToReplicasEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func GetRankingInfoEqual 

func GetRankingInfoEqual(o1, o2 *GetRankingInfoOption) bool

GetRankingInfoEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func HighlightPostTagEqual 

func HighlightPostTagEqual(o1, o2 *HighlightPostTagOption) bool

HighlightPostTagEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func HighlightPreTagEqual 

func HighlightPreTagEqual(o1, o2 *HighlightPreTagOption) bool

HighlightPreTagEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func HitsPerPageEqual 

func HitsPerPageEqual(o1, o2 *HitsPerPageOption) bool

HitsPerPageEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func IgnorePluralsEqual 

func IgnorePluralsEqual(o1, o2 *IgnorePluralsOption) bool

IgnorePluralsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func IndexLanguagesEqual 

func IndexLanguagesEqual(o1, o2 *IndexLanguagesOption) bool

IndexLanguagesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func IndexNameEqual 

func IndexNameEqual(o1, o2 *IndexNameOption) bool

IndexNameEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func InsertExtraHeader 

func InsertExtraHeader(opts []interface{}, k string, v interface{}) []interface{}

InsertExtraHeader inserts a new opt.ExtraHeaders into the given slice and returns this new slice (original slice is left unchanged).

func InsertExtraURLParam 

func InsertExtraURLParam(opts []interface{}, k string, v interface{}) []interface{}

InsertExtraURLParam inserts a new opt.ExtraURLParams into the given slice and returns this new slice (original slice is left unchanged).

func InsertOrReplaceOption 

func InsertOrReplaceOption(opts []interface{}, opt interface{}) []interface{}

InsertOrReplaceOption inserts the given opt option into the given slice of options and return this new slice (original slice is left unchanged). If the option already existed in the original slice, it is replaced in the returned one.

func InsideBoundingBoxEqual 

func InsideBoundingBoxEqual(o1, o2 *InsideBoundingBoxOption) bool

InsideBoundingBoxEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func InsidePolygonEqual 

func InsidePolygonEqual(o1, o2 *InsidePolygonOption) bool

InsidePolygonEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func KeepDiacriticsOnCharactersEqual 

func KeepDiacriticsOnCharactersEqual(o1, o2 *KeepDiacriticsOnCharactersOption) bool

KeepDiacriticsOnCharactersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func LengthEqual 

func LengthEqual(o1, o2 *LengthOption) bool

LengthEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func LimitEqual 

func LimitEqual(o1, o2 *LimitOption) bool

LimitEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func MaxFacetHitsEqual 

func MaxFacetHitsEqual(o1, o2 *MaxFacetHitsOption) bool

MaxFacetHitsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func MaxValuesPerFacetEqual 

func MaxValuesPerFacetEqual(o1, o2 *MaxValuesPerFacetOption) bool

MaxValuesPerFacetEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func MinProximityEqual 

func MinProximityEqual(o1, o2 *MinProximityOption) bool

MinProximityEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func MinWordSizefor1TypoEqual 

func MinWordSizefor1TypoEqual(o1, o2 *MinWordSizefor1TypoOption) bool

MinWordSizefor1TypoEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func MinWordSizefor2TyposEqual 

func MinWordSizefor2TyposEqual(o1, o2 *MinWordSizefor2TyposOption) bool

MinWordSizefor2TyposEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func MinimumAroundRadiusEqual 

func MinimumAroundRadiusEqual(o1, o2 *MinimumAroundRadiusOption) bool

MinimumAroundRadiusEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func NumericAttributesForFilteringEqual 

func NumericAttributesForFilteringEqual(o1, o2 *NumericAttributesForFilteringOption) bool

NumericAttributesForFilteringEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func NumericFiltersEqual 

func NumericFiltersEqual(o1, o2 *NumericFiltersOption) bool

NumericFiltersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func OffsetEqual 

func OffsetEqual(o1, o2 *OffsetOption) bool

OffsetEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func OptionalFiltersEqual 

func OptionalFiltersEqual(o1, o2 *OptionalFiltersOption) bool

OptionalFiltersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func OptionalWordsEqual 

func OptionalWordsEqual(o1, o2 *OptionalWordsOption) bool

OptionalWordsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func PageEqual 

func PageEqual(o1, o2 *PageOption) bool

PageEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func PaginationLimitedToEqual 

func PaginationLimitedToEqual(o1, o2 *PaginationLimitedToOption) bool

PaginationLimitedToEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func PercentileComputationEqual 

func PercentileComputationEqual(o1, o2 *PercentileComputationOption) bool

PercentileComputationEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func PersonalizationImpactEqual 

func PersonalizationImpactEqual(o1, o2 *PersonalizationImpactOption) bool

PersonalizationImpactEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func PrimaryEqual 

func PrimaryEqual(o1, o2 *PrimaryOption) bool

PrimaryEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func QueryEqual 

func QueryEqual(o1, o2 *QueryOption) bool

QueryEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func QueryLanguagesEqual 

func QueryLanguagesEqual(o1, o2 *QueryLanguagesOption) bool

QueryLanguagesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func QueryTypeEqual 

func QueryTypeEqual(o1, o2 *QueryTypeOption) bool

QueryTypeEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RankingEqual 

func RankingEqual(o1, o2 *RankingOption) bool

RankingEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ReferersEqual 

func ReferersEqual(o1, o2 *ReferersOption) bool

ReferersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RemoveStopWordsEqual 

func RemoveStopWordsEqual(o1, o2 *RemoveStopWordsOption) bool

RemoveStopWordsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RemoveWordsIfNoResultsEqual 

func RemoveWordsIfNoResultsEqual(o1, o2 *RemoveWordsIfNoResultsOption) bool

RemoveWordsIfNoResultsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ReplaceExistingSynonymsEqual 

func ReplaceExistingSynonymsEqual(o1, o2 *ReplaceExistingSynonymsOption) bool

ReplaceExistingSynonymsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ReplaceSynonymsInHighlightEqual 

func ReplaceSynonymsInHighlightEqual(o1, o2 *ReplaceSynonymsInHighlightOption) bool

ReplaceSynonymsInHighlightEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ReplicasEqual 

func ReplicasEqual(o1, o2 *ReplicasOption) bool

ReplicasEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ResponseFieldsEqual 

func ResponseFieldsEqual(o1, o2 *ResponseFieldsOption) bool

ResponseFieldsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RestrictHighlightAndSnippetArraysEqual 

func RestrictHighlightAndSnippetArraysEqual(o1, o2 *RestrictHighlightAndSnippetArraysOption) bool

RestrictHighlightAndSnippetArraysEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RestrictIndicesEqual 

func RestrictIndicesEqual(o1, o2 *RestrictIndicesOption) bool

RestrictIndicesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RestrictSearchableAttributesEqual 

func RestrictSearchableAttributesEqual(o1, o2 *RestrictSearchableAttributesOption) bool

RestrictSearchableAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RestrictSourcesEqual 

func RestrictSourcesEqual(o1, o2 *RestrictSourcesOption) bool

RestrictSourcesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RetrieveMappingsEqual added in v3.6.0 

func RetrieveMappingsEqual(o1, o2 *RetrieveMappingsOption) bool

RetrieveMappingsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func RuleContextsEqual 

func RuleContextsEqual(o1, o2 *RuleContextsOption) bool

RuleContextsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SafeEqual 

func SafeEqual(o1, o2 *SafeOption) bool

SafeEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ScopesEqual 

func ScopesEqual(o1, o2 *ScopesOption) bool

ScopesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SearchableAttributesEqual 

func SearchableAttributesEqual(o1, o2 *SearchableAttributesOption) bool

SearchableAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SeparatorsToIndexEqual 

func SeparatorsToIndexEqual(o1, o2 *SeparatorsToIndexOption) bool

SeparatorsToIndexEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SimilarQueryEqual 

func SimilarQueryEqual(o1, o2 *SimilarQueryOption) bool

SimilarQueryEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SnippetEllipsisTextEqual 

func SnippetEllipsisTextEqual(o1, o2 *SnippetEllipsisTextOption) bool

SnippetEllipsisTextEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SortFacetValuesByEqual 

func SortFacetValuesByEqual(o1, o2 *SortFacetValuesByOption) bool

SortFacetValuesByEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SumOrFiltersScoresEqual 

func SumOrFiltersScoresEqual(o1, o2 *SumOrFiltersScoresOption) bool

SumOrFiltersScoresEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func SynonymsEqual 

func SynonymsEqual(o1, o2 *SynonymsOption) bool

SynonymsEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func TagFiltersEqual 

func TagFiltersEqual(o1, o2 *TagFiltersOption) bool

TagFiltersEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func TypeEqual 

func TypeEqual(o1, o2 *TypeOption) bool

TypeEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func TypoToleranceEqual 

func TypoToleranceEqual(o1, o2 *TypoToleranceOption) bool

TypoToleranceEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func UnretrievableAttributesEqual 

func UnretrievableAttributesEqual(o1, o2 *UnretrievableAttributesOption) bool

UnretrievableAttributesEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func UserDataEqual 

func UserDataEqual(o1, o2 *UserDataOption) bool

UserDataEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func UserTokenEqual 

func UserTokenEqual(o1, o2 *UserTokenOption) bool

UserTokenEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

func ValidUntilEqual 

func ValidUntilEqual(o1, o2 *ValidUntilOption) bool

ValidUntilEqual returns true if the two options are equal. In case of one option being nil, the value of the other must be nil as well or be set to the default value of this option.

Types

type AdvancedOption 

type AdvancedOption struct {
	// contains filtered or unexported fields
}

AdvancedOption is a wrapper for an Advanced option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Advanced 

func Advanced(v int) *AdvancedOption

Advanced wraps the given value into a AdvancedOption.

func (*AdvancedOption) Equal 

func (o *AdvancedOption) Equal(o2 *AdvancedOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AdvancedOption) Get 

func (o *AdvancedOption) Get() int

Get retrieves the actual value of the option parameter.

func (AdvancedOption) MarshalJSON 

func (o AdvancedOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AdvancedOption.

func (*AdvancedOption) UnmarshalJSON 

func (o *AdvancedOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AdvancedOption.

type AdvancedSyntaxFeaturesOption 

type AdvancedSyntaxFeaturesOption struct {
	// contains filtered or unexported fields
}

AdvancedSyntaxFeaturesOption is a wrapper for an AdvancedSyntaxFeatures option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AdvancedSyntaxFeatures 

func AdvancedSyntaxFeatures(v ...string) *AdvancedSyntaxFeaturesOption

AdvancedSyntaxFeatures wraps the given value into a AdvancedSyntaxFeaturesOption.

func (*AdvancedSyntaxFeaturesOption) Equal 

func (o *AdvancedSyntaxFeaturesOption) Equal(o2 *AdvancedSyntaxFeaturesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AdvancedSyntaxFeaturesOption) Get 

func (o *AdvancedSyntaxFeaturesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AdvancedSyntaxFeaturesOption) MarshalJSON 

func (o AdvancedSyntaxFeaturesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AdvancedSyntaxFeaturesOption.

func (*AdvancedSyntaxFeaturesOption) UnmarshalJSON 

func (o *AdvancedSyntaxFeaturesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AdvancedSyntaxFeaturesOption.

type AdvancedSyntaxOption 

type AdvancedSyntaxOption struct {
	// contains filtered or unexported fields
}

AdvancedSyntaxOption is a wrapper for an AdvancedSyntax option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AdvancedSyntax 

func AdvancedSyntax(v bool) *AdvancedSyntaxOption

AdvancedSyntax wraps the given value into a AdvancedSyntaxOption.

func (*AdvancedSyntaxOption) Equal 

func (o *AdvancedSyntaxOption) Equal(o2 *AdvancedSyntaxOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AdvancedSyntaxOption) Get 

func (o *AdvancedSyntaxOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AdvancedSyntaxOption) MarshalJSON 

func (o AdvancedSyntaxOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AdvancedSyntaxOption.

func (*AdvancedSyntaxOption) UnmarshalJSON 

func (o *AdvancedSyntaxOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AdvancedSyntaxOption.

type AllowCompressionOfIntegerArrayOption 

type AllowCompressionOfIntegerArrayOption struct {
	// contains filtered or unexported fields
}

AllowCompressionOfIntegerArrayOption is a wrapper for an AllowCompressionOfIntegerArray option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AllowCompressionOfIntegerArray 

func AllowCompressionOfIntegerArray(v bool) *AllowCompressionOfIntegerArrayOption

AllowCompressionOfIntegerArray wraps the given value into a AllowCompressionOfIntegerArrayOption.

func (*AllowCompressionOfIntegerArrayOption) Equal 

func (o *AllowCompressionOfIntegerArrayOption) Equal(o2 *AllowCompressionOfIntegerArrayOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AllowCompressionOfIntegerArrayOption) Get 

func (o *AllowCompressionOfIntegerArrayOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AllowCompressionOfIntegerArrayOption) MarshalJSON 

func (o AllowCompressionOfIntegerArrayOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AllowCompressionOfIntegerArrayOption.

func (*AllowCompressionOfIntegerArrayOption) UnmarshalJSON 

func (o *AllowCompressionOfIntegerArrayOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AllowCompressionOfIntegerArrayOption.

type AllowTyposOnNumericTokensOption 

type AllowTyposOnNumericTokensOption struct {
	// contains filtered or unexported fields
}

AllowTyposOnNumericTokensOption is a wrapper for an AllowTyposOnNumericTokens option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AllowTyposOnNumericTokens 

func AllowTyposOnNumericTokens(v bool) *AllowTyposOnNumericTokensOption

AllowTyposOnNumericTokens wraps the given value into a AllowTyposOnNumericTokensOption.

func (*AllowTyposOnNumericTokensOption) Equal 

func (o *AllowTyposOnNumericTokensOption) Equal(o2 *AllowTyposOnNumericTokensOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AllowTyposOnNumericTokensOption) Get 

func (o *AllowTyposOnNumericTokensOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AllowTyposOnNumericTokensOption) MarshalJSON 

func (o AllowTyposOnNumericTokensOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AllowTyposOnNumericTokensOption.

func (*AllowTyposOnNumericTokensOption) UnmarshalJSON 

func (o *AllowTyposOnNumericTokensOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AllowTyposOnNumericTokensOption.

type AlternativesAsExactOption 

type AlternativesAsExactOption struct {
	// contains filtered or unexported fields
}

AlternativesAsExactOption is a wrapper for an AlternativesAsExact option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AlternativesAsExact 

func AlternativesAsExact(v ...string) *AlternativesAsExactOption

AlternativesAsExact wraps the given value into a AlternativesAsExactOption.

func (*AlternativesAsExactOption) Equal 

func (o *AlternativesAsExactOption) Equal(o2 *AlternativesAsExactOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AlternativesAsExactOption) Get 

func (o *AlternativesAsExactOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AlternativesAsExactOption) MarshalJSON 

func (o AlternativesAsExactOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AlternativesAsExactOption.

func (*AlternativesAsExactOption) UnmarshalJSON 

func (o *AlternativesAsExactOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AlternativesAsExactOption.

type AnalyticsOption 

type AnalyticsOption struct {
	// contains filtered or unexported fields
}

AnalyticsOption is a wrapper for an Analytics option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Analytics 

func Analytics(v bool) *AnalyticsOption

Analytics wraps the given value into a AnalyticsOption.

func (*AnalyticsOption) Equal 

func (o *AnalyticsOption) Equal(o2 *AnalyticsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AnalyticsOption) Get 

func (o *AnalyticsOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AnalyticsOption) MarshalJSON 

func (o AnalyticsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AnalyticsOption.

func (*AnalyticsOption) UnmarshalJSON 

func (o *AnalyticsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AnalyticsOption.

type AnalyticsTagsOption 

type AnalyticsTagsOption struct {
	// contains filtered or unexported fields
}

AnalyticsTagsOption is a wrapper for an AnalyticsTags option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AnalyticsTags 

func AnalyticsTags(v ...string) *AnalyticsTagsOption

AnalyticsTags wraps the given value into a AnalyticsTagsOption.

func (*AnalyticsTagsOption) Equal 

func (o *AnalyticsTagsOption) Equal(o2 *AnalyticsTagsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AnalyticsTagsOption) Get 

func (o *AnalyticsTagsOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AnalyticsTagsOption) MarshalJSON 

func (o AnalyticsTagsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AnalyticsTagsOption.

func (*AnalyticsTagsOption) UnmarshalJSON 

func (o *AnalyticsTagsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AnalyticsTagsOption.

type AnchoringOption 

type AnchoringOption struct {
	// contains filtered or unexported fields
}

AnchoringOption is a wrapper for an Anchoring option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Anchoring 

func Anchoring(v string) *AnchoringOption

Anchoring wraps the given value into a AnchoringOption.

func (*AnchoringOption) Equal 

func (o *AnchoringOption) Equal(o2 *AnchoringOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AnchoringOption) Get 

func (o *AnchoringOption) Get() string

Get retrieves the actual value of the option parameter.

func (AnchoringOption) MarshalJSON 

func (o AnchoringOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AnchoringOption.

func (*AnchoringOption) UnmarshalJSON 

func (o *AnchoringOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AnchoringOption.

type AroundLatLngOption 

type AroundLatLngOption struct {
	// contains filtered or unexported fields
}

AroundLatLngOption is a wrapper for an AroundLatLng option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AroundLatLng 

func AroundLatLng(v string) *AroundLatLngOption

AroundLatLng wraps the given value into a AroundLatLngOption.

func (*AroundLatLngOption) Equal 

func (o *AroundLatLngOption) Equal(o2 *AroundLatLngOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AroundLatLngOption) Get 

func (o *AroundLatLngOption) Get() string

Get retrieves the actual value of the option parameter.

func (AroundLatLngOption) MarshalJSON 

func (o AroundLatLngOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AroundLatLngOption.

func (*AroundLatLngOption) UnmarshalJSON 

func (o *AroundLatLngOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AroundLatLngOption.

type AroundLatLngViaIPOption 

type AroundLatLngViaIPOption struct {
	// contains filtered or unexported fields
}

AroundLatLngViaIPOption is a wrapper for an AroundLatLngViaIP option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AroundLatLngViaIP 

func AroundLatLngViaIP(v bool) *AroundLatLngViaIPOption

AroundLatLngViaIP wraps the given value into a AroundLatLngViaIPOption.

func (*AroundLatLngViaIPOption) Equal 

func (o *AroundLatLngViaIPOption) Equal(o2 *AroundLatLngViaIPOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AroundLatLngViaIPOption) Get 

func (o *AroundLatLngViaIPOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AroundLatLngViaIPOption) MarshalJSON 

func (o AroundLatLngViaIPOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AroundLatLngViaIPOption.

func (*AroundLatLngViaIPOption) UnmarshalJSON 

func (o *AroundLatLngViaIPOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AroundLatLngViaIPOption.

type AroundPrecisionOption 

type AroundPrecisionOption struct {
	// contains filtered or unexported fields
}

AroundPrecisionOption is a wrapper for an AroundPrecision option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AroundPrecision 

func AroundPrecision(ranges ...AroundPrecisionRange) *AroundPrecisionOption

func (*AroundPrecisionOption) Equal 

func (o *AroundPrecisionOption) Equal(o2 *AroundPrecisionOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AroundPrecisionOption) Get 

func (o *AroundPrecisionOption) Get() (int, []AroundPrecisionRange)

Get retrieves the actual value of the option parameter.

func (AroundPrecisionOption) MarshalJSON 

func (o AroundPrecisionOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AroundPrecisionOption.

func (*AroundPrecisionOption) UnmarshalJSON 

func (o *AroundPrecisionOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AroundPrecisionOption.

type AroundPrecisionRange 

type AroundPrecisionRange struct {
	From  int `json:"from"`
	Value int `json:"value"`
}

type AroundRadiusOption 

type AroundRadiusOption struct {
	// contains filtered or unexported fields
}

AroundRadiusOption is a wrapper for an AroundRadius option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AroundRadius 

func AroundRadius(meters int) *AroundRadiusOption

AroundRadius wraps the given value into an AroundRadiusOption.

func AroundRadiusAll 

func AroundRadiusAll() *AroundRadiusOption

AroundRadiusAll returns an AroundRadiusOption whose value is set to "all".

func (*AroundRadiusOption) Equal 

func (o *AroundRadiusOption) Equal(o2 *AroundRadiusOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AroundRadiusOption) Get 

func (o *AroundRadiusOption) Get() (int, string)

Get retrieves the actual value of the option parameter.

func (AroundRadiusOption) MarshalJSON 

func (o AroundRadiusOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AroundRadiusOption.

func (*AroundRadiusOption) UnmarshalJSON 

func (o *AroundRadiusOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AroundRadiusOption.

type AttributeCriteriaComputedByMinProximityOption 

type AttributeCriteriaComputedByMinProximityOption struct {
	// contains filtered or unexported fields
}

AttributeCriteriaComputedByMinProximityOption is a wrapper for an AttributeCriteriaComputedByMinProximity option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AttributeCriteriaComputedByMinProximity 

func AttributeCriteriaComputedByMinProximity(v bool) *AttributeCriteriaComputedByMinProximityOption

AttributeCriteriaComputedByMinProximity wraps the given value into a AttributeCriteriaComputedByMinProximityOption.

func (*AttributeCriteriaComputedByMinProximityOption) Equal 

func (o *AttributeCriteriaComputedByMinProximityOption) Equal(o2 *AttributeCriteriaComputedByMinProximityOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AttributeCriteriaComputedByMinProximityOption) Get 

func (o *AttributeCriteriaComputedByMinProximityOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AttributeCriteriaComputedByMinProximityOption) MarshalJSON 

func (o AttributeCriteriaComputedByMinProximityOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AttributeCriteriaComputedByMinProximityOption.

func (*AttributeCriteriaComputedByMinProximityOption) UnmarshalJSON 

func (o *AttributeCriteriaComputedByMinProximityOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AttributeCriteriaComputedByMinProximityOption.

type AttributeForDistinctOption 

type AttributeForDistinctOption struct {
	// contains filtered or unexported fields
}

AttributeForDistinctOption is a wrapper for an AttributeForDistinct option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AttributeForDistinct 

func AttributeForDistinct(v string) *AttributeForDistinctOption

AttributeForDistinct wraps the given value into a AttributeForDistinctOption.

func (*AttributeForDistinctOption) Equal 

func (o *AttributeForDistinctOption) Equal(o2 *AttributeForDistinctOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AttributeForDistinctOption) Get 

func (o *AttributeForDistinctOption) Get() string

Get retrieves the actual value of the option parameter.

func (AttributeForDistinctOption) MarshalJSON 

func (o AttributeForDistinctOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AttributeForDistinctOption.

func (*AttributeForDistinctOption) UnmarshalJSON 

func (o *AttributeForDistinctOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AttributeForDistinctOption.

type AttributesForFacetingOption 

type AttributesForFacetingOption struct {
	// contains filtered or unexported fields
}

AttributesForFacetingOption is a wrapper for an AttributesForFaceting option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AttributesForFaceting 

func AttributesForFaceting(v ...string) *AttributesForFacetingOption

AttributesForFaceting wraps the given value into a AttributesForFacetingOption.

func (*AttributesForFacetingOption) Equal 

func (o *AttributesForFacetingOption) Equal(o2 *AttributesForFacetingOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AttributesForFacetingOption) Get 

func (o *AttributesForFacetingOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AttributesForFacetingOption) MarshalJSON 

func (o AttributesForFacetingOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AttributesForFacetingOption.

func (*AttributesForFacetingOption) UnmarshalJSON 

func (o *AttributesForFacetingOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AttributesForFacetingOption.

type AttributesToHighlightOption 

type AttributesToHighlightOption struct {
	// contains filtered or unexported fields
}

AttributesToHighlightOption is a wrapper for an AttributesToHighlight option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AttributesToHighlight 

func AttributesToHighlight(v ...string) *AttributesToHighlightOption

AttributesToHighlight wraps the given value into a AttributesToHighlightOption.

func (*AttributesToHighlightOption) Equal 

func (o *AttributesToHighlightOption) Equal(o2 *AttributesToHighlightOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AttributesToHighlightOption) Get 

func (o *AttributesToHighlightOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AttributesToHighlightOption) MarshalJSON 

func (o AttributesToHighlightOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AttributesToHighlightOption.

func (*AttributesToHighlightOption) UnmarshalJSON 

func (o *AttributesToHighlightOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AttributesToHighlightOption.

type AttributesToRetrieveOption 

type AttributesToRetrieveOption struct {
	// contains filtered or unexported fields
}

AttributesToRetrieveOption is a wrapper for an AttributesToRetrieve option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AttributesToRetrieve 

func AttributesToRetrieve(v ...string) *AttributesToRetrieveOption

AttributesToRetrieve wraps the given value into a AttributesToRetrieveOption.

func (*AttributesToRetrieveOption) Equal 

func (o *AttributesToRetrieveOption) Equal(o2 *AttributesToRetrieveOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AttributesToRetrieveOption) Get 

func (o *AttributesToRetrieveOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AttributesToRetrieveOption) MarshalJSON 

func (o AttributesToRetrieveOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AttributesToRetrieveOption.

func (*AttributesToRetrieveOption) UnmarshalJSON 

func (o *AttributesToRetrieveOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AttributesToRetrieveOption.

type AttributesToSnippetOption 

type AttributesToSnippetOption struct {
	// contains filtered or unexported fields
}

AttributesToSnippetOption is a wrapper for an AttributesToSnippet option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AttributesToSnippet 

func AttributesToSnippet(v ...string) *AttributesToSnippetOption

AttributesToSnippet wraps the given value into a AttributesToSnippetOption.

func (*AttributesToSnippetOption) Equal 

func (o *AttributesToSnippetOption) Equal(o2 *AttributesToSnippetOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AttributesToSnippetOption) Get 

func (o *AttributesToSnippetOption) Get() []string

Get retrieves the actual value of the option parameter.

func (AttributesToSnippetOption) MarshalJSON 

func (o AttributesToSnippetOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AttributesToSnippetOption.

func (*AttributesToSnippetOption) UnmarshalJSON 

func (o *AttributesToSnippetOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AttributesToSnippetOption.

type AutoGenerateObjectIDIfNotExistOption 

type AutoGenerateObjectIDIfNotExistOption struct {
	// contains filtered or unexported fields
}

AutoGenerateObjectIDIfNotExistOption is a wrapper for an AutoGenerateObjectIDIfNotExist option parameter. It holds the actual value of the option that can be accessed by calling Get.

func AutoGenerateObjectIDIfNotExist 

func AutoGenerateObjectIDIfNotExist(v bool) *AutoGenerateObjectIDIfNotExistOption

AutoGenerateObjectIDIfNotExist wraps the given value into a AutoGenerateObjectIDIfNotExistOption.

func (*AutoGenerateObjectIDIfNotExistOption) Equal 

func (o *AutoGenerateObjectIDIfNotExistOption) Equal(o2 *AutoGenerateObjectIDIfNotExistOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*AutoGenerateObjectIDIfNotExistOption) Get 

func (o *AutoGenerateObjectIDIfNotExistOption) Get() bool

Get retrieves the actual value of the option parameter.

func (AutoGenerateObjectIDIfNotExistOption) MarshalJSON 

func (o AutoGenerateObjectIDIfNotExistOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for AutoGenerateObjectIDIfNotExistOption.

func (*AutoGenerateObjectIDIfNotExistOption) UnmarshalJSON 

func (o *AutoGenerateObjectIDIfNotExistOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for AutoGenerateObjectIDIfNotExistOption.

type CamelCaseAttributesOption 

type CamelCaseAttributesOption struct {
	// contains filtered or unexported fields
}

CamelCaseAttributesOption is a wrapper for an CamelCaseAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func CamelCaseAttributes 

func CamelCaseAttributes(v ...string) *CamelCaseAttributesOption

CamelCaseAttributes wraps the given value into a CamelCaseAttributesOption.

func (*CamelCaseAttributesOption) Equal 

func (o *CamelCaseAttributesOption) Equal(o2 *CamelCaseAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*CamelCaseAttributesOption) Get 

func (o *CamelCaseAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (CamelCaseAttributesOption) MarshalJSON 

func (o CamelCaseAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for CamelCaseAttributesOption.

func (*CamelCaseAttributesOption) UnmarshalJSON 

func (o *CamelCaseAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for CamelCaseAttributesOption.

type ClearExistingRulesOption 

type ClearExistingRulesOption struct {
	// contains filtered or unexported fields
}

ClearExistingRulesOption is a wrapper for an ClearExistingRules option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ClearExistingRules 

func ClearExistingRules(v bool) *ClearExistingRulesOption

ClearExistingRules wraps the given value into a ClearExistingRulesOption.

func (*ClearExistingRulesOption) Equal 

func (o *ClearExistingRulesOption) Equal(o2 *ClearExistingRulesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ClearExistingRulesOption) Get 

func (o *ClearExistingRulesOption) Get() bool

Get retrieves the actual value of the option parameter.

func (ClearExistingRulesOption) MarshalJSON 

func (o ClearExistingRulesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ClearExistingRulesOption.

func (*ClearExistingRulesOption) UnmarshalJSON 

func (o *ClearExistingRulesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ClearExistingRulesOption.

type ClickAnalyticsOption 

type ClickAnalyticsOption struct {
	// contains filtered or unexported fields
}

ClickAnalyticsOption is a wrapper for an ClickAnalytics option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ClickAnalytics 

func ClickAnalytics(v bool) *ClickAnalyticsOption

ClickAnalytics wraps the given value into a ClickAnalyticsOption.

func (*ClickAnalyticsOption) Equal 

func (o *ClickAnalyticsOption) Equal(o2 *ClickAnalyticsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ClickAnalyticsOption) Get 

func (o *ClickAnalyticsOption) Get() bool

Get retrieves the actual value of the option parameter.

func (ClickAnalyticsOption) MarshalJSON 

func (o ClickAnalyticsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ClickAnalyticsOption.

func (*ClickAnalyticsOption) UnmarshalJSON 

func (o *ClickAnalyticsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ClickAnalyticsOption.

type ClusterOption added in v3.5.0 

type ClusterOption struct {
	// contains filtered or unexported fields
}

ClusterOption is a wrapper for an Cluster option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Cluster added in v3.5.0 

func Cluster(v string) *ClusterOption

Cluster wraps the given value into a ClusterOption.

func (*ClusterOption) Equal added in v3.5.0 

func (o *ClusterOption) Equal(o2 *ClusterOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ClusterOption) Get added in v3.5.0 

func (o *ClusterOption) Get() string

Get retrieves the actual value of the option parameter.

func (ClusterOption) MarshalJSON added in v3.5.0 

func (o ClusterOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ClusterOption.

func (*ClusterOption) UnmarshalJSON added in v3.5.0 

func (o *ClusterOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ClusterOption.

type CreateIfNotExistsOption 

type CreateIfNotExistsOption struct {
	// contains filtered or unexported fields
}

CreateIfNotExistsOption is a wrapper for an CreateIfNotExists option parameter. It holds the actual value of the option that can be accessed by calling Get.

func CreateIfNotExists 

func CreateIfNotExists(v bool) *CreateIfNotExistsOption

CreateIfNotExists wraps the given value into a CreateIfNotExistsOption.

func (*CreateIfNotExistsOption) Equal 

func (o *CreateIfNotExistsOption) Equal(o2 *CreateIfNotExistsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*CreateIfNotExistsOption) Get 

func (o *CreateIfNotExistsOption) Get() bool

Get retrieves the actual value of the option parameter.

func (CreateIfNotExistsOption) MarshalJSON 

func (o CreateIfNotExistsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for CreateIfNotExistsOption.

func (*CreateIfNotExistsOption) UnmarshalJSON 

func (o *CreateIfNotExistsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for CreateIfNotExistsOption.

type CustomNormalizationOption added in v3.5.0 

type CustomNormalizationOption struct {
	// contains filtered or unexported fields
}

CustomNormalizationOption is a wrapper for an CustomNormalization option parameter. It holds the actual value of the option that can be accessed by calling Get.

func CustomNormalization added in v3.5.0 

func CustomNormalization(v map[string]map[string]string) *CustomNormalizationOption

CustomNormalization wraps the given value into a CustomNormalizationOption.

func (*CustomNormalizationOption) Equal added in v3.5.0 

func (o *CustomNormalizationOption) Equal(o2 *CustomNormalizationOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*CustomNormalizationOption) Get added in v3.5.0 

func (o *CustomNormalizationOption) Get() map[string]map[string]string

Get retrieves the actual value of the option parameter.

func (CustomNormalizationOption) MarshalJSON added in v3.5.0 

func (o CustomNormalizationOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for CustomNormalizationOption.

func (*CustomNormalizationOption) UnmarshalJSON added in v3.5.0 

func (o *CustomNormalizationOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for CustomNormalizationOption.

type CustomRankingOption 

type CustomRankingOption struct {
	// contains filtered or unexported fields
}

CustomRankingOption is a wrapper for an CustomRanking option parameter. It holds the actual value of the option that can be accessed by calling Get.

func CustomRanking 

func CustomRanking(v ...string) *CustomRankingOption

CustomRanking wraps the given value into a CustomRankingOption.

func (*CustomRankingOption) Equal 

func (o *CustomRankingOption) Equal(o2 *CustomRankingOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*CustomRankingOption) Get 

func (o *CustomRankingOption) Get() []string

Get retrieves the actual value of the option parameter.

func (CustomRankingOption) MarshalJSON 

func (o CustomRankingOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for CustomRankingOption.

func (*CustomRankingOption) UnmarshalJSON 

func (o *CustomRankingOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for CustomRankingOption.

type DecompoundedAttributesOption 

type DecompoundedAttributesOption struct {
	// contains filtered or unexported fields
}

DecompoundedAttributesOption is a wrapper for an DecompoundedAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func DecompoundedAttributes 

func DecompoundedAttributes(v map[string][]string) *DecompoundedAttributesOption

DecompoundedAttributes wraps the given value into a DecompoundedAttributesOption.

func (*DecompoundedAttributesOption) Equal 

func (o *DecompoundedAttributesOption) Equal(o2 *DecompoundedAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*DecompoundedAttributesOption) Get 

func (o *DecompoundedAttributesOption) Get() map[string][]string

Get retrieves the actual value of the option parameter.

func (DecompoundedAttributesOption) MarshalJSON 

func (o DecompoundedAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for DecompoundedAttributesOption.

func (*DecompoundedAttributesOption) UnmarshalJSON 

func (o *DecompoundedAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for DecompoundedAttributesOption.

type DisableExactOnAttributesOption 

type DisableExactOnAttributesOption struct {
	// contains filtered or unexported fields
}

DisableExactOnAttributesOption is a wrapper for an DisableExactOnAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func DisableExactOnAttributes 

func DisableExactOnAttributes(v ...string) *DisableExactOnAttributesOption

DisableExactOnAttributes wraps the given value into a DisableExactOnAttributesOption.

func (*DisableExactOnAttributesOption) Equal 

func (o *DisableExactOnAttributesOption) Equal(o2 *DisableExactOnAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*DisableExactOnAttributesOption) Get 

func (o *DisableExactOnAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (DisableExactOnAttributesOption) MarshalJSON 

func (o DisableExactOnAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for DisableExactOnAttributesOption.

func (*DisableExactOnAttributesOption) UnmarshalJSON 

func (o *DisableExactOnAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for DisableExactOnAttributesOption.

type DisablePrefixOnAttributesOption 

type DisablePrefixOnAttributesOption struct {
	// contains filtered or unexported fields
}

DisablePrefixOnAttributesOption is a wrapper for an DisablePrefixOnAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func DisablePrefixOnAttributes 

func DisablePrefixOnAttributes(v ...string) *DisablePrefixOnAttributesOption

DisablePrefixOnAttributes wraps the given value into a DisablePrefixOnAttributesOption.

func (*DisablePrefixOnAttributesOption) Equal 

func (o *DisablePrefixOnAttributesOption) Equal(o2 *DisablePrefixOnAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*DisablePrefixOnAttributesOption) Get 

func (o *DisablePrefixOnAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (DisablePrefixOnAttributesOption) MarshalJSON 

func (o DisablePrefixOnAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for DisablePrefixOnAttributesOption.

func (*DisablePrefixOnAttributesOption) UnmarshalJSON 

func (o *DisablePrefixOnAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for DisablePrefixOnAttributesOption.

type DisableTypoToleranceOnAttributesOption 

type DisableTypoToleranceOnAttributesOption struct {
	// contains filtered or unexported fields
}

DisableTypoToleranceOnAttributesOption is a wrapper for an DisableTypoToleranceOnAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func DisableTypoToleranceOnAttributes 

func DisableTypoToleranceOnAttributes(v ...string) *DisableTypoToleranceOnAttributesOption

DisableTypoToleranceOnAttributes wraps the given value into a DisableTypoToleranceOnAttributesOption.

func (*DisableTypoToleranceOnAttributesOption) Equal 

func (o *DisableTypoToleranceOnAttributesOption) Equal(o2 *DisableTypoToleranceOnAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*DisableTypoToleranceOnAttributesOption) Get 

func (o *DisableTypoToleranceOnAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (DisableTypoToleranceOnAttributesOption) MarshalJSON 

func (o DisableTypoToleranceOnAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for DisableTypoToleranceOnAttributesOption.

func (*DisableTypoToleranceOnAttributesOption) UnmarshalJSON 

func (o *DisableTypoToleranceOnAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for DisableTypoToleranceOnAttributesOption.

type DisableTypoToleranceOnWordsOption 

type DisableTypoToleranceOnWordsOption struct {
	// contains filtered or unexported fields
}

DisableTypoToleranceOnWordsOption is a wrapper for an DisableTypoToleranceOnWords option parameter. It holds the actual value of the option that can be accessed by calling Get.

func DisableTypoToleranceOnWords 

func DisableTypoToleranceOnWords(v ...string) *DisableTypoToleranceOnWordsOption

DisableTypoToleranceOnWords wraps the given value into a DisableTypoToleranceOnWordsOption.

func (*DisableTypoToleranceOnWordsOption) Equal 

func (o *DisableTypoToleranceOnWordsOption) Equal(o2 *DisableTypoToleranceOnWordsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*DisableTypoToleranceOnWordsOption) Get 

func (o *DisableTypoToleranceOnWordsOption) Get() []string

Get retrieves the actual value of the option parameter.

func (DisableTypoToleranceOnWordsOption) MarshalJSON 

func (o DisableTypoToleranceOnWordsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for DisableTypoToleranceOnWordsOption.

func (*DisableTypoToleranceOnWordsOption) UnmarshalJSON 

func (o *DisableTypoToleranceOnWordsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for DisableTypoToleranceOnWordsOption.

type DistinctOption 

type DistinctOption struct {
	// contains filtered or unexported fields
}

DistinctOption is a wrapper for an Distinct option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Distinct 

func Distinct(enabled bool) *DistinctOption

Distinct returns an DistinctOption whose value is set to the given boolean.

func DistinctOf 

func DistinctOf(v int) *DistinctOption

DistinctOf returns an DistinctOption whose value is set to the given integer.

func (*DistinctOption) Equal 

func (o *DistinctOption) Equal(o2 *DistinctOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*DistinctOption) Get 

func (o *DistinctOption) Get() (bool, int)

Get retrieves the actual value of the option parameter.

func (DistinctOption) MarshalJSON 

func (o DistinctOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for DistinctOption.

func (*DistinctOption) UnmarshalJSON 

func (o *DistinctOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for DistinctOption.

type EnableABTestOption added in v3.5.0 

type EnableABTestOption struct {
	// contains filtered or unexported fields
}

EnableABTestOption is a wrapper for an EnableABTest option parameter. It holds the actual value of the option that can be accessed by calling Get.

func EnableABTest added in v3.5.0 

func EnableABTest(v bool) *EnableABTestOption

EnableABTest wraps the given value into a EnableABTestOption.

func (*EnableABTestOption) Equal added in v3.5.0 

func (o *EnableABTestOption) Equal(o2 *EnableABTestOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*EnableABTestOption) Get added in v3.5.0 

func (o *EnableABTestOption) Get() bool

Get retrieves the actual value of the option parameter.

func (EnableABTestOption) MarshalJSON added in v3.5.0 

func (o EnableABTestOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for EnableABTestOption.

func (*EnableABTestOption) UnmarshalJSON added in v3.5.0 

func (o *EnableABTestOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for EnableABTestOption.

type EnablePersonalizationOption 

type EnablePersonalizationOption struct {
	// contains filtered or unexported fields
}

EnablePersonalizationOption is a wrapper for an EnablePersonalization option parameter. It holds the actual value of the option that can be accessed by calling Get.

func EnablePersonalization 

func EnablePersonalization(v bool) *EnablePersonalizationOption

EnablePersonalization wraps the given value into a EnablePersonalizationOption.

func (*EnablePersonalizationOption) Equal 

func (o *EnablePersonalizationOption) Equal(o2 *EnablePersonalizationOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*EnablePersonalizationOption) Get 

func (o *EnablePersonalizationOption) Get() bool

Get retrieves the actual value of the option parameter.

func (EnablePersonalizationOption) MarshalJSON 

func (o EnablePersonalizationOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for EnablePersonalizationOption.

func (*EnablePersonalizationOption) UnmarshalJSON 

func (o *EnablePersonalizationOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for EnablePersonalizationOption.

type EnableRulesOption 

type EnableRulesOption struct {
	// contains filtered or unexported fields
}

EnableRulesOption is a wrapper for an EnableRules option parameter. It holds the actual value of the option that can be accessed by calling Get.

func EnableRules 

func EnableRules(v bool) *EnableRulesOption

EnableRules wraps the given value into a EnableRulesOption.

func (*EnableRulesOption) Equal 

func (o *EnableRulesOption) Equal(o2 *EnableRulesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*EnableRulesOption) Get 

func (o *EnableRulesOption) Get() bool

Get retrieves the actual value of the option parameter.

func (EnableRulesOption) MarshalJSON 

func (o EnableRulesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for EnableRulesOption.

func (*EnableRulesOption) UnmarshalJSON 

func (o *EnableRulesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for EnableRulesOption.

type EnabledOption 

type EnabledOption struct {
	// contains filtered or unexported fields
}

EnabledOption is a wrapper for an Enabled option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Enabled 

func Enabled(v bool) *EnabledOption

Enabled wraps the given value into a EnabledOption.

func (*EnabledOption) Equal 

func (o *EnabledOption) Equal(o2 *EnabledOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*EnabledOption) Get 

func (o *EnabledOption) Get() bool

Get retrieves the actual value of the option parameter.

func (EnabledOption) MarshalJSON 

func (o EnabledOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for EnabledOption.

func (*EnabledOption) UnmarshalJSON 

func (o *EnabledOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for EnabledOption.

type ExactOnSingleWordQueryOption 

type ExactOnSingleWordQueryOption struct {
	// contains filtered or unexported fields
}

ExactOnSingleWordQueryOption is a wrapper for an ExactOnSingleWordQuery option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ExactOnSingleWordQuery 

func ExactOnSingleWordQuery(v string) *ExactOnSingleWordQueryOption

ExactOnSingleWordQuery wraps the given value into a ExactOnSingleWordQueryOption.

func (*ExactOnSingleWordQueryOption) Equal 

func (o *ExactOnSingleWordQueryOption) Equal(o2 *ExactOnSingleWordQueryOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ExactOnSingleWordQueryOption) Get 

func (o *ExactOnSingleWordQueryOption) Get() string

Get retrieves the actual value of the option parameter.

func (ExactOnSingleWordQueryOption) MarshalJSON 

func (o ExactOnSingleWordQueryOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ExactOnSingleWordQueryOption.

func (*ExactOnSingleWordQueryOption) UnmarshalJSON 

func (o *ExactOnSingleWordQueryOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ExactOnSingleWordQueryOption.

type ExplainOption 

type ExplainOption struct {
	// contains filtered or unexported fields
}

ExplainOption is a wrapper for an Explain option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Explain 

func Explain(v ...string) *ExplainOption

Explain wraps the given value into a ExplainOption.

func (*ExplainOption) Equal 

func (o *ExplainOption) Equal(o2 *ExplainOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ExplainOption) Get 

func (o *ExplainOption) Get() []string

Get retrieves the actual value of the option parameter.

func (ExplainOption) MarshalJSON 

func (o ExplainOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ExplainOption.

func (*ExplainOption) UnmarshalJSON 

func (o *ExplainOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ExplainOption.

type ExtraHeadersOption 

type ExtraHeadersOption struct {
	// contains filtered or unexported fields
}

ExtraHeadersOption is a wrapper for an ExtraHeaders option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ExtraHeaders 

func ExtraHeaders(v map[string]string) *ExtraHeadersOption

ExtraHeaders wraps the given value into a ExtraHeadersOption.

func (*ExtraHeadersOption) Equal 

func (o *ExtraHeadersOption) Equal(o2 *ExtraHeadersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ExtraHeadersOption) Get 

func (o *ExtraHeadersOption) Get() map[string]string

Get retrieves the actual value of the option parameter.

func (ExtraHeadersOption) MarshalJSON 

func (o ExtraHeadersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ExtraHeadersOption.

func (*ExtraHeadersOption) UnmarshalJSON 

func (o *ExtraHeadersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ExtraHeadersOption.

type ExtraOptionsOption 

type ExtraOptionsOption struct {
	// contains filtered or unexported fields
}

ExtraOptionsOption is a wrapper for an ExtraOptions option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ExtraOptions 

func ExtraOptions(v map[string]interface{}) *ExtraOptionsOption

ExtraOptions wraps the given value into a ExtraOptionsOption.

func (*ExtraOptionsOption) Equal 

func (o *ExtraOptionsOption) Equal(o2 *ExtraOptionsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ExtraOptionsOption) Get 

func (o *ExtraOptionsOption) Get() map[string]interface{}

Get retrieves the actual value of the option parameter.

func (ExtraOptionsOption) MarshalJSON 

func (o ExtraOptionsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ExtraOptionsOption.

func (*ExtraOptionsOption) UnmarshalJSON 

func (o *ExtraOptionsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ExtraOptionsOption.

type ExtraURLParamsOption 

type ExtraURLParamsOption struct {
	// contains filtered or unexported fields
}

ExtraURLParamsOption is a wrapper for an ExtraURLParams option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ExtraURLParams 

func ExtraURLParams(v map[string]string) *ExtraURLParamsOption

ExtraURLParams wraps the given value into a ExtraURLParamsOption.

func (*ExtraURLParamsOption) Equal 

func (o *ExtraURLParamsOption) Equal(o2 *ExtraURLParamsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ExtraURLParamsOption) Get 

func (o *ExtraURLParamsOption) Get() map[string]string

Get retrieves the actual value of the option parameter.

func (ExtraURLParamsOption) MarshalJSON 

func (o ExtraURLParamsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ExtraURLParamsOption.

func (*ExtraURLParamsOption) UnmarshalJSON 

func (o *ExtraURLParamsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ExtraURLParamsOption.

type FacetFiltersOption 

type FacetFiltersOption struct {
	// contains filtered or unexported fields
}

FacetFiltersOption is a wrapper for an FacetFilters option parameter. It holds the actual value of the option that can be accessed by calling Get.

func FacetFilter 

func FacetFilter(filter string) *FacetFiltersOption

FacetFilter returns an FacetFiltersOption whose value is set to the given string.

func FacetFilterAnd 

func FacetFilterAnd(filters ...interface{}) *FacetFiltersOption

FacetFilters returns an FacetFiltersOption whose value is set as an AND of the given filters.

func FacetFilterOr 

func FacetFilterOr(filters ...interface{}) *FacetFiltersOption

FacetFilters returns an FacetFiltersOption whose value is set as an OR of the given filters.

func (*FacetFiltersOption) Equal 

func (o *FacetFiltersOption) Equal(o2 *FacetFiltersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*FacetFiltersOption) Get 

func (o *FacetFiltersOption) Get() [][]string

Get retrieves the actual value of the option parameter. The slice of slice represents filters that are ORed then ANDed. For instance, the following returned slice: 

[][]string{ {"filter1", "filter2"}, {"filter3"} }

means: 

("filter1" OR "filter2" ) AND "filter 3"

func (FacetFiltersOption) MarshalJSON 

func (o FacetFiltersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for FacetFiltersOption.

func (*FacetFiltersOption) UnmarshalJSON 

func (o *FacetFiltersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for FacetFiltersOption.

type FacetingAfterDistinctOption 

type FacetingAfterDistinctOption struct {
	// contains filtered or unexported fields
}

FacetingAfterDistinctOption is a wrapper for an FacetingAfterDistinct option parameter. It holds the actual value of the option that can be accessed by calling Get.

func FacetingAfterDistinct 

func FacetingAfterDistinct(v bool) *FacetingAfterDistinctOption

FacetingAfterDistinct wraps the given value into a FacetingAfterDistinctOption.

func (*FacetingAfterDistinctOption) Equal 

func (o *FacetingAfterDistinctOption) Equal(o2 *FacetingAfterDistinctOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*FacetingAfterDistinctOption) Get 

func (o *FacetingAfterDistinctOption) Get() bool

Get retrieves the actual value of the option parameter.

func (FacetingAfterDistinctOption) MarshalJSON 

func (o FacetingAfterDistinctOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for FacetingAfterDistinctOption.

func (*FacetingAfterDistinctOption) UnmarshalJSON 

func (o *FacetingAfterDistinctOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for FacetingAfterDistinctOption.

type FacetsOption 

type FacetsOption struct {
	// contains filtered or unexported fields
}

FacetsOption is a wrapper for an Facets option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Facets 

func Facets(v ...string) *FacetsOption

Facets wraps the given value into a FacetsOption.

func (*FacetsOption) Equal 

func (o *FacetsOption) Equal(o2 *FacetsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*FacetsOption) Get 

func (o *FacetsOption) Get() []string

Get retrieves the actual value of the option parameter.

func (FacetsOption) MarshalJSON 

func (o FacetsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for FacetsOption.

func (*FacetsOption) UnmarshalJSON 

func (o *FacetsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for FacetsOption.

type FilterPromotesOption added in v3.5.0 

type FilterPromotesOption struct {
	// contains filtered or unexported fields
}

FilterPromotesOption is a wrapper for an FilterPromotes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func FilterPromotes added in v3.5.0 

func FilterPromotes(v bool) *FilterPromotesOption

FilterPromotes wraps the given value into a FilterPromotesOption.

func (*FilterPromotesOption) Equal added in v3.5.0 

func (o *FilterPromotesOption) Equal(o2 *FilterPromotesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*FilterPromotesOption) Get added in v3.5.0 

func (o *FilterPromotesOption) Get() bool

Get retrieves the actual value of the option parameter.

func (FilterPromotesOption) MarshalJSON added in v3.5.0 

func (o FilterPromotesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for FilterPromotesOption.

func (*FilterPromotesOption) UnmarshalJSON added in v3.5.0 

func (o *FilterPromotesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for FilterPromotesOption.

type FiltersOption 

type FiltersOption struct {
	// contains filtered or unexported fields
}

FiltersOption is a wrapper for an Filters option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Filters 

func Filters(v string) *FiltersOption

Filters wraps the given value into a FiltersOption.

func (*FiltersOption) Equal 

func (o *FiltersOption) Equal(o2 *FiltersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*FiltersOption) Get 

func (o *FiltersOption) Get() string

Get retrieves the actual value of the option parameter.

func (FiltersOption) MarshalJSON 

func (o FiltersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for FiltersOption.

func (*FiltersOption) UnmarshalJSON 

func (o *FiltersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for FiltersOption.

type ForwardToReplicasOption 

type ForwardToReplicasOption struct {
	// contains filtered or unexported fields
}

ForwardToReplicasOption is a wrapper for an ForwardToReplicas option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ForwardToReplicas 

func ForwardToReplicas(v bool) *ForwardToReplicasOption

ForwardToReplicas wraps the given value into a ForwardToReplicasOption.

func (*ForwardToReplicasOption) Equal 

func (o *ForwardToReplicasOption) Equal(o2 *ForwardToReplicasOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ForwardToReplicasOption) Get 

func (o *ForwardToReplicasOption) Get() bool

Get retrieves the actual value of the option parameter.

func (ForwardToReplicasOption) MarshalJSON 

func (o ForwardToReplicasOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ForwardToReplicasOption.

func (*ForwardToReplicasOption) UnmarshalJSON 

func (o *ForwardToReplicasOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ForwardToReplicasOption.

type GetRankingInfoOption 

type GetRankingInfoOption struct {
	// contains filtered or unexported fields
}

GetRankingInfoOption is a wrapper for an GetRankingInfo option parameter. It holds the actual value of the option that can be accessed by calling Get.

func GetRankingInfo 

func GetRankingInfo(v bool) *GetRankingInfoOption

GetRankingInfo wraps the given value into a GetRankingInfoOption.

func (*GetRankingInfoOption) Equal 

func (o *GetRankingInfoOption) Equal(o2 *GetRankingInfoOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*GetRankingInfoOption) Get 

func (o *GetRankingInfoOption) Get() bool

Get retrieves the actual value of the option parameter.

func (GetRankingInfoOption) MarshalJSON 

func (o GetRankingInfoOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for GetRankingInfoOption.

func (*GetRankingInfoOption) UnmarshalJSON 

func (o *GetRankingInfoOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for GetRankingInfoOption.

type HighlightPostTagOption 

type HighlightPostTagOption struct {
	// contains filtered or unexported fields
}

HighlightPostTagOption is a wrapper for an HighlightPostTag option parameter. It holds the actual value of the option that can be accessed by calling Get.

func HighlightPostTag 

func HighlightPostTag(v string) *HighlightPostTagOption

HighlightPostTag wraps the given value into a HighlightPostTagOption.

func (*HighlightPostTagOption) Equal 

func (o *HighlightPostTagOption) Equal(o2 *HighlightPostTagOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*HighlightPostTagOption) Get 

func (o *HighlightPostTagOption) Get() string

Get retrieves the actual value of the option parameter.

func (HighlightPostTagOption) MarshalJSON 

func (o HighlightPostTagOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for HighlightPostTagOption.

func (*HighlightPostTagOption) UnmarshalJSON 

func (o *HighlightPostTagOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for HighlightPostTagOption.

type HighlightPreTagOption 

type HighlightPreTagOption struct {
	// contains filtered or unexported fields
}

HighlightPreTagOption is a wrapper for an HighlightPreTag option parameter. It holds the actual value of the option that can be accessed by calling Get.

func HighlightPreTag 

func HighlightPreTag(v string) *HighlightPreTagOption

HighlightPreTag wraps the given value into a HighlightPreTagOption.

func (*HighlightPreTagOption) Equal 

func (o *HighlightPreTagOption) Equal(o2 *HighlightPreTagOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*HighlightPreTagOption) Get 

func (o *HighlightPreTagOption) Get() string

Get retrieves the actual value of the option parameter.

func (HighlightPreTagOption) MarshalJSON 

func (o HighlightPreTagOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for HighlightPreTagOption.

func (*HighlightPreTagOption) UnmarshalJSON 

func (o *HighlightPreTagOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for HighlightPreTagOption.

type HitsPerPageOption 

type HitsPerPageOption struct {
	// contains filtered or unexported fields
}

HitsPerPageOption is a wrapper for an HitsPerPage option parameter. It holds the actual value of the option that can be accessed by calling Get.

func HitsPerPage 

func HitsPerPage(v int) *HitsPerPageOption

HitsPerPage wraps the given value into a HitsPerPageOption.

func (*HitsPerPageOption) Equal 

func (o *HitsPerPageOption) Equal(o2 *HitsPerPageOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*HitsPerPageOption) Get 

func (o *HitsPerPageOption) Get() int

Get retrieves the actual value of the option parameter.

func (HitsPerPageOption) MarshalJSON 

func (o HitsPerPageOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for HitsPerPageOption.

func (*HitsPerPageOption) UnmarshalJSON 

func (o *HitsPerPageOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for HitsPerPageOption.

type IgnorePluralsOption 

type IgnorePluralsOption struct {
	// contains filtered or unexported fields
}

IgnorePluralsOption is a wrapper for an IgnorePlurals option parameter. It holds the actual value of the option that can be accessed by calling Get.

func IgnorePlurals 

func IgnorePlurals(v bool) *IgnorePluralsOption

IgnorePlurals returns an IgnorePluralsOption whose value is set to the given boolean.

func IgnorePluralsFor 

func IgnorePluralsFor(languages ...string) *IgnorePluralsOption

IgnorePluralsFor returns an IgnorePluralsOption whose value is set to the given list of languages.

func (*IgnorePluralsOption) Equal 

func (o *IgnorePluralsOption) Equal(o2 *IgnorePluralsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*IgnorePluralsOption) Get 

func (o *IgnorePluralsOption) Get() (bool, []string)

Get retrieves the actual value of the option parameter.

func (IgnorePluralsOption) MarshalJSON 

func (o IgnorePluralsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for IgnorePluralsOption.

func (*IgnorePluralsOption) UnmarshalJSON 

func (o *IgnorePluralsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for IgnorePluralsOption.

type IndexLanguagesOption 

type IndexLanguagesOption struct {
	// contains filtered or unexported fields
}

IndexLanguagesOption is a wrapper for an IndexLanguages option parameter. It holds the actual value of the option that can be accessed by calling Get.

func IndexLanguages 

func IndexLanguages(v ...string) *IndexLanguagesOption

IndexLanguages wraps the given value into a IndexLanguagesOption.

func (*IndexLanguagesOption) Equal 

func (o *IndexLanguagesOption) Equal(o2 *IndexLanguagesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*IndexLanguagesOption) Get 

func (o *IndexLanguagesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (IndexLanguagesOption) MarshalJSON 

func (o IndexLanguagesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for IndexLanguagesOption.

func (*IndexLanguagesOption) UnmarshalJSON 

func (o *IndexLanguagesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for IndexLanguagesOption.

type IndexNameOption 

type IndexNameOption struct {
	// contains filtered or unexported fields
}

IndexNameOption is a wrapper for an IndexName option parameter. It holds the actual value of the option that can be accessed by calling Get.

func IndexName 

func IndexName(v string) *IndexNameOption

IndexName wraps the given value into a IndexNameOption.

func (*IndexNameOption) Equal 

func (o *IndexNameOption) Equal(o2 *IndexNameOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*IndexNameOption) Get 

func (o *IndexNameOption) Get() string

Get retrieves the actual value of the option parameter.

func (IndexNameOption) MarshalJSON 

func (o IndexNameOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for IndexNameOption.

func (*IndexNameOption) UnmarshalJSON 

func (o *IndexNameOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for IndexNameOption.

type InsideBoundingBoxOption 

type InsideBoundingBoxOption struct {
	// contains filtered or unexported fields
}

InsideBoundingBoxOption is a wrapper for an InsideBoundingBox option parameter. It holds the actual value of the option that can be accessed by calling Get.

func InsideBoundingBox 

func InsideBoundingBox(boxes [][4]float64) *InsideBoundingBoxOption

InsideBoundingBox returns an InsideBoundingBoxOption whose value is set to the given slice of rectangle coordinates.

func InsideBoundingBoxFromCoordinates 

func InsideBoundingBoxFromCoordinates(coordinates string) *InsideBoundingBoxOption

InsideBoundingBoxFromCoordinates returns an InsideBoundingBoxOption whose value is to the given coordinates string.

func (*InsideBoundingBoxOption) Equal 

func (o *InsideBoundingBoxOption) Equal(o2 *InsideBoundingBoxOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*InsideBoundingBoxOption) Get 

func (o *InsideBoundingBoxOption) Get() ([][4]float64, string)

Get retrieves the actual value of the option parameter.

func (InsideBoundingBoxOption) MarshalJSON 

func (o InsideBoundingBoxOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for InsideBoundingBoxOption.

func (*InsideBoundingBoxOption) UnmarshalJSON 

func (o *InsideBoundingBoxOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for InsideBoundingBoxOption.

type InsidePolygonOption 

type InsidePolygonOption struct {
	// contains filtered or unexported fields
}

InsidePolygonOption is a wrapper for an InsidePolygon option parameter. It holds the actual value of the option that can be accessed by calling Get.

func InsidePolygon 

func InsidePolygon(polygons [][]float64) *InsidePolygonOption

InsidePolygon returns an InsidePolygonOption whose value is set to the given slice of rectangle coordinates.

func InsidePolygonFromCoordinates 

func InsidePolygonFromCoordinates(coordinates string) *InsidePolygonOption

InsidePolygonFromCoordinates returns an InsidePolygonOption whose value is to the given coordinates string.

func (*InsidePolygonOption) Equal 

func (o *InsidePolygonOption) Equal(o2 *InsidePolygonOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*InsidePolygonOption) Get 

func (o *InsidePolygonOption) Get() ([][]float64, string)

Get retrieves the actual value of the option parameter.

func (InsidePolygonOption) MarshalJSON 

func (o InsidePolygonOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for InsidePolygonOption.

func (*InsidePolygonOption) UnmarshalJSON 

func (o *InsidePolygonOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for InsidePolygonOption.

type KeepDiacriticsOnCharactersOption 

type KeepDiacriticsOnCharactersOption struct {
	// contains filtered or unexported fields
}

KeepDiacriticsOnCharactersOption is a wrapper for an KeepDiacriticsOnCharacters option parameter. It holds the actual value of the option that can be accessed by calling Get.

func KeepDiacriticsOnCharacters 

func KeepDiacriticsOnCharacters(v string) *KeepDiacriticsOnCharactersOption

KeepDiacriticsOnCharacters wraps the given value into a KeepDiacriticsOnCharactersOption.

func (*KeepDiacriticsOnCharactersOption) Equal 

func (o *KeepDiacriticsOnCharactersOption) Equal(o2 *KeepDiacriticsOnCharactersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*KeepDiacriticsOnCharactersOption) Get 

func (o *KeepDiacriticsOnCharactersOption) Get() string

Get retrieves the actual value of the option parameter.

func (KeepDiacriticsOnCharactersOption) MarshalJSON 

func (o KeepDiacriticsOnCharactersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for KeepDiacriticsOnCharactersOption.

func (*KeepDiacriticsOnCharactersOption) UnmarshalJSON 

func (o *KeepDiacriticsOnCharactersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for KeepDiacriticsOnCharactersOption.

type LengthOption 

type LengthOption struct {
	// contains filtered or unexported fields
}

LengthOption is a wrapper for an Length option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Length 

func Length(v int) *LengthOption

Length wraps the given value into a LengthOption.

func (*LengthOption) Equal 

func (o *LengthOption) Equal(o2 *LengthOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*LengthOption) Get 

func (o *LengthOption) Get() int

Get retrieves the actual value of the option parameter.

func (LengthOption) MarshalJSON 

func (o LengthOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for LengthOption.

func (*LengthOption) UnmarshalJSON 

func (o *LengthOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for LengthOption.

type LimitOption 

type LimitOption struct {
	// contains filtered or unexported fields
}

LimitOption is a wrapper for an Limit option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Limit 

func Limit(v int) *LimitOption

Limit wraps the given value into a LimitOption.

func (*LimitOption) Equal 

func (o *LimitOption) Equal(o2 *LimitOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*LimitOption) Get 

func (o *LimitOption) Get() int

Get retrieves the actual value of the option parameter.

func (LimitOption) MarshalJSON 

func (o LimitOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for LimitOption.

func (*LimitOption) UnmarshalJSON 

func (o *LimitOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for LimitOption.

type MaxFacetHitsOption 

type MaxFacetHitsOption struct {
	// contains filtered or unexported fields
}

MaxFacetHitsOption is a wrapper for an MaxFacetHits option parameter. It holds the actual value of the option that can be accessed by calling Get.

func MaxFacetHits 

func MaxFacetHits(v int) *MaxFacetHitsOption

MaxFacetHits wraps the given value into a MaxFacetHitsOption.

func (*MaxFacetHitsOption) Equal 

func (o *MaxFacetHitsOption) Equal(o2 *MaxFacetHitsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*MaxFacetHitsOption) Get 

func (o *MaxFacetHitsOption) Get() int

Get retrieves the actual value of the option parameter.

func (MaxFacetHitsOption) MarshalJSON 

func (o MaxFacetHitsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for MaxFacetHitsOption.

func (*MaxFacetHitsOption) UnmarshalJSON 

func (o *MaxFacetHitsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for MaxFacetHitsOption.

type MaxValuesPerFacetOption 

type MaxValuesPerFacetOption struct {
	// contains filtered or unexported fields
}

MaxValuesPerFacetOption is a wrapper for an MaxValuesPerFacet option parameter. It holds the actual value of the option that can be accessed by calling Get.

func MaxValuesPerFacet 

func MaxValuesPerFacet(v int) *MaxValuesPerFacetOption

MaxValuesPerFacet wraps the given value into a MaxValuesPerFacetOption.

func (*MaxValuesPerFacetOption) Equal 

func (o *MaxValuesPerFacetOption) Equal(o2 *MaxValuesPerFacetOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*MaxValuesPerFacetOption) Get 

func (o *MaxValuesPerFacetOption) Get() int

Get retrieves the actual value of the option parameter.

func (MaxValuesPerFacetOption) MarshalJSON 

func (o MaxValuesPerFacetOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for MaxValuesPerFacetOption.

func (*MaxValuesPerFacetOption) UnmarshalJSON 

func (o *MaxValuesPerFacetOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for MaxValuesPerFacetOption.

type MinProximityOption 

type MinProximityOption struct {
	// contains filtered or unexported fields
}

MinProximityOption is a wrapper for an MinProximity option parameter. It holds the actual value of the option that can be accessed by calling Get.

func MinProximity 

func MinProximity(v int) *MinProximityOption

MinProximity wraps the given value into a MinProximityOption.

func (*MinProximityOption) Equal 

func (o *MinProximityOption) Equal(o2 *MinProximityOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*MinProximityOption) Get 

func (o *MinProximityOption) Get() int

Get retrieves the actual value of the option parameter.

func (MinProximityOption) MarshalJSON 

func (o MinProximityOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for MinProximityOption.

func (*MinProximityOption) UnmarshalJSON 

func (o *MinProximityOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for MinProximityOption.

type MinWordSizefor1TypoOption 

type MinWordSizefor1TypoOption struct {
	// contains filtered or unexported fields
}

MinWordSizefor1TypoOption is a wrapper for an MinWordSizefor1Typo option parameter. It holds the actual value of the option that can be accessed by calling Get.

func MinWordSizefor1Typo 

func MinWordSizefor1Typo(v int) *MinWordSizefor1TypoOption

MinWordSizefor1Typo wraps the given value into a MinWordSizefor1TypoOption.

func (*MinWordSizefor1TypoOption) Equal 

func (o *MinWordSizefor1TypoOption) Equal(o2 *MinWordSizefor1TypoOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*MinWordSizefor1TypoOption) Get 

func (o *MinWordSizefor1TypoOption) Get() int

Get retrieves the actual value of the option parameter.

func (MinWordSizefor1TypoOption) MarshalJSON 

func (o MinWordSizefor1TypoOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for MinWordSizefor1TypoOption.

func (*MinWordSizefor1TypoOption) UnmarshalJSON 

func (o *MinWordSizefor1TypoOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for MinWordSizefor1TypoOption.

type MinWordSizefor2TyposOption 

type MinWordSizefor2TyposOption struct {
	// contains filtered or unexported fields
}

MinWordSizefor2TyposOption is a wrapper for an MinWordSizefor2Typos option parameter. It holds the actual value of the option that can be accessed by calling Get.

func MinWordSizefor2Typos 

func MinWordSizefor2Typos(v int) *MinWordSizefor2TyposOption

MinWordSizefor2Typos wraps the given value into a MinWordSizefor2TyposOption.

func (*MinWordSizefor2TyposOption) Equal 

func (o *MinWordSizefor2TyposOption) Equal(o2 *MinWordSizefor2TyposOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*MinWordSizefor2TyposOption) Get 

func (o *MinWordSizefor2TyposOption) Get() int

Get retrieves the actual value of the option parameter.

func (MinWordSizefor2TyposOption) MarshalJSON 

func (o MinWordSizefor2TyposOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for MinWordSizefor2TyposOption.

func (*MinWordSizefor2TyposOption) UnmarshalJSON 

func (o *MinWordSizefor2TyposOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for MinWordSizefor2TyposOption.

type MinimumAroundRadiusOption 

type MinimumAroundRadiusOption struct {
	// contains filtered or unexported fields
}

MinimumAroundRadiusOption is a wrapper for an MinimumAroundRadius option parameter. It holds the actual value of the option that can be accessed by calling Get.

func MinimumAroundRadius 

func MinimumAroundRadius(v int) *MinimumAroundRadiusOption

MinimumAroundRadius wraps the given value into a MinimumAroundRadiusOption.

func (*MinimumAroundRadiusOption) Equal 

func (o *MinimumAroundRadiusOption) Equal(o2 *MinimumAroundRadiusOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*MinimumAroundRadiusOption) Get 

func (o *MinimumAroundRadiusOption) Get() int

Get retrieves the actual value of the option parameter.

func (MinimumAroundRadiusOption) MarshalJSON 

func (o MinimumAroundRadiusOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for MinimumAroundRadiusOption.

func (*MinimumAroundRadiusOption) UnmarshalJSON 

func (o *MinimumAroundRadiusOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for MinimumAroundRadiusOption.

type NumericAttributesForFilteringOption 

type NumericAttributesForFilteringOption struct {
	// contains filtered or unexported fields
}

NumericAttributesForFilteringOption is a wrapper for an NumericAttributesForFiltering option parameter. It holds the actual value of the option that can be accessed by calling Get.

func NumericAttributesForFiltering 

func NumericAttributesForFiltering(v ...string) *NumericAttributesForFilteringOption

NumericAttributesForFiltering wraps the given value into a NumericAttributesForFilteringOption.

func (*NumericAttributesForFilteringOption) Equal 

func (o *NumericAttributesForFilteringOption) Equal(o2 *NumericAttributesForFilteringOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*NumericAttributesForFilteringOption) Get 

func (o *NumericAttributesForFilteringOption) Get() []string

Get retrieves the actual value of the option parameter.

func (NumericAttributesForFilteringOption) MarshalJSON 

func (o NumericAttributesForFilteringOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for NumericAttributesForFilteringOption.

func (*NumericAttributesForFilteringOption) UnmarshalJSON 

func (o *NumericAttributesForFilteringOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for NumericAttributesForFilteringOption.

type NumericFiltersOption 

type NumericFiltersOption struct {
	// contains filtered or unexported fields
}

NumericFiltersOption is a wrapper for an NumericFilters option parameter. It holds the actual value of the option that can be accessed by calling Get.

func NumericFilter 

func NumericFilter(filter string) *NumericFiltersOption

NumericFilter returns an NumericFiltersOption whose value is set to the given string.

func NumericFilterAnd 

func NumericFilterAnd(filters ...interface{}) *NumericFiltersOption

NumericFilters returns an NumericFiltersOption whose value is set as an AND of the given filters.

func NumericFilterOr 

func NumericFilterOr(filters ...interface{}) *NumericFiltersOption

NumericFilters returns an NumericFiltersOption whose value is set as an OR of the given filters.

func (*NumericFiltersOption) Equal 

func (o *NumericFiltersOption) Equal(o2 *NumericFiltersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*NumericFiltersOption) Get 

func (o *NumericFiltersOption) Get() [][]string

Get retrieves the actual value of the option parameter. The slice of slice represents filters that are ORed then ANDed. For instance, the following returned slice: 

[][]string{ {"filter1", "filter2"}, {"filter3"} }

means: 

("filter1" OR "filter2" ) AND "filter 3"

func (NumericFiltersOption) MarshalJSON 

func (o NumericFiltersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for NumericFiltersOption.

func (*NumericFiltersOption) UnmarshalJSON 

func (o *NumericFiltersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for NumericFiltersOption.

type OffsetOption 

type OffsetOption struct {
	// contains filtered or unexported fields
}

OffsetOption is a wrapper for an Offset option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Offset 

func Offset(v int) *OffsetOption

Offset wraps the given value into a OffsetOption.

func (*OffsetOption) Equal 

func (o *OffsetOption) Equal(o2 *OffsetOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*OffsetOption) Get 

func (o *OffsetOption) Get() int

Get retrieves the actual value of the option parameter.

func (OffsetOption) MarshalJSON 

func (o OffsetOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for OffsetOption.

func (*OffsetOption) UnmarshalJSON 

func (o *OffsetOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for OffsetOption.

type OptionalFiltersOption 

type OptionalFiltersOption struct {
	// contains filtered or unexported fields
}

OptionalFiltersOption is a wrapper for an OptionalFilters option parameter. It holds the actual value of the option that can be accessed by calling Get.

func OptionalFilter 

func OptionalFilter(filter string) *OptionalFiltersOption

OptionalFilter returns an OptionalFiltersOption whose value is set to the given string.

func OptionalFilterAnd 

func OptionalFilterAnd(filters ...interface{}) *OptionalFiltersOption

OptionalFilters returns an OptionalFiltersOption whose value is set as an AND of the given filters.

func OptionalFilterOr 

func OptionalFilterOr(filters ...interface{}) *OptionalFiltersOption

OptionalFilters returns an OptionalFiltersOption whose value is set as an OR of the given filters.

func (*OptionalFiltersOption) Equal 

func (o *OptionalFiltersOption) Equal(o2 *OptionalFiltersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*OptionalFiltersOption) Get 

func (o *OptionalFiltersOption) Get() [][]string

Get retrieves the actual value of the option parameter. The slice of slice represents filters that are ORed then ANDed. For instance, the following returned slice: 

[][]string{ {"filter1", "filter2"}, {"filter3"} }

means: 

("filter1" OR "filter2" ) AND "filter 3"

func (OptionalFiltersOption) MarshalJSON 

func (o OptionalFiltersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for OptionalFiltersOption.

func (*OptionalFiltersOption) UnmarshalJSON 

func (o *OptionalFiltersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for OptionalFiltersOption.

type OptionalWordsOption 

type OptionalWordsOption struct {
	// contains filtered or unexported fields
}

OptionalWordsOption is a wrapper for an OptionalWords option parameter. It holds the actual value of the option that can be accessed by calling Get.

func OptionalWords 

func OptionalWords(v ...string) *OptionalWordsOption

OptionalWords wraps the given value into a OptionalWordsOption.

func (*OptionalWordsOption) Equal 

func (o *OptionalWordsOption) Equal(o2 *OptionalWordsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*OptionalWordsOption) Get 

func (o *OptionalWordsOption) Get() []string

Get retrieves the actual value of the option parameter.

func (OptionalWordsOption) MarshalJSON 

func (o OptionalWordsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for OptionalWordsOption.

func (*OptionalWordsOption) UnmarshalJSON 

func (o *OptionalWordsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for OptionalWordsOption.

type PageOption 

type PageOption struct {
	// contains filtered or unexported fields
}

PageOption is a wrapper for an Page option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Page 

func Page(v int) *PageOption

Page wraps the given value into a PageOption.

func (*PageOption) Equal 

func (o *PageOption) Equal(o2 *PageOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*PageOption) Get 

func (o *PageOption) Get() int

Get retrieves the actual value of the option parameter.

func (PageOption) MarshalJSON 

func (o PageOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for PageOption.

func (*PageOption) UnmarshalJSON 

func (o *PageOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for PageOption.

type PaginationLimitedToOption 

type PaginationLimitedToOption struct {
	// contains filtered or unexported fields
}

PaginationLimitedToOption is a wrapper for an PaginationLimitedTo option parameter. It holds the actual value of the option that can be accessed by calling Get.

func PaginationLimitedTo 

func PaginationLimitedTo(v int) *PaginationLimitedToOption

PaginationLimitedTo wraps the given value into a PaginationLimitedToOption.

func (*PaginationLimitedToOption) Equal 

func (o *PaginationLimitedToOption) Equal(o2 *PaginationLimitedToOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*PaginationLimitedToOption) Get 

func (o *PaginationLimitedToOption) Get() int

Get retrieves the actual value of the option parameter.

func (PaginationLimitedToOption) MarshalJSON 

func (o PaginationLimitedToOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for PaginationLimitedToOption.

func (*PaginationLimitedToOption) UnmarshalJSON 

func (o *PaginationLimitedToOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for PaginationLimitedToOption.

type PercentileComputationOption 

type PercentileComputationOption struct {
	// contains filtered or unexported fields
}

PercentileComputationOption is a wrapper for an PercentileComputation option parameter. It holds the actual value of the option that can be accessed by calling Get.

func PercentileComputation 

func PercentileComputation(v bool) *PercentileComputationOption

PercentileComputation wraps the given value into a PercentileComputationOption.

func (*PercentileComputationOption) Equal 

func (o *PercentileComputationOption) Equal(o2 *PercentileComputationOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*PercentileComputationOption) Get 

func (o *PercentileComputationOption) Get() bool

Get retrieves the actual value of the option parameter.

func (PercentileComputationOption) MarshalJSON 

func (o PercentileComputationOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for PercentileComputationOption.

func (*PercentileComputationOption) UnmarshalJSON 

func (o *PercentileComputationOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for PercentileComputationOption.

type PersonalizationImpactOption 

type PersonalizationImpactOption struct {
	// contains filtered or unexported fields
}

PersonalizationImpactOption is a wrapper for an PersonalizationImpact option parameter. It holds the actual value of the option that can be accessed by calling Get.

func PersonalizationImpact 

func PersonalizationImpact(v int) *PersonalizationImpactOption

PersonalizationImpact wraps the given value into a PersonalizationImpactOption.

func (*PersonalizationImpactOption) Equal 

func (o *PersonalizationImpactOption) Equal(o2 *PersonalizationImpactOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*PersonalizationImpactOption) Get 

func (o *PersonalizationImpactOption) Get() int

Get retrieves the actual value of the option parameter.

func (PersonalizationImpactOption) MarshalJSON 

func (o PersonalizationImpactOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for PersonalizationImpactOption.

func (*PersonalizationImpactOption) UnmarshalJSON 

func (o *PersonalizationImpactOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for PersonalizationImpactOption.

type PrimaryOption 

type PrimaryOption struct {
	// contains filtered or unexported fields
}

PrimaryOption is a wrapper for an Primary option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Primary 

func Primary(v string) *PrimaryOption

Primary wraps the given value into a PrimaryOption.

func (*PrimaryOption) Equal 

func (o *PrimaryOption) Equal(o2 *PrimaryOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*PrimaryOption) Get 

func (o *PrimaryOption) Get() string

Get retrieves the actual value of the option parameter.

func (PrimaryOption) MarshalJSON 

func (o PrimaryOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for PrimaryOption.

func (*PrimaryOption) UnmarshalJSON 

func (o *PrimaryOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for PrimaryOption.

type QueryLanguagesOption 

type QueryLanguagesOption struct {
	// contains filtered or unexported fields
}

QueryLanguagesOption is a wrapper for an QueryLanguages option parameter. It holds the actual value of the option that can be accessed by calling Get.

func QueryLanguages 

func QueryLanguages(v ...string) *QueryLanguagesOption

QueryLanguages wraps the given value into a QueryLanguagesOption.

func (*QueryLanguagesOption) Equal 

func (o *QueryLanguagesOption) Equal(o2 *QueryLanguagesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*QueryLanguagesOption) Get 

func (o *QueryLanguagesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (QueryLanguagesOption) MarshalJSON 

func (o QueryLanguagesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for QueryLanguagesOption.

func (*QueryLanguagesOption) UnmarshalJSON 

func (o *QueryLanguagesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for QueryLanguagesOption.

type QueryOption 

type QueryOption struct {
	// contains filtered or unexported fields
}

QueryOption is a wrapper for an Query option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Query 

func Query(v string) *QueryOption

Query wraps the given value into a QueryOption.

func (*QueryOption) Equal 

func (o *QueryOption) Equal(o2 *QueryOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*QueryOption) Get 

func (o *QueryOption) Get() string

Get retrieves the actual value of the option parameter.

func (QueryOption) MarshalJSON 

func (o QueryOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for QueryOption.

func (*QueryOption) UnmarshalJSON 

func (o *QueryOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for QueryOption.

type QueryTypeOption 

type QueryTypeOption struct {
	// contains filtered or unexported fields
}

QueryTypeOption is a wrapper for an QueryType option parameter. It holds the actual value of the option that can be accessed by calling Get.

func QueryType 

func QueryType(v string) *QueryTypeOption

QueryType wraps the given value into a QueryTypeOption.

func (*QueryTypeOption) Equal 

func (o *QueryTypeOption) Equal(o2 *QueryTypeOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*QueryTypeOption) Get 

func (o *QueryTypeOption) Get() string

Get retrieves the actual value of the option parameter.

func (QueryTypeOption) MarshalJSON 

func (o QueryTypeOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for QueryTypeOption.

func (*QueryTypeOption) UnmarshalJSON 

func (o *QueryTypeOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for QueryTypeOption.

type RankingOption 

type RankingOption struct {
	// contains filtered or unexported fields
}

RankingOption is a wrapper for an Ranking option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Ranking 

func Ranking(v ...string) *RankingOption

Ranking wraps the given value into a RankingOption.

func (*RankingOption) Equal 

func (o *RankingOption) Equal(o2 *RankingOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RankingOption) Get 

func (o *RankingOption) Get() []string

Get retrieves the actual value of the option parameter.

func (RankingOption) MarshalJSON 

func (o RankingOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RankingOption.

func (*RankingOption) UnmarshalJSON 

func (o *RankingOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RankingOption.

type ReferersOption 

type ReferersOption struct {
	// contains filtered or unexported fields
}

ReferersOption is a wrapper for an Referers option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Referers 

func Referers(v ...string) *ReferersOption

Referers wraps the given value into a ReferersOption.

func (*ReferersOption) Equal 

func (o *ReferersOption) Equal(o2 *ReferersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ReferersOption) Get 

func (o *ReferersOption) Get() []string

Get retrieves the actual value of the option parameter.

func (ReferersOption) MarshalJSON 

func (o ReferersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ReferersOption.

func (*ReferersOption) UnmarshalJSON 

func (o *ReferersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ReferersOption.

type RemoveStopWordsOption 

type RemoveStopWordsOption struct {
	// contains filtered or unexported fields
}

RemoveStopWordsOption is a wrapper for an RemoveStopWords option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RemoveStopWords 

func RemoveStopWords(v bool) *RemoveStopWordsOption

RemoveStopWords returns an RemoveStopWordsOption whose value is set to the given boolean.

func RemoveStopWordsFor 

func RemoveStopWordsFor(languages ...string) *RemoveStopWordsOption

RemoveStopWordsFor returns an RemoveStopWordsOption whose value is set to the given list of languages.

func (*RemoveStopWordsOption) Equal 

func (o *RemoveStopWordsOption) Equal(o2 *RemoveStopWordsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RemoveStopWordsOption) Get 

func (o *RemoveStopWordsOption) Get() (bool, []string)

Get retrieves the actual value of the option parameter.

func (RemoveStopWordsOption) MarshalJSON 

func (o RemoveStopWordsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RemoveStopWordsOption.

func (*RemoveStopWordsOption) UnmarshalJSON 

func (o *RemoveStopWordsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RemoveStopWordsOption.

type RemoveWordsIfNoResultsOption 

type RemoveWordsIfNoResultsOption struct {
	// contains filtered or unexported fields
}

RemoveWordsIfNoResultsOption is a wrapper for an RemoveWordsIfNoResults option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RemoveWordsIfNoResults 

func RemoveWordsIfNoResults(v string) *RemoveWordsIfNoResultsOption

RemoveWordsIfNoResults wraps the given value into a RemoveWordsIfNoResultsOption.

func (*RemoveWordsIfNoResultsOption) Equal 

func (o *RemoveWordsIfNoResultsOption) Equal(o2 *RemoveWordsIfNoResultsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RemoveWordsIfNoResultsOption) Get 

func (o *RemoveWordsIfNoResultsOption) Get() string

Get retrieves the actual value of the option parameter.

func (RemoveWordsIfNoResultsOption) MarshalJSON 

func (o RemoveWordsIfNoResultsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RemoveWordsIfNoResultsOption.

func (*RemoveWordsIfNoResultsOption) UnmarshalJSON 

func (o *RemoveWordsIfNoResultsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RemoveWordsIfNoResultsOption.

type ReplaceExistingSynonymsOption 

type ReplaceExistingSynonymsOption struct {
	// contains filtered or unexported fields
}

ReplaceExistingSynonymsOption is a wrapper for an ReplaceExistingSynonyms option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ReplaceExistingSynonyms 

func ReplaceExistingSynonyms(v bool) *ReplaceExistingSynonymsOption

ReplaceExistingSynonyms wraps the given value into a ReplaceExistingSynonymsOption.

func (*ReplaceExistingSynonymsOption) Equal 

func (o *ReplaceExistingSynonymsOption) Equal(o2 *ReplaceExistingSynonymsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ReplaceExistingSynonymsOption) Get 

func (o *ReplaceExistingSynonymsOption) Get() bool

Get retrieves the actual value of the option parameter.

func (ReplaceExistingSynonymsOption) MarshalJSON 

func (o ReplaceExistingSynonymsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ReplaceExistingSynonymsOption.

func (*ReplaceExistingSynonymsOption) UnmarshalJSON 

func (o *ReplaceExistingSynonymsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ReplaceExistingSynonymsOption.

type ReplaceSynonymsInHighlightOption 

type ReplaceSynonymsInHighlightOption struct {
	// contains filtered or unexported fields
}

ReplaceSynonymsInHighlightOption is a wrapper for an ReplaceSynonymsInHighlight option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ReplaceSynonymsInHighlight 

func ReplaceSynonymsInHighlight(v bool) *ReplaceSynonymsInHighlightOption

ReplaceSynonymsInHighlight wraps the given value into a ReplaceSynonymsInHighlightOption.

func (*ReplaceSynonymsInHighlightOption) Equal 

func (o *ReplaceSynonymsInHighlightOption) Equal(o2 *ReplaceSynonymsInHighlightOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ReplaceSynonymsInHighlightOption) Get 

func (o *ReplaceSynonymsInHighlightOption) Get() bool

Get retrieves the actual value of the option parameter.

func (ReplaceSynonymsInHighlightOption) MarshalJSON 

func (o ReplaceSynonymsInHighlightOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ReplaceSynonymsInHighlightOption.

func (*ReplaceSynonymsInHighlightOption) UnmarshalJSON 

func (o *ReplaceSynonymsInHighlightOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ReplaceSynonymsInHighlightOption.

type ReplicasOption 

type ReplicasOption struct {
	// contains filtered or unexported fields
}

ReplicasOption is a wrapper for an Replicas option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Replicas 

func Replicas(v ...string) *ReplicasOption

Replicas wraps the given value into a ReplicasOption.

func (*ReplicasOption) Equal 

func (o *ReplicasOption) Equal(o2 *ReplicasOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ReplicasOption) Get 

func (o *ReplicasOption) Get() []string

Get retrieves the actual value of the option parameter.

func (ReplicasOption) MarshalJSON 

func (o ReplicasOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ReplicasOption.

func (*ReplicasOption) UnmarshalJSON 

func (o *ReplicasOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ReplicasOption.

type ResponseFieldsOption 

type ResponseFieldsOption struct {
	// contains filtered or unexported fields
}

ResponseFieldsOption is a wrapper for an ResponseFields option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ResponseFields 

func ResponseFields(v ...string) *ResponseFieldsOption

ResponseFields wraps the given value into a ResponseFieldsOption.

func (*ResponseFieldsOption) Equal 

func (o *ResponseFieldsOption) Equal(o2 *ResponseFieldsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ResponseFieldsOption) Get 

func (o *ResponseFieldsOption) Get() []string

Get retrieves the actual value of the option parameter.

func (ResponseFieldsOption) MarshalJSON 

func (o ResponseFieldsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ResponseFieldsOption.

func (*ResponseFieldsOption) UnmarshalJSON 

func (o *ResponseFieldsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ResponseFieldsOption.

type RestrictHighlightAndSnippetArraysOption 

type RestrictHighlightAndSnippetArraysOption struct {
	// contains filtered or unexported fields
}

RestrictHighlightAndSnippetArraysOption is a wrapper for an RestrictHighlightAndSnippetArrays option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RestrictHighlightAndSnippetArrays 

func RestrictHighlightAndSnippetArrays(v bool) *RestrictHighlightAndSnippetArraysOption

RestrictHighlightAndSnippetArrays wraps the given value into a RestrictHighlightAndSnippetArraysOption.

func (*RestrictHighlightAndSnippetArraysOption) Equal 

func (o *RestrictHighlightAndSnippetArraysOption) Equal(o2 *RestrictHighlightAndSnippetArraysOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RestrictHighlightAndSnippetArraysOption) Get 

func (o *RestrictHighlightAndSnippetArraysOption) Get() bool

Get retrieves the actual value of the option parameter.

func (RestrictHighlightAndSnippetArraysOption) MarshalJSON 

func (o RestrictHighlightAndSnippetArraysOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RestrictHighlightAndSnippetArraysOption.

func (*RestrictHighlightAndSnippetArraysOption) UnmarshalJSON 

func (o *RestrictHighlightAndSnippetArraysOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RestrictHighlightAndSnippetArraysOption.

type RestrictIndicesOption 

type RestrictIndicesOption struct {
	// contains filtered or unexported fields
}

RestrictIndicesOption is a wrapper for an RestrictIndices option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RestrictIndices 

func RestrictIndices(v ...string) *RestrictIndicesOption

RestrictIndices wraps the given value into a RestrictIndicesOption.

func (*RestrictIndicesOption) Equal 

func (o *RestrictIndicesOption) Equal(o2 *RestrictIndicesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RestrictIndicesOption) Get 

func (o *RestrictIndicesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (RestrictIndicesOption) MarshalJSON 

func (o RestrictIndicesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RestrictIndicesOption.

func (*RestrictIndicesOption) UnmarshalJSON 

func (o *RestrictIndicesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RestrictIndicesOption.

type RestrictSearchableAttributesOption 

type RestrictSearchableAttributesOption struct {
	// contains filtered or unexported fields
}

RestrictSearchableAttributesOption is a wrapper for an RestrictSearchableAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RestrictSearchableAttributes 

func RestrictSearchableAttributes(v ...string) *RestrictSearchableAttributesOption

RestrictSearchableAttributes wraps the given value into a RestrictSearchableAttributesOption.

func (*RestrictSearchableAttributesOption) Equal 

func (o *RestrictSearchableAttributesOption) Equal(o2 *RestrictSearchableAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RestrictSearchableAttributesOption) Get 

func (o *RestrictSearchableAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (RestrictSearchableAttributesOption) MarshalJSON 

func (o RestrictSearchableAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RestrictSearchableAttributesOption.

func (*RestrictSearchableAttributesOption) UnmarshalJSON 

func (o *RestrictSearchableAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RestrictSearchableAttributesOption.

type RestrictSourcesOption 

type RestrictSourcesOption struct {
	// contains filtered or unexported fields
}

RestrictSourcesOption is a wrapper for an RestrictSources option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RestrictSources 

func RestrictSources(v string) *RestrictSourcesOption

RestrictSources wraps the given value into a RestrictSourcesOption.

func (*RestrictSourcesOption) Equal 

func (o *RestrictSourcesOption) Equal(o2 *RestrictSourcesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RestrictSourcesOption) Get 

func (o *RestrictSourcesOption) Get() string

Get retrieves the actual value of the option parameter.

func (RestrictSourcesOption) MarshalJSON 

func (o RestrictSourcesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RestrictSourcesOption.

func (*RestrictSourcesOption) UnmarshalJSON 

func (o *RestrictSourcesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RestrictSourcesOption.

type RetrieveMappingsOption added in v3.6.0 

type RetrieveMappingsOption struct {
	// contains filtered or unexported fields
}

RetrieveMappingsOption is a wrapper for an RetrieveMappings option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RetrieveMappings added in v3.6.0 

func RetrieveMappings(v bool) *RetrieveMappingsOption

RetrieveMappings wraps the given value into a RetrieveMappingsOption.

func (*RetrieveMappingsOption) Equal added in v3.6.0 

func (o *RetrieveMappingsOption) Equal(o2 *RetrieveMappingsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RetrieveMappingsOption) Get added in v3.6.0 

func (o *RetrieveMappingsOption) Get() bool

Get retrieves the actual value of the option parameter.

func (RetrieveMappingsOption) MarshalJSON added in v3.6.0 

func (o RetrieveMappingsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RetrieveMappingsOption.

func (*RetrieveMappingsOption) UnmarshalJSON added in v3.6.0 

func (o *RetrieveMappingsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RetrieveMappingsOption.

type RuleContextsOption 

type RuleContextsOption struct {
	// contains filtered or unexported fields
}

RuleContextsOption is a wrapper for an RuleContexts option parameter. It holds the actual value of the option that can be accessed by calling Get.

func RuleContexts 

func RuleContexts(v ...string) *RuleContextsOption

RuleContexts wraps the given value into a RuleContextsOption.

func (*RuleContextsOption) Equal 

func (o *RuleContextsOption) Equal(o2 *RuleContextsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*RuleContextsOption) Get 

func (o *RuleContextsOption) Get() []string

Get retrieves the actual value of the option parameter.

func (RuleContextsOption) MarshalJSON 

func (o RuleContextsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for RuleContextsOption.

func (*RuleContextsOption) UnmarshalJSON 

func (o *RuleContextsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for RuleContextsOption.

type SafeOption 

type SafeOption struct {
	// contains filtered or unexported fields
}

SafeOption is a wrapper for an Safe option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Safe 

func Safe(v bool) *SafeOption

Safe wraps the given value into a SafeOption.

func (*SafeOption) Equal 

func (o *SafeOption) Equal(o2 *SafeOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SafeOption) Get 

func (o *SafeOption) Get() bool

Get retrieves the actual value of the option parameter.

func (SafeOption) MarshalJSON 

func (o SafeOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SafeOption.

func (*SafeOption) UnmarshalJSON 

func (o *SafeOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SafeOption.

type ScopesOption 

type ScopesOption struct {
	// contains filtered or unexported fields
}

ScopesOption is a wrapper for an Scopes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Scopes 

func Scopes(v ...string) *ScopesOption

Scopes wraps the given value into a ScopesOption.

func (*ScopesOption) Equal 

func (o *ScopesOption) Equal(o2 *ScopesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ScopesOption) Get 

func (o *ScopesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (ScopesOption) MarshalJSON 

func (o ScopesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ScopesOption.

func (*ScopesOption) UnmarshalJSON 

func (o *ScopesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ScopesOption.

type SearchableAttributesOption 

type SearchableAttributesOption struct {
	// contains filtered or unexported fields
}

SearchableAttributesOption is a wrapper for an SearchableAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func SearchableAttributes 

func SearchableAttributes(v ...string) *SearchableAttributesOption

SearchableAttributes wraps the given value into a SearchableAttributesOption.

func (*SearchableAttributesOption) Equal 

func (o *SearchableAttributesOption) Equal(o2 *SearchableAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SearchableAttributesOption) Get 

func (o *SearchableAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (SearchableAttributesOption) MarshalJSON 

func (o SearchableAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SearchableAttributesOption.

func (*SearchableAttributesOption) UnmarshalJSON 

func (o *SearchableAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SearchableAttributesOption.

type SeparatorsToIndexOption 

type SeparatorsToIndexOption struct {
	// contains filtered or unexported fields
}

SeparatorsToIndexOption is a wrapper for an SeparatorsToIndex option parameter. It holds the actual value of the option that can be accessed by calling Get.

func SeparatorsToIndex 

func SeparatorsToIndex(v string) *SeparatorsToIndexOption

SeparatorsToIndex wraps the given value into a SeparatorsToIndexOption.

func (*SeparatorsToIndexOption) Equal 

func (o *SeparatorsToIndexOption) Equal(o2 *SeparatorsToIndexOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SeparatorsToIndexOption) Get 

func (o *SeparatorsToIndexOption) Get() string

Get retrieves the actual value of the option parameter.

func (SeparatorsToIndexOption) MarshalJSON 

func (o SeparatorsToIndexOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SeparatorsToIndexOption.

func (*SeparatorsToIndexOption) UnmarshalJSON 

func (o *SeparatorsToIndexOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SeparatorsToIndexOption.

type SimilarQueryOption 

type SimilarQueryOption struct {
	// contains filtered or unexported fields
}

SimilarQueryOption is a wrapper for an SimilarQuery option parameter. It holds the actual value of the option that can be accessed by calling Get.

func SimilarQuery 

func SimilarQuery(v string) *SimilarQueryOption

SimilarQuery wraps the given value into a SimilarQueryOption.

func (*SimilarQueryOption) Equal 

func (o *SimilarQueryOption) Equal(o2 *SimilarQueryOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SimilarQueryOption) Get 

func (o *SimilarQueryOption) Get() string

Get retrieves the actual value of the option parameter.

func (SimilarQueryOption) MarshalJSON 

func (o SimilarQueryOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SimilarQueryOption.

func (*SimilarQueryOption) UnmarshalJSON 

func (o *SimilarQueryOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SimilarQueryOption.

type SnippetEllipsisTextOption 

type SnippetEllipsisTextOption struct {
	// contains filtered or unexported fields
}

SnippetEllipsisTextOption is a wrapper for an SnippetEllipsisText option parameter. It holds the actual value of the option that can be accessed by calling Get.

func SnippetEllipsisText 

func SnippetEllipsisText(v string) *SnippetEllipsisTextOption

SnippetEllipsisText wraps the given value into a SnippetEllipsisTextOption.

func (*SnippetEllipsisTextOption) Equal 

func (o *SnippetEllipsisTextOption) Equal(o2 *SnippetEllipsisTextOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SnippetEllipsisTextOption) Get 

func (o *SnippetEllipsisTextOption) Get() string

Get retrieves the actual value of the option parameter.

func (SnippetEllipsisTextOption) MarshalJSON 

func (o SnippetEllipsisTextOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SnippetEllipsisTextOption.

func (*SnippetEllipsisTextOption) UnmarshalJSON 

func (o *SnippetEllipsisTextOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SnippetEllipsisTextOption.

type SortFacetValuesByOption 

type SortFacetValuesByOption struct {
	// contains filtered or unexported fields
}

SortFacetValuesByOption is a wrapper for an SortFacetValuesBy option parameter. It holds the actual value of the option that can be accessed by calling Get.

func SortFacetValuesBy 

func SortFacetValuesBy(v string) *SortFacetValuesByOption

SortFacetValuesBy wraps the given value into a SortFacetValuesByOption.

func (*SortFacetValuesByOption) Equal 

func (o *SortFacetValuesByOption) Equal(o2 *SortFacetValuesByOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SortFacetValuesByOption) Get 

func (o *SortFacetValuesByOption) Get() string

Get retrieves the actual value of the option parameter.

func (SortFacetValuesByOption) MarshalJSON 

func (o SortFacetValuesByOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SortFacetValuesByOption.

func (*SortFacetValuesByOption) UnmarshalJSON 

func (o *SortFacetValuesByOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SortFacetValuesByOption.

type SumOrFiltersScoresOption 

type SumOrFiltersScoresOption struct {
	// contains filtered or unexported fields
}

SumOrFiltersScoresOption is a wrapper for an SumOrFiltersScores option parameter. It holds the actual value of the option that can be accessed by calling Get.

func SumOrFiltersScores 

func SumOrFiltersScores(v bool) *SumOrFiltersScoresOption

SumOrFiltersScores wraps the given value into a SumOrFiltersScoresOption.

func (*SumOrFiltersScoresOption) Equal 

func (o *SumOrFiltersScoresOption) Equal(o2 *SumOrFiltersScoresOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SumOrFiltersScoresOption) Get 

func (o *SumOrFiltersScoresOption) Get() bool

Get retrieves the actual value of the option parameter.

func (SumOrFiltersScoresOption) MarshalJSON 

func (o SumOrFiltersScoresOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SumOrFiltersScoresOption.

func (*SumOrFiltersScoresOption) UnmarshalJSON 

func (o *SumOrFiltersScoresOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SumOrFiltersScoresOption.

type SynonymsOption 

type SynonymsOption struct {
	// contains filtered or unexported fields
}

SynonymsOption is a wrapper for an Synonyms option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Synonyms 

func Synonyms(v bool) *SynonymsOption

Synonyms wraps the given value into a SynonymsOption.

func (*SynonymsOption) Equal 

func (o *SynonymsOption) Equal(o2 *SynonymsOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*SynonymsOption) Get 

func (o *SynonymsOption) Get() bool

Get retrieves the actual value of the option parameter.

func (SynonymsOption) MarshalJSON 

func (o SynonymsOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SynonymsOption.

func (*SynonymsOption) UnmarshalJSON 

func (o *SynonymsOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for SynonymsOption.

type TagFiltersOption 

type TagFiltersOption struct {
	// contains filtered or unexported fields
}

TagFiltersOption is a wrapper for an TagFilters option parameter. It holds the actual value of the option that can be accessed by calling Get.

func TagFilter 

func TagFilter(filter string) *TagFiltersOption

TagFilter returns an TagFiltersOption whose value is set to the given string.

func TagFilterAnd 

func TagFilterAnd(filters ...interface{}) *TagFiltersOption

TagFilters returns an TagFiltersOption whose value is set as an AND of the given filters.

func TagFilterOr 

func TagFilterOr(filters ...interface{}) *TagFiltersOption

TagFilters returns an TagFiltersOption whose value is set as an OR of the given filters.

func (*TagFiltersOption) Equal 

func (o *TagFiltersOption) Equal(o2 *TagFiltersOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*TagFiltersOption) Get 

func (o *TagFiltersOption) Get() [][]string

Get retrieves the actual value of the option parameter. The slice of slice represents filters that are ORed then ANDed. For instance, the following returned slice: 

[][]string{ {"filter1", "filter2"}, {"filter3"} }

means: 

("filter1" OR "filter2" ) AND "filter 3"

func (TagFiltersOption) MarshalJSON 

func (o TagFiltersOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for TagFiltersOption.

func (*TagFiltersOption) UnmarshalJSON 

func (o *TagFiltersOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for TagFiltersOption.

type TypeOption 

type TypeOption struct {
	// contains filtered or unexported fields
}

TypeOption is a wrapper for an Type option parameter. It holds the actual value of the option that can be accessed by calling Get.

func Type 

func Type(v ...string) *TypeOption

Type wraps the given value into a TypeOption.

func (*TypeOption) Equal 

func (o *TypeOption) Equal(o2 *TypeOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*TypeOption) Get 

func (o *TypeOption) Get() []string

Get retrieves the actual value of the option parameter.

func (TypeOption) MarshalJSON 

func (o TypeOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for TypeOption.

func (*TypeOption) UnmarshalJSON 

func (o *TypeOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for TypeOption.

type TypoToleranceOption 

type TypoToleranceOption struct {
	// contains filtered or unexported fields
}

TypoToleranceOption is a wrapper for an TypoTolerance option parameter. It holds the actual value of the option that can be accessed by calling Get.

func TypoTolerance 

func TypoTolerance(value bool) *TypoToleranceOption

TypoTolerance returns an TypoToleranceOption whose value is set to the given boolean.

func TypoToleranceMin 

func TypoToleranceMin() *TypoToleranceOption

TypoToleranceFor returns an TypoToleranceOption whose value is set to "min".

func TypoToleranceStrict 

func TypoToleranceStrict() *TypoToleranceOption

TypoToleranceFor returns an TypoToleranceOption whose value is set to "strict".

func (*TypoToleranceOption) Equal 

func (o *TypoToleranceOption) Equal(o2 *TypoToleranceOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*TypoToleranceOption) Get 

func (o *TypoToleranceOption) Get() (bool, string)

Get retrieves the actual value of the option parameter.

func (TypoToleranceOption) MarshalJSON 

func (o TypoToleranceOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for TypoToleranceOption.

func (*TypoToleranceOption) UnmarshalJSON 

func (o *TypoToleranceOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for TypoToleranceOption.

type UnretrievableAttributesOption 

type UnretrievableAttributesOption struct {
	// contains filtered or unexported fields
}

UnretrievableAttributesOption is a wrapper for an UnretrievableAttributes option parameter. It holds the actual value of the option that can be accessed by calling Get.

func UnretrievableAttributes 

func UnretrievableAttributes(v ...string) *UnretrievableAttributesOption

UnretrievableAttributes wraps the given value into a UnretrievableAttributesOption.

func (*UnretrievableAttributesOption) Equal 

func (o *UnretrievableAttributesOption) Equal(o2 *UnretrievableAttributesOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*UnretrievableAttributesOption) Get 

func (o *UnretrievableAttributesOption) Get() []string

Get retrieves the actual value of the option parameter.

func (UnretrievableAttributesOption) MarshalJSON 

func (o UnretrievableAttributesOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for UnretrievableAttributesOption.

func (*UnretrievableAttributesOption) UnmarshalJSON 

func (o *UnretrievableAttributesOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for UnretrievableAttributesOption.

type UserDataOption 

type UserDataOption struct {
	// contains filtered or unexported fields
}

UserDataOption is a wrapper for an UserData option parameter. It holds the actual value of the option that can be accessed by calling Get.

func UserData 

func UserData(v interface{}) *UserDataOption

UserData wraps the given value into a UserDataOption.

func (*UserDataOption) Decode added in v3.5.2 

func (o *UserDataOption) Decode(itf interface{}) error

func (*UserDataOption) Equal 

func (o *UserDataOption) Equal(o2 *UserDataOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*UserDataOption) Get 

func (o *UserDataOption) Get() map[string]interface{}

Get retrieves the actual value of the option parameter as a map. If the value is not a map, nil is returned instead. In that case, use the Decode() method to appropriately decode the underlying userData into a different instance type.

func (UserDataOption) MarshalJSON 

func (o UserDataOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for UserDataOption.

func (*UserDataOption) UnmarshalJSON 

func (o *UserDataOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for UserDataOption.

type UserTokenOption 

type UserTokenOption struct {
	// contains filtered or unexported fields
}

UserTokenOption is a wrapper for an UserToken option parameter. It holds the actual value of the option that can be accessed by calling Get.

func UserToken 

func UserToken(v string) *UserTokenOption

UserToken wraps the given value into a UserTokenOption.

func (*UserTokenOption) Equal 

func (o *UserTokenOption) Equal(o2 *UserTokenOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*UserTokenOption) Get 

func (o *UserTokenOption) Get() string

Get retrieves the actual value of the option parameter.

func (UserTokenOption) MarshalJSON 

func (o UserTokenOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for UserTokenOption.

func (*UserTokenOption) UnmarshalJSON 

func (o *UserTokenOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for UserTokenOption.

type ValidUntilOption 

type ValidUntilOption struct {
	// contains filtered or unexported fields
}

ValidUntilOption is a wrapper for an ValidUntil option parameter. It holds the actual value of the option that can be accessed by calling Get.

func ValidUntil 

func ValidUntil(v time.Time) *ValidUntilOption

ValidUntil returns an ValidUntilOption whose value is set to the given time.Time.

func (*ValidUntilOption) Equal 

func (o *ValidUntilOption) Equal(o2 *ValidUntilOption) bool

Equal returns true if the given option is equal to the instance one. In case the given option is nil, we checked the instance one is set to the default value of the option.

func (*ValidUntilOption) Get 

func (o *ValidUntilOption) Get() time.Time

Get retrieves the actual value of the option parameter.

func (ValidUntilOption) MarshalJSON 

func (o ValidUntilOption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ValidUntilOption.

func (*ValidUntilOption) UnmarshalJSON 

func (o *ValidUntilOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ValidUntilOption.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.