Struct CreationConfig 

pub struct CreationConfig<State = Unvalidated> { /* private fields */ }

Configuration for archive creation operations.

Controls how archives are created from filesystem sources, including security options, compression settings, and file filtering.

Examples

use exarch_core::creation::CreationConfig;

// Use secure defaults
let config = CreationConfig::default();

// Customize for specific needs
let custom = CreationConfig::default()
    .with_follow_symlinks(true)
    .with_compression_level(9)?;

Typestate

CreationConfig carries a phantom State type parameter — Unvalidated (the default) or Validated — that tracks whether validate has been called. Builder methods are only available in the Unvalidated state; the low-level creation::tar::* / creation::zip::* functions and FormatCreator::create require CreationConfig<Validated>. This makes skipping validation a compile error instead of a runtime gap — a forged or hand-mutated compression_level can no longer reach the flate2/xz2 backends, which panic on out-of-range values instead of returning an error.

Sealing

Fields are private and reachable only through Deref<Target = CreationConfigFields>, so config.compression_level continues to work as plain field access for both states. DerefMut is implemented only for CreationConfig<Unvalidated>, so a CreationConfig<Validated>’s fields cannot be reassigned after the fact — the only way to produce one is validate itself, and it stays that way for its entire lifetime.

Implementations

impl CreationConfig<Unvalidated>

pub fn new() -> Self

Creates a new CreationConfig with default settings.

pub fn with_follow_symlinks(self, follow: bool) -> Self

Sets whether to follow symlinks.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default().with_follow_symlinks(true);
assert!(config.follow_symlinks);

pub fn with_include_hidden(self, include: bool) -> Self

Sets whether to include hidden files.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default().with_include_hidden(true);
assert!(config.include_hidden);

pub fn with_max_file_size(self, max_size: Option<u64>) -> Self

Sets the maximum file size.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default().with_max_file_size(Some(1024 * 1024));
assert_eq!(config.max_file_size, Some(1024 * 1024));

pub fn with_exclude_patterns(self, patterns: Vec<String>) -> Self

Sets the exclude patterns.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default().with_exclude_patterns(vec!["*.log".to_string()]);
assert_eq!(config.exclude_patterns, vec!["*.log".to_string()]);

pub fn with_strip_prefix(self, prefix: Option<PathBuf>) -> Self

Sets the strip prefix.

Examples

use exarch_core::creation::CreationConfig;
use std::path::PathBuf;

let config = CreationConfig::default().with_strip_prefix(Some(PathBuf::from("/base")));
assert_eq!(config.strip_prefix, Some(PathBuf::from("/base")));

pub fn with_compression_level(self, level: u8) -> Result<Self>

Sets the compression level.

Errors

Returns ArchiveError::InvalidCompressionLevel if level is not in the range 1–9.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default().with_compression_level(9)?;
assert_eq!(config.compression_level, Some(9));

pub fn with_preserve_permissions(self, preserve: bool) -> Self

Sets whether to preserve permissions.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default().with_preserve_permissions(false);
assert!(!config.preserve_permissions);

pub fn with_format(self, format: Option<ArchiveType>) -> Self

Sets the archive format.

Examples

use exarch_core::creation::CreationConfig;
use exarch_core::formats::detect::ArchiveType;

let config = CreationConfig::default().with_format(Some(ArchiveType::TarGz));
assert_eq!(config.format, Some(ArchiveType::TarGz));

pub fn validate(self) -> Result<CreationConfig<Validated>>

Validates the configuration, transitioning to the Validated typestate on success.

Consumes self: the only way to obtain a CreationConfig<Validated>, which is what the low-level creation::tar::* / creation::zip::* functions and FormatCreator::create require. Once returned, the Validated config’s fields can no longer be reassigned (see the “Sealing” section on the type-level docs), so this check can never be silently invalidated afterward.

Errors

Returns ArchiveError::InvalidCompressionLevel if compression_level is set but not in the range 1–9.

Examples

use exarch_core::creation::CreationConfig;

let config = CreationConfig::default();
assert!(config.validate().is_ok());

Trait Implementations

impl<State: Clone> Clone for CreationConfig<State>

fn clone(&self) -> CreationConfig<State>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<State: Debug> Debug for CreationConfig<State>

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

Formats the value using the given formatter.

impl Default for CreationConfig<Unvalidated>

fn default() -> Self

Creates a CreationConfig with secure default settings.

Default values:

• follow_symlinks: false
• include_hidden: false
• max_file_size: None
• exclude_patterns: [".git", ".DS_Store", "*.tmp"]
• strip_prefix: None
• compression_level: Some(6)
• preserve_permissions: true
• format: None

impl<State> Deref for CreationConfig<State>

type Target = CreationConfigFields

The resulting type after dereferencing.

fn deref(&self) -> &CreationConfigFields

Dereferences the value.

impl DerefMut for CreationConfig<Unvalidated>

Only Unvalidated configs are mutable — see the “Sealing” section on CreationConfig’s type-level docs for why this is the crux of the typestate guarantee.

fn deref_mut(&mut self) -> &mut CreationConfigFields

Mutably dereferences the value.