Struct Features 

pub struct Features<'a> {
    pub group_by: bool,
    pub group_rollup_mode: Vec<GroupRollupMode>,
    pub split_by: bool,
    pub split_rollup_mode: Vec<SplitRollupMode>,
    pub filter_ops: IndexMap<ColumnType, Vec<Cow<'a, str>>>,
    pub aggregates: IndexMap<ColumnType, Vec<AggSpec<'a>>>,
    pub sort: bool,
    pub expressions: bool,
    pub window_aggregates: IndexMap<ColumnType, Vec<WindowAggSpec<'a>>>,
    pub on_update: bool,
    pub unordered: bool,
}

Describes the capabilities supported by a virtual server handler.

This struct is returned by VirtualServerHandler::get_features to inform clients about which operations are available.

Fields

group_by: bool

Whether group-by aggregation is supported.

group_rollup_mode: Vec<GroupRollupMode>

Which group_by_rollup_mode options are supported

split_by: bool

Whether split-by (pivot) operations are supported.

split_rollup_mode: Vec<SplitRollupMode>

Which split_rollup_mode options are supported. Empty (the default) means ["flat"] - a server must opt in to "rollup" explicitly, as it requires emitting subtotal and grand-total column groups.

filter_ops: IndexMap<ColumnType, Vec<Cow<'a, str>>>

Available filter operators per column type.

aggregates: IndexMap<ColumnType, Vec<AggSpec<'a>>>

Available aggregate functions per column type.

sort: bool

Whether sorting is supported.

expressions: bool

Whether computed expressions are supported.

window_aggregates: IndexMap<ColumnType, Vec<WindowAggSpec<'a>>>

Available window aggregates per column type.

on_update: bool

Whether update callbacks are supported.

unordered: bool

The data store has no reliable natural row order

Trait Implementations

impl<'a> Clone for Features<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Features<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Features<'a>

fn default() -> Features<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Features<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<Features<'a>> for GetFeaturesResp

fn from(value: Features<'a>) -> GetFeaturesResp

Converts to this type from the input type.

impl<'a> PartialEq for Features<'a>

fn eq(&self, other: &Features<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for Features<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Features<'a>

impl<'a> TS for Features<'a>

type WithoutGenerics = Features<'a>

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Features<'a>

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.