Struct datamodel_renderer::datamodel::IndexFieldInput

pub struct IndexFieldInput<'a> { /* private fields */ }

Input parameters for a field in a model index definition.

Implementations

impl<'a> IndexFieldInput<'a>

pub fn new(name: impl Into<Cow<'a, str>>) -> Self

Create a new indexed field.

@@index([foobar])
//       ^^^^^^ name

pub fn sort_order(&mut self, sort_order: impl Into<Cow<'a, str>>)

Define the sort order of the indexed field.

@@index([foobar(sort: Desc)])
//                    ^^^^ here

pub fn length(&mut self, length: u32)

Define the length of the indexed field.

@@index([foobar(length: 32)])
//                      ^^ here

pub fn ops(&mut self, ops: IndexOps<'a>)

Define index operators for the field.

@@index([foobar(ops: MinMaxFoobarOps), type: Brin])
//                      ^^ here

Trait Implementations

impl<'a> Clone for IndexFieldInput<'a>

fn clone(&self) -> IndexFieldInput<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IndexFieldInput<'a>

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

Formats the value using the given formatter.

impl<'a> From<IndexFieldInput<'a>> for Function<'a>

fn from(definition: IndexFieldInput<'a>) -> Self

Converts to this type from the input type.