Skip to main content

FieldType

Enum FieldType 

Source
pub enum FieldType {
Show 14 variants Text, Keyword, Integer, Long, Float, Double, Boolean, Date, DenseVector { dims: usize, quantization: QuantizationType, }, GeoPoint, Nested, GeoShape, TokenCount, Ip,
}
Expand description

The data type of a field in a Luci index.

M0 types cover text, keyword, numeric, boolean, and date. Vector, geospatial, and nested types are added in later milestones.

See [[architecture-api-surface#Schema Definition]].

Variants§

§

Text

Full-text field, analyzed into tokens for search. Supports match, match_phrase, and query_string queries.

§

Keyword

Exact-value string field. Not analyzed. Supports term, terms, prefix, wildcard, regexp, and exists queries. Stored as dictionary-encoded columnar data for fast aggregations and sorting.

§

Integer

32-bit signed integer.

§

Long

64-bit signed integer.

§

Float

32-bit IEEE 754 float.

§

Double

64-bit IEEE 754 double.

§

Boolean

Boolean value (true / false).

§

Date

Date/time value. Stored internally as epoch milliseconds (i64). Accepts ISO 8601 strings and epoch millis on input.

§

DenseVector

Dense vector for kNN search. Fixed dimensionality and quantization scheme. Both must be set explicitly when constructing the variant directly; Self::dense_vector builds one with QuantizationType::DEFAULT.

Fields

§dims: usize
§quantization: QuantizationType
§

GeoPoint

Geographic point (latitude, longitude).

§

Nested

Nested object array — each object indexed as a hidden document.

§

GeoShape

Geographic shape (Polygon, LineString, etc.) for spatial relation queries. Indexed in a packed R-tree for efficient candidate selection.

See [[feature-geo-shape]] and [[geospatial]].

§

TokenCount

Token count: accepts a string, analyzes it, stores the number of tokens as an integer. Supports range queries and numeric aggregations. In ES this is typically a multi-field; in Luci it’s a standalone field.

§

Ip

IP address (IPv4 and IPv6). Stored as keyword for term queries and as numeric for range queries. Supports CIDR notation in term queries.

Implementations§

Source§

impl FieldType

Source

pub fn from_es_name(name: &str) -> Result<Self>

Parse a field type name from an ES-compatible mapping string.

§Errors

Returns LuciError::InvalidQuery for unrecognized type names.

Source

pub fn es_name(&self) -> &'static str

The ES-compatible type name used in JSON mappings.

Source

pub fn is_numeric(&self) -> bool

Whether this type is numeric (supports range queries, numeric sort, and metric aggregations).

Source

pub fn is_dense_vector(&self) -> bool

Whether this type is a dense vector.

Source

pub fn vector_dims(&self) -> Option<usize>

Get vector dimensions, or None if not a vector type.

Source

pub fn vector_quantization(&self) -> Option<QuantizationType>

Get the configured quantization scheme, or None if not a vector type.

Source

pub fn dense_vector(dims: usize) -> Self

Construct a DenseVector field type with the given dimensionality and the default quantization. Convenience for tests and code that doesn’t need to override the default.

Trait Implementations§

Source§

impl Clone for FieldType

Source§

fn clone(&self) -> FieldType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for FieldType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FieldType

Source§

impl Hash for FieldType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FieldType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for FieldType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool