Enum TldrError 

pub enum TldrError {
    PathNotFound(PathBuf),
    PathTraversal(PathBuf),
    SymlinkCycle(PathBuf),
    PermissionDenied(PathBuf),
    FileTooLarge {
        path: PathBuf,
        size_mb: usize,
        max_mb: usize,
    },
    EncodingError {
        path: PathBuf,
        detail: String,
    },
    CoverageParseError {
        format: String,
        detail: String,
    },
    NotGitRepository(PathBuf),
    GitOperationInProgress(String),
    GitError(String),
    ParseError {
        file: PathBuf,
        line: Option<u32>,
        message: String,
    },
    UnsupportedLanguage(String),
    FunctionNotFound {
        name: String,
        file: Option<PathBuf>,
        suggestions: Vec<String>,
    },
    InvalidDirection(String),
    LineNotInFunction(u32),
    NoSupportedFiles(PathBuf),
    NotFound {
        entity: String,
        name: String,
        suggestion: Option<String>,
    },
    InvalidArgs {
        arg: String,
        message: String,
        suggestion: Option<String>,
    },
    DaemonError(String),
    ConnectionFailed(String),
    Timeout(String),
    McpError(String),
    SerializationError(String),
    Embedding(String),
    ModelLoadError {
        model: String,
        detail: String,
    },
    IndexTooLarge {
        count: usize,
        max: usize,
    },
    MemoryLimitExceeded {
        estimated_mb: usize,
        max_mb: usize,
    },
    ChunkNotFound {
        file: String,
        function: Option<String>,
    },
    IoError(Error),
}

All possible errors from TLDR operations.

Error messages follow a consistent format to maintain parity with the Python implementation and enable reliable error handling in downstream tooling.

Variants

PathNotFound(PathBuf)

Path does not exist

PathTraversal(PathBuf)

Directory traversal attack detected (path contains ..)

SymlinkCycle(PathBuf)

Symlink creates a cycle

PermissionDenied(PathBuf)

Insufficient permissions to access path

FileTooLarge

File exceeds maximum allowed size

Fields

path: PathBuf

Path of the oversized file.

size_mb: usize

Observed size in megabytes.

max_mb: usize

Configured maximum size in megabytes.

EncodingError

Encoding error when reading file

Fields

path: PathBuf

File path that could not be decoded.

detail: String

Decoder failure details.

CoverageParseError

Coverage report parsing error

Fields

format: String

Coverage format being parsed (for example, lcov).

detail: String

Parser failure details.

NotGitRepository(PathBuf)

Not a git repository (for hotspots command)

GitOperationInProgress(String)

Git operation in progress (rebase, merge, etc.)

GitError(String)

Generic git command failure

ParseError

Syntax or parsing error in source file

Includes optional line number for better error messages (M17, M20).

Fields

file: PathBuf

Source file where parsing failed.

line: Option<u32>

Optional one-based source line where parsing failed.

message: String

Human-readable parse error message.

UnsupportedLanguage(String)

File extension doesn’t match any supported language

FunctionNotFound

Function could not be found in the codebase

Includes suggestions for similar names when available (M20: Error Messages Unusable).

Fields

name: String

Requested function name.

file: Option<PathBuf>

Optional file scope used during lookup.

suggestions: Vec<String>

Suggested nearby function names.

InvalidDirection(String)

Invalid slice direction (must be “backward” or “forward”)

LineNotInFunction(u32)

Line number is not within the specified function

NoSupportedFiles(PathBuf)

No supported files found in directory (T32 mitigation)

NotFound

Generic entity not found error (class, module, etc.)

Fields

entity: String

Kind of entity that was requested (class, module, etc.).

name: String

Name of the missing entity.

suggestion: Option<String>

Optional hint to resolve the issue.

InvalidArgs

Invalid argument value

Fields

arg: String

Argument name that failed validation.

message: String

Validation failure details.

suggestion: Option<String>

Optional corrective hint.

DaemonError(String)

Error communicating with the daemon

ConnectionFailed(String)

Connection to daemon failed

Timeout(String)

Operation timed out

McpError(String)

Error in MCP protocol handling

SerializationError(String)

JSON or other serialization error

Embedding(String)

Embedding model or generation error

ModelLoadError

Model loading/initialization failed

Fields

model: String

Model identifier that failed to initialize.

detail: String

Loader error details.

IndexTooLarge

Index exceeds maximum allowed size (P0 mitigation)

Fields

count: usize

Number of chunks requested for indexing.

max: usize

Configured maximum chunk count.

MemoryLimitExceeded

Estimated memory usage exceeds limit (P0 mitigation)

Fields

estimated_mb: usize

Estimated memory requirement in megabytes.

max_mb: usize

Configured maximum memory limit in megabytes.

ChunkNotFound

Code chunk not found in index

Fields

file: String

File path key used during chunk lookup.

function: Option<String>

Optional function key within the file.

IoError(Error)

General IO error

Implementations

impl TldrError

pub fn function_not_found(name: impl Into<String>) -> Self

Create a FunctionNotFound error with just the name

pub fn function_not_found_in_file( name: impl Into<String>, file: PathBuf, ) -> Self

Create a FunctionNotFound error with file context

pub fn function_not_found_with_suggestions( name: impl Into<String>, file: Option<PathBuf>, suggestions: Vec<String>, ) -> Self

Create a FunctionNotFound error with suggestions (M20)

pub fn parse_error( file: PathBuf, line: Option<u32>, message: impl Into<String>, ) -> Self

Create a ParseError with line information

pub fn is_recoverable(&self) -> bool

Check if this is a recoverable error that allows partial results

pub fn exit_code(&self) -> i32

Get error code for CLI exit status

Exit codes are consistent with Unix conventions:

• 1: General IO error
• 2-9: File system errors
• 10-19: Parse errors
• 20-29: Analysis errors
• 30-39: Network/daemon errors
• 40-49: Serialization errors

pub fn category(&self) -> &'static str

Get a short error category for logging/metrics

Trait Implementations

impl Debug for TldrError

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

Formats the value using the given formatter.

impl Display for TldrError

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

Formats the value using the given formatter.

impl Error for TldrError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DataflowError> for TldrError

fn from(err: DataflowError) -> Self

Converts to this type from the input type.

impl From<Error> for TldrError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TldrError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TldrError

fn from(err: Error) -> Self

Converts to this type from the input type.