Struct FacetRequest 

pub struct FacetRequest {
    pub key: JsonPath,
    pub limit: usize,
    pub filter: Option<Filter>,
    pub exact: bool,
}

Facet Request Counts the number of points for each unique value of a payload key.

Fields

key: JsonPath

Payload key to facet on

limit: usize

Maximum number of facet hits to return. Default: 10

filter: Option<Filter>

Look only for points which satisfy these conditions

exact: bool

If true, count exact number of points for each value. If false, count approximate number of points faster. Default: false

Implementations

impl FacetRequestInternal

pub const DEFAULT_LIMIT: usize = 10

pub const fn default_limit() -> usize

pub const fn default_exact() -> bool

Trait Implementations

impl Clone for FacetRequestInternal

fn clone(&self) -> FacetRequestInternal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FacetRequestInternal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FacetRequestInternal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for FacetRequestInternal

fn schema_name() -> String

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for FacetRequestInternal

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FacetRequestInternal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for FacetRequestInternal

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

impl<'v_a> ValidateArgs<'v_a> for FacetRequestInternal

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl StructuralPartialEq for FacetRequestInternal