Skip to main content

ConfigValueGroup

Struct ConfigValueGroup 

Source
pub struct ConfigValueGroup {
    pub compression_scheme_retest_interval: usize,
    pub compression_policy: ConfigEnum,
    pub simulation_max_bytes: Option<ByteSize>,
    pub simulation_max_chunks: Option<usize>,
}
Expand description

ConfigValueGroup struct containing all configurable values

Fields§

§compression_scheme_retest_interval: usize

How often should we retest the compression scheme? Determining the optimal compression scheme takes time, but it also minimizes the storage costs of the data.

If set to zero, it’s set once per file block per xorb.

The default value is 32.

Use the environment variable HF_XET_XORB_COMPRESSION_SCHEME_RETEST_INTERVAL to set this value.

§compression_policy: ConfigEnum

Compression policy for xorb data. Valid values: “” or “auto” for automatic detection, “none”, “lz4”, “bg4-lz4”. When set to “” or “auto”, the best compression scheme is chosen based on data analysis.

The default value is “auto” (auto-detect).

Use the environment variable HF_XET_XORB_COMPRESSION_POLICY to set this value.

§simulation_max_bytes: Option<ByteSize>

Override the maximum xorb size in bytes for simulation mode. When set to Some(value), this overrides the hard-coded MAX_XORB_BYTES cutting threshold in simulation builds. When None (default), the standard constant is used.

Only effective when the simulation feature is enabled.

Use the environment variable HF_XET_XORB_SIMULATION_MAX_BYTES to set this value.

§simulation_max_chunks: Option<usize>

Override the maximum xorb chunk count for simulation mode. When set to Some(value), this overrides the hard-coded MAX_XORB_CHUNKS cutting threshold in simulation builds. When None (default), the standard constant is used.

Only effective when the simulation feature is enabled.

Use the environment variable HF_XET_XORB_SIMULATION_MAX_CHUNKS to set this value.

Implementations§

Source§

impl ConfigValueGroup

Source

pub fn new() -> Self

Create a new instance with default values only (no environment variable overrides).

Source

pub fn apply_env_overrides(&mut self)

Apply environment variable overrides to this configuration group.

The group name is derived from the module path. For example, in module xet_config::groups::data, the env var for TEST_INT would be HF_XET_DATA_TEST_INT.

Source

pub fn field_names() -> &'static [&'static str]

Returns the list of field names in this configuration group.

Source

pub fn get(&self, name: &str) -> Result<String, ConfigError>

Get a configuration field’s string representation by name.

Trait Implementations§

Source§

impl AsRef<ConfigValueGroup> for ConfigValueGroup

Source§

fn as_ref(&self) -> &ConfigValueGroup

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for ConfigValueGroup

Source§

fn clone(&self) -> ConfigValueGroup

Returns a duplicate 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 Debug for ConfigValueGroup

Source§

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

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

impl Default for ConfigValueGroup

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<E> ResultError for E
where E: Send + Debug + Sync,

Source§

impl<T> ResultType for T
where T: Send + Clone + Sync + Debug,