Skip to main content

check_finalize_dict_size

Function check_finalize_dict_size 

Source
pub fn check_finalize_dict_size(dict_size: usize) -> Result<()>
Available on crate feature dict-builder only.
Expand description

Refuse a dict_size finalize_raw_dict cannot fill, from the size alone: below MIN_TRAINED_DICT_SIZE. Finalizing checks it first, before the samples; a caller holding the samples somewhere costly to walk can run it before that.

§Errors

InvalidInput carrying TrainingError::DictionaryTooSmall.

§Examples

use structured_zstd::dictionary::{
    MIN_TRAINED_DICT_SIZE, TrainingError, check_finalize_dict_size,
};

assert!(check_finalize_dict_size(MIN_TRAINED_DICT_SIZE).is_ok());
let err = check_finalize_dict_size(MIN_TRAINED_DICT_SIZE - 1).unwrap_err();
assert_eq!(TrainingError::of(&err), Some(TrainingError::DictionaryTooSmall));