Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add configuration options for exporting files #39

Open
elrnv opened this issue Sep 29, 2023 · 0 comments
Open

Add configuration options for exporting files #39

elrnv opened this issue Sep 29, 2023 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@elrnv
Copy link
Owner

elrnv commented Sep 29, 2023

There are different ways one could export files, and currently the API tries its best to guess what is intended by looking at the file type and the model definition.
For XML files, there are different ways to export the same Vtk model. In the current implementation when exporting in XML, a Vtk struct is converted to VTKFile which represents the XML format for these files, and while this contains all the information for the final export, the conversion itself assumes a number of defaults (e.g. whether to use base64 encoding).

The proposal here is to add a config struct that can be passed to the export function as well as Vtk::try_into_xml_format, to enable custom export options. This can be combined with the compression scheme, which is already passed in the Vtk::try_into_xml_format function. One use case is to help with debugging as suggested in #38 by enabling ASCII output.

This struct should look like:

struct XMLExportConfig {
    compressor: Compressor,
    compression_level: u32,
    data_format: DataArrayFormat,
    ... // Other configuration options.
}
@elrnv elrnv added help wanted Extra attention is needed enhancement New feature or request labels Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant