Struct TranslatorConfig 

pub struct TranslatorConfig {
    pub ctx: XetContext,
    pub session: SessionContext,
    pub shard_cache_directory: PathBuf,
    pub shard_session_directory: PathBuf,
    pub force_disable_progress_aggregation: bool,
}

Main configuration for file upload/download operations. Combines session-specific values with runtime-computed paths derived from the endpoint.

Fields

ctx: XetContext

session: SessionContext

shard_cache_directory: PathBuf

Directory for caching shard files.

shard_session_directory: PathBuf

Directory for session-specific shard files.

force_disable_progress_aggregation: bool

Per-session override: when true, progress aggregation is disabled regardless of the global HF_XET_DATA_AGGREGATE_PROGRESS config value.

Implementations

impl TranslatorConfig

pub fn new(ctx: &XetContext, session: SessionContext) -> Result<Self>

Creates a new TranslatorConfig from a SessionContext, computing all derived paths.

On WASM, no filesystem directories are created. Shard cache and session directories are set to empty paths since the WASM build does not exercise disk-backed shard staging or shard-cache paths.

pub fn local_config( ctx: &XetContext, base_dir: impl AsRef<Path>, ) -> Result<Self>

Creates a TranslatorConfig for local filesystem-based storage.

pub fn memory_config( ctx: &XetContext, base_dir: impl AsRef<Path>, ) -> Result<Self>

Creates a TranslatorConfig that uses in-memory storage for XORBs. Shard data still uses file-based storage in the provided base directory.

pub fn test_server_config( ctx: &XetContext, endpoint: impl AsRef<str>, base_dir: impl AsRef<Path>, ) -> Result<Self>

Creates a TranslatorConfig that connects to a CAS server at the given endpoint. Shard cache and session directories are created under the provided base directory. Useful for tests that use LocalTestServer.

pub fn disable_progress_aggregation(self) -> Self

Trait Implementations

impl Clone for TranslatorConfig

fn clone(&self) -> TranslatorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TranslatorConfig

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

Formats the value using the given formatter.