Config

Struct Config 

Source
#[non_exhaustive]
pub struct Config {
Show 19 fields pub root_dir: PathBuf, pub output_dir: PathBuf, pub output_pattern: String, pub format: OutputFormat, pub max_tokens: usize, pub overlap_tokens: usize, pub chunk_safety_margin: usize, pub tokenizer: TokenizerKind, pub prefer_line_boundaries: bool, pub filter_config: FilterConfig, pub file_filter_config: FileFilterConfig, pub preset: Option<PresetKind>, pub dry_run: bool, pub include_binary_files: bool, pub backup_existing: bool, pub template_path: Option<PathBuf>, pub custom_format_name: Option<String>, pub custom_extension: Option<String>, pub custom_data: HashMap<String, Value>,
}
Expand description

Configuration for the llm-utl pipeline.

Use Config::builder() to construct a new configuration.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§root_dir: PathBuf

Root directory to scan for files

§output_dir: PathBuf

Output directory for generated prompts

§output_pattern: String

Output filename pattern (supports {index}, {index:03}, {ext})

§format: OutputFormat

Output format

§max_tokens: usize

Maximum tokens per chunk

§overlap_tokens: usize

Overlap tokens between chunks for context continuity

§chunk_safety_margin: usize

Safety margin to prevent exceeding limits

§tokenizer: TokenizerKind

Tokenizer implementation to use

§prefer_line_boundaries: bool

Whether to prefer splitting at line boundaries

§filter_config: FilterConfig

Code filtering configuration

§file_filter_config: FileFilterConfig

Code filtering configuration

§preset: Option<PresetKind>

LLM preset for specialized output

§dry_run: bool

Dry run mode (no file writes)

§include_binary_files: bool

Include binary files in output

§backup_existing: bool

Create backups of existing files

§template_path: Option<PathBuf>

Path to external template file

§custom_format_name: Option<String>

Custom format name (used with Custom output format)

§custom_extension: Option<String>

Custom file extension (used with Custom output format)

§custom_data: HashMap<String, Value>

Custom data to pass to templates

Implementations§

Source§

impl Config

Source

pub fn builder() -> ConfigBuilder

Creates a new configuration builder.

§Examples
use llm_utl::Config;

let config = Config::builder()
    .root_dir("./src")
    .max_tokens(50_000)
    .build()
    .expect("valid configuration");
Source

pub fn validate(&self) -> Result<()>

Validates the configuration.

§Errors

Returns an error if:

  • Root directory doesn’t exist
  • Token limits are invalid
  • Output pattern is invalid
Source

pub const fn effective_chunk_size(&self) -> usize

Returns the effective chunk size after applying safety margin.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

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
§

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

§

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> 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
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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