Struct AnalysisConfig

Source
pub struct AnalysisConfig {
    pub split_groups: Vec<SplitComparison>,
    pub compare_groups: Vec<CustomComparison>,
}
Expand description

Configuration for analysis operations and output grouping.

Defines how field groups should be compared and analyzed between each other, to find the most optimal bit layout to use for the data.

Fields§

§split_groups: Vec<SplitComparison>

Compare structural equivalence between different field groups. Each comparison verifies that the compared groups have identical total bits and field structure.

§Example

split_groups:
  - name: colors
    group_1: [colors]                       # Original interleaved (structure of array) RGB layout
    group_2: [color_r, color_g, color_b]    # array of structure layout (e.g. RRRGGGBBB)
    description: Compare compression ratio of original interleaved format against grouping of colour components.
§compare_groups: Vec<CustomComparison>

Compare arbitrary field groups defined through custom transformations. Each comparison defines a baseline and one or more comparison groups that should be structurally equivalent but may have different bit layouts.

§Example: Converting 7-bit colors to 8-bit

compare_groups:
- name: convert_7_to_8_bit
  description: "Adjust 7-bit color channel to 8-bit by appending a padding bit."
  baseline: # R, R, R
    - { type: array, field: color7 } # reads all '7-bit' colours from input
  comparisons:
    padded_8bit: # R+0, R+0, R+0
      - type: struct
        fields:
          - { type: field, field: color7 } # reads 1 '7-bit' colour from input
          - { type: padding, bits: 1, value: 0 } # appends 1 padding bit

Trait Implementations§

Source§

impl Debug for AnalysisConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnalysisConfig

Source§

fn default() -> AnalysisConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AnalysisConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,