struct_compression_analyzer::comparison::compare_groups

Struct GroupComparisonResult

pub struct GroupComparisonResult {
    pub name: String,
    pub description: String,
    pub baseline_metrics: GroupComparisonMetrics,
    pub group_names: Vec<String>,
    pub group_metrics: Vec<GroupComparisonMetrics>,
    pub differences: Vec<GroupDifference>,
}

Expand description

Contains the result of comparing custom field groupings defined in the schema.

Fields§

§name: String

The name of the group comparison. (Copied from schema)

§description: String

A description of the group comparison. (Copied from schema)

§baseline_metrics: GroupComparisonMetrics

Metrics for the baseline group.

§group_names: Vec<String>

Names of the comparison groups in order they were specified in the schema

§group_metrics: Vec<GroupComparisonMetrics>

Metrics for the comparison groups in schema order

§differences: Vec<GroupDifference>

Comparison between other groups and first (baseline) group.

Implementations§

Source §

impl GroupComparisonResult

Source

pub fn from_custom_comparison<T: AsRef<[u8]>>( name: String, description: String, baseline_bytes: &[u8], comparison_byte_slices: &[T], group_names: &[String], compression_options: CompressionOptions, ) -> Result<Self, GroupComparisonError>

Creates comparison results from precomputed group bytes

Arguments:

name - The name of the comparison (copied from schema)
description - The description of the comparison (copied from schema)
baseline_bytes - The bytes of the baseline (original/reference) group.
comparison_byte_slices - The bytes of the comparison groups.
group_names - The names of the comparison groups in order they were specified in the schema.
compression_options - Compression options, zstd compression level, etc.

Trait Implementations§

Source §

impl Clone for GroupComparisonResult

Source §

fn clone(&self) -> GroupComparisonResult

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl From<GroupComparisonResult> for MergedGroupComparisonResult

Source §

fn from(result: GroupComparisonResult) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl UnwindSafe for GroupComparisonResult

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §