Struct ViewConfig 

pub struct ViewConfig {
    pub group_by: Vec<String>,
    pub split_by: Vec<String>,
    pub sort: Vec<Sort>,
    pub filter: Vec<Filter>,
    pub filter_op: FilterReducer,
    pub expressions: Expressions,
    pub columns: Vec<Option<String>>,
    pub aggregates: HashMap<String, Aggregate>,
    pub group_by_depth: Option<u32>,
}

Fields

group_by: Vec<String>

split_by: Vec<String>

sort: Vec<Sort>

filter: Vec<Filter>

filter_op: FilterReducer

expressions: Expressions

columns: Vec<Option<String>>

aggregates: HashMap<String, Aggregate>

group_by_depth: Option<u32>

Implementations

impl ViewConfig

pub fn reset(&mut self, reset_expressions: bool)

pub fn apply_update(&mut self, update: ViewConfigUpdate) -> bool

Apply ViewConfigUpdate to a ViewConfig, ignoring any fields in update which were unset.

pub fn is_aggregated(&self) -> bool

pub fn is_column_expression_in_use(&self, name: &str) -> bool

pub fn is_equivalent(&self, other: &Self) -> bool

ViewConfig carries additional metadata in the form of None columns which are filtered befor ebeing passed to the engine, but whose position is a placeholder for Viewer functionality. is_equivalent tests equivalency from the perspective of the engine.

Trait Implementations

impl Clone for ViewConfig

fn clone(&self) -> ViewConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewConfig

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

Formats the value using the given formatter.

impl Default for ViewConfig

fn default() -> ViewConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ViewConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ViewConfig> for ViewConfig

fn from(value: ViewConfig) -> Self

Converts to this type from the input type.

impl From<ViewConfig> for ViewConfigUpdate

fn from(value: ViewConfig) -> Self

Converts to this type from the input type.

impl From<ViewConfigUpdate> for ViewConfig

fn from(value: ViewConfigUpdate) -> Self

Converts to this type from the input type.

impl PartialEq for ViewConfig

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for ViewConfig

type WithoutGenerics = ViewConfig

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 = ViewConfig

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 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 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 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.

impl StructuralPartialEq for ViewConfig