Struct FieldTypeDetails

#[non_exhaustive]
pub struct FieldTypeDetails {
    pub field_type: String,
    pub filter_operators: Vec<Operator>,
    pub supported_values: Option<Vec<String>>,
    pub value_regex_pattern: Option<String>,
    pub supported_date_format: Option<String>,
    pub field_value_range: Option<Range>,
    pub field_length_range: Option<Range>,
}

Contains details regarding the supported field type and the operators that can be applied for filtering.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field_type: String

The type of field, such as string, integer, date, and so on.

filter_operators: Vec<Operator>

The list of operators supported by a field.

supported_values: Option<Vec<String>>

The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

value_regex_pattern: Option<String>

The regular expression pattern for the field name.

supported_date_format: Option<String>

The date format that the field supports.

field_value_range: Option<Range>

The range of values this field can hold.

field_length_range: Option<Range>

This is the allowable length range for this field's value.

Implementations

impl FieldTypeDetails

pub fn field_type(&self) -> &str

The type of field, such as string, integer, date, and so on.

pub fn filter_operators(&self) -> &[Operator]

The list of operators supported by a field.

pub fn supported_values(&self) -> &[String]

The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_values.is_none().

pub fn value_regex_pattern(&self) -> Option<&str>

The regular expression pattern for the field name.

pub fn supported_date_format(&self) -> Option<&str>

The date format that the field supports.

pub fn field_value_range(&self) -> Option<&Range>

The range of values this field can hold.

pub fn field_length_range(&self) -> Option<&Range>

This is the allowable length range for this field's value.

impl FieldTypeDetails

pub fn builder() -> FieldTypeDetailsBuilder

Creates a new builder-style object to manufacture FieldTypeDetails.

Trait Implementations

impl Clone for FieldTypeDetails

fn clone(&self) -> FieldTypeDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldTypeDetails

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

Formats the value using the given formatter.

impl PartialEq for FieldTypeDetails

fn eq(&self, other: &FieldTypeDetails) -> 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 StructuralPartialEq for FieldTypeDetails