Struct TypeError

pub struct TypeError(/* private fields */);

Error indicating that a type is invalid.

Note that the “type” of a thing (eg the type of a FunctionParam) in crate::namespace::types is sometimes represented as a Result<Type, TypeError>.

If, for example, a function parameter has an undefined type, we emit a Diagnostic message, give that parameter a “type” of Err(TypeError), and carry on. If/when that parameter is used in the function body, we assume that a diagnostic message about the undefined type has already been emitted, and halt the analysis of the function body.

To ensure that that assumption is sound, a diagnostic must be emitted before creating a TypeError. So that the rust compiler can help us enforce this rule, a TypeError cannot be constructed without providing a DiagnosticVoucher. A voucher can be obtained by calling an error function on an AnalyzerContext. Please don’t try to work around this restriction.

Example: TypeError::new(context.error("something is wrong", some_span, "this thing"))

Implementations

impl TypeError

pub fn new(voucher: DiagnosticVoucher) -> Self

Trait Implementations

impl Clone for TypeError

fn clone(&self) -> TypeError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeError

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

Formats the value using the given formatter.

impl From<ConstEvalError> for TypeError

fn from(err: ConstEvalError) -> Self

Converts to this type from the input type.

impl From<FatalError> for TypeError

fn from(err: FatalError) -> Self

Converts to this type from the input type.

impl From<IncompleteItem> for TypeError

fn from(err: IncompleteItem) -> Self

Converts to this type from the input type.

impl From<TypeError> for ConstEvalError

fn from(err: TypeError) -> Self

Converts to this type from the input type.

impl From<TypeError> for FatalError

fn from(err: TypeError) -> Self

Converts to this type from the input type.

impl Hash for TypeError

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 PartialEq for TypeError

fn eq(&self, other: &TypeError) -> 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 Eq for TypeError

impl StructuralPartialEq for TypeError