Enum ModuleError

#[non_exhaustive]
pub enum ModuleError {
    Interrupted(Id),
    Timeout(Id),
    Cursor(Id),
}

An error type for script module analysis.

Some variants of this enum (such as Cursor) represent errors indicating that the arguments supplied to the function are not valid. Other variants indicate that the result cannot be computed due to specific reasons.

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.

Interrupted(Id)

Indicates that the function cannot fulfill the request because another thread is attempting to revoke the current read or write access to this script module in a multi-threaded environment.

If you encounter this error in a worker thread, you should drop the module’s read or write access object to give priority to another thread. After dropping the access object, it is recommended to pause the worker thread for a short amount of time before retrying the operation by acquiring a new module access guard.

In single-threaded programs, this error should never occur unless access handles are manually triggered.

See the ScriptModule documentation for more details about multi-threaded analysis tools.

Timeout(Id)

Indicates that the analysis operation cannot be completed within the predefined amount of time.

This type of error is rare and may occur only in specific edge cases. The internal semantic analysis algorithm allocates generous timeout limits for semantic operations, which should be sufficient to handle a wide range of semantic requests in large source code texts, even on low-end machines. However, if a request operation takes too long, the analyzer may decide to give up and return a Timeout error.

In such cases, rerunning the operation typically has no benefit, so you can either display an error message to the user or silently ignore the request. If implementing a hand-written LSP server, you may choose to return an empty response to the language client.

Cursor(Id)

Indicates that the addressed source code character or range of characters is not valid for the underlying script module.

Trait Implementations

impl Clone for ModuleError

fn clone(&self) -> ModuleError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleError

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

Formats the value using the given formatter.

impl Display for ModuleError

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

Formats the value using the given formatter.

impl Error for ModuleError

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 Hash for ModuleError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Identifiable for ModuleError

fn id(&self) -> Id

Returns the globally unique identifier of the compilation unit to which this object belongs.

impl Ord for ModuleError

fn cmp(&self, other: &ModuleError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModuleError

fn eq(&self, other: &ModuleError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ModuleError

fn partial_cmp(&self, other: &ModuleError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ModuleError

impl Eq for ModuleError

impl StructuralPartialEq for ModuleError