Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    UnsupportedFilePattern {
        server: ServerId,
        pattern: UnsupportedFilePattern,
    },
    NotUtf8(FromUtf8Error),
    FileTooLarge(SizeExceeded),
    DuplicateEnvKey {
        server: ServerId,
        error: DuplicateEnvKey,
    },
    InvalidEnvValue {
        server: ServerId,
        key: EnvKey,
        error: InvalidEnvValue,
    },
    EnvTooLarge {
        server: ServerId,
        error: EnvTooLarge,
    },
    ArgContainsNul {
        server: ServerId,
        error: InvalidServerArgs,
    },
    NoParentDirectory {
        path: PathBuf,
    },
    SelectionAutoOnNonTypescript {
        language: LanguageId,
    },
    UnknownAllowedServer {
        server: ServerId,
        configured: Vec<ServerId>,
    },
    DuplicateServerId {
        id: ServerId,
        first: Box<EntrySummary>,
        second: Box<EntrySummary>,
    },
    TwoCatchAllServers {
        language: LanguageId,
        existing: ServerId,
        id: ServerId,
    },
    ToolClaimedTwice {
        tool: ToolKind,
        language: LanguageId,
        existing: ServerId,
        id: ServerId,
    },
    UnresolvableWorkspaceRoot {
        written: PathBuf,
        base_dir: PathBuf,
        probe: PathBuf,
        source: Error,
    },
}

A configuration value that is invalid in the context of the entry that holds it.

Field-level rules live in the types of the fields (a rejected value cannot be built); this enum carries what only the surrounding entry or the whole configuration can add, such as which server a bad value belongs to.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnsupportedFilePattern

A server entry lists a file_patterns form that maps to no extension.

Fields

server: ServerId

The id of the entry that holds the pattern.

pattern: UnsupportedFilePattern

The rejected pattern and the supported forms.

NotUtf8(FromUtf8Error)

The config file’s bytes are not UTF-8.

FileTooLarge(SizeExceeded)

The config file is over its fixed size limit, which is not configurable.

DuplicateEnvKey

A server’s env table sets one variable twice, which the host treats as one name.

Fields

server: ServerId

The id of the entry that holds the table.

error: DuplicateEnvKey

The colliding keys.

InvalidEnvValue

A server’s env table holds a value the operating system cannot pass.

Fields

server: ServerId

The id of the entry that holds the table.

key: EnvKey

The variable whose value is invalid.

error: InvalidEnvValue

Why the value is invalid.

EnvTooLarge

A server’s env table is too large to pass to a process.

Fields

server: ServerId

The id of the entry that holds the table.

error: EnvTooLarge

Which size limit the table is over.

ArgContainsNul

An entry of a server’s args holds a NUL, which the operating system cannot pass in an argument.

Fields

server: ServerId

The id of the entry that holds the argument.

error: InvalidServerArgs

Which argument holds the NUL.

NoParentDirectory

A config path has no directory to resolve relative entries against.

Fields

path: PathBuf

The config path.

SelectionAutoOnNonTypescript

selection = "auto" on an entry that is not typescript-language-server.

Fields

language: LanguageId

The language of the offending entry.

UnknownAllowedServer

An allowed server id names no configured server.

Fields

server: ServerId

The allowed id that matches nothing.

configured: Vec<ServerId>

The ids of the configured servers.

DuplicateServerId

Two applicable entries share one server id.

Fields

id: ServerId

The shared id.

first: Box<EntrySummary>

The first entry.

second: Box<EntrySummary>

The second entry.

TwoCatchAllServers

A language has two servers that both omit handles.

Fields

language: LanguageId

The language both serve.

existing: ServerId

The server registered first.

id: ServerId

The server that collides with it.

ToolClaimedTwice

Two servers of one language claim the same tool in handles.

Fields

tool: ToolKind

The contested tool.

language: LanguageId

The language both serve.

existing: ServerId

The server registered first.

id: ServerId

The server that collides with it.

UnresolvableWorkspaceRoot

A configured workspace root cannot be canonicalized.

Fields

written: PathBuf

The root as written in the config.

base_dir: PathBuf

The directory a relative root is resolved against.

probe: PathBuf

The path that was canonicalized.

source: Error

Why canonicalization failed.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

Formats the value using the given formatter.

impl Error for ConfigError

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<ConfigError> for Error

fn from(source: ConfigError) -> Self

Converts to this type from the input type.