VFSConfiguration.md

January 20, 2026 · View on GitHub

VFSConfiguration Class

Configuration options for the Virtual File System.

public sealed record VFSConfiguration : System.IEquatable<Atypical.VirtualFileSystem.Core.VFSConfiguration>

Inheritance System.Object 🡒 VFSConfiguration

Properties
CaseSensitive	Gets or sets whether file and directory operations are case sensitive. Default is false (case insensitive).
Default	Gets the default VFS configuration.
EnableChangeHistory	Gets or sets whether to enable change history tracking. Default is true.
EnableIndexCaching	Gets or sets whether to enable index caching for performance. Default is true.
Events	Gets or sets event handling configuration.
MaxChangeHistorySize	Gets or sets the maximum number of operations to keep in change history. Default is 1000. Set to 0 for unlimited (not recommended).
MaxFileSize	Gets or sets the maximum file size in bytes for content operations. Default is 1MB. Set to 0 for unlimited.
MaxRecursionDepth	Gets or sets the maximum depth for recursive operations. Default is 100 to prevent infinite recursion.
NormalizePaths	Gets or sets whether to normalize paths automatically. Default is true.
PathComparison	Gets or sets the string comparison type for path operations.
PathSeparators	Gets or sets custom path separators. Default uses forward slash.
ValidatePaths	Gets or sets whether to validate paths on creation. Default is true.

Methods
ForPerformance()	Creates a new configuration optimized for performance.
ForSafety()	Creates a new configuration optimized for safety and validation.
WithCaseInsensitivity()	Creates a new configuration with case insensitivity.
WithCaseSensitivity()	Creates a new configuration with case sensitivity enabled.
WithMaxFileSize(long)	Creates a new configuration with custom maximum file size.
WithoutChangeHistory()	Creates a new configuration with change history disabled.