Enum DisplayOptions

pub enum DisplayOptions {
    MetadataOnly,
    CommaSeparatedScalars {
        omit_comma_after_space: bool,
    },
    TreeDisplay,
}

Describe how to convert an array to a string.

See also: Array::display_as and DisplayArrayAs.

Variants

MetadataOnly

Only the top-level encoding id and limited metadata: vortex.primitive(i16, len=5).

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array.display_as(DisplayOptions::MetadataOnly)),
    "vortex.primitive(i16, len=5)",
);

CommaSeparatedScalars

Only the logical values of the array: [0i16, 1i16, 2i16, 3i16, 4i16].

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array.display_as(DisplayOptions::default())),
    "[0i16, 1i16, 2i16, 3i16, 4i16]",
);
assert_eq!(
    format!("{}", array.display_as(DisplayOptions::default())),
    format!("{}", array.display_values()),
);

Fields

omit_comma_after_space: bool

TreeDisplay

The tree of encodings and all metadata but no values.

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
  metadata: EmptyMetadata
  buffer (align=2): 10 B (100.00%)
";
assert_eq!(format!("{}", array.display_as(DisplayOptions::TreeDisplay)), expected);

Trait Implementations

impl Default for DisplayOptions

fn default() -> Self

Returns the “default value” for a type.