Struct FieldDef 

pub struct FieldDef {
    pub name: String,
    pub kind: ValueKind,
    pub protection: FieldProtection,
    pub indexed: bool,
    pub required: bool,
    pub search: FieldIndex,
}

Fields

name: String

kind: ValueKind

protection: FieldProtection

indexed: bool

Indexed fields support crate::query::TargetFilter lookups (current and historical values). RSA-protected fields cannot be indexed.

required: bool

search: FieldIndex

Blind token index for prefix/substring/case-insensitive search — see FieldIndex. Text fields only.

Implementations

impl FieldDef

pub fn text(name: &str) -> Self

pub fn indexed(self) -> Self

pub fn required(self) -> Self

pub fn kind(self, kind: ValueKind) -> Self

pub fn protection(self, p: FieldProtection) -> Self

pub fn search(self, idx: FieldIndex) -> Self

Attach a blind token index — see FieldIndex for the search shapes and the leakage trade-off.

Trait Implementations

impl Clone for FieldDef

fn clone(&self) -> FieldDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FieldDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.