Struct FieldMetrics

pub struct FieldMetrics {
    pub name: String,
    pub full_path: String,
    pub depth: usize,
    pub count: u64,
    pub lenbits: u32,
    pub entropy: f64,
    pub lz_matches: u64,
    pub bit_counts: Vec<BitStats>,
    pub bit_order: BitOrder,
    pub value_counts: FxHashMap<u64, u64>,
    pub zstd_size: u64,
    pub original_size: u64,
}

Complete analysis metrics for a single field

Fields

name: String

Name of the field or group

full_path: String

Name of the full path to the field or group

depth: usize

The depth of the field in the group/field chain.

count: u64

Total number of observed values

lenbits: u32

Length of the field or group in bits.

entropy: f64

Shannon entropy in bits

lz_matches: u64

LZ compression matches in the field

bit_counts: Vec<BitStats>

Bit-level statistics. Index of tuple is bit offset.

bit_order: BitOrder

The order of the bits within the field

value_counts: FxHashMap<u64, u64>

Value → occurrence count Count of occurrences for each observed value.

zstd_size: u64

Actual size of the compressed data when compressed with zstandard

original_size: u64

Original size of the data before compression

Implementations

impl FieldMetrics

pub fn try_merge_many( items: &[&Self], ) -> Result<FieldMetrics, AnalysisMergeError>

Merge multiple FieldMetrics objects into one. This gives you an ‘aggregate’ result over a large data set.

Arguments

• items - The items to merge into a new instance.

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

Returns the parent path of the current field. The parent path is the part of the full path before the last dot.

pub fn parent_metrics_or<'a>( &self, results: &'a AnalysisResults, optb: &'a FieldMetrics, ) -> &'a FieldMetrics

Returns the FieldMetrics object for the parent of the current field. Returns None if there is no parent.

pub fn parent_metrics_in_merged_or<'a>( &self, results: &'a MergedAnalysisResults, optb: &'a FieldMetrics, ) -> &'a FieldMetrics

Returns the FieldMetrics object for the parent of the current field in a merged result.

pub fn sorted_value_counts(&self) -> Vec<(&u64, &u64)>

Get sorted value counts descending (value, count)

Trait Implementations

impl Clone for FieldMetrics

fn clone(&self) -> FieldMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for FieldMetrics

fn default() -> FieldMetrics

Returns the “default value” for a type.

impl From<FieldMetrics> for FieldComparisonMetrics

Converts a FieldMetrics object into a FieldComparisonMetrics object.

fn from(value: FieldMetrics) -> Self

Converts to this type from the input type.