Skip to main content

Checker

Struct Checker 

Source
pub struct Checker { /* private fields */ }
Expand description

Reusable checker instance with persistent global definitions.

Checker is Send but not Sync. The underlying Luau Analysis structures are safely movable between threads, but all operations that mutate or read from the checker require exclusive &mut self access, meaning it cannot be concurrently accessed from multiple threads.

Implementations§

Source§

impl Checker

Source

pub fn new() -> Result<Self, Error>

Creates a checker with default options.

Source

pub fn with_options(options: CheckerOptions) -> Result<Self, Error>

Creates a checker with explicit defaults.

Source

pub fn options(&self) -> &CheckerOptions

Returns immutable access to default checker options.

Source

pub fn add_definitions(&mut self, defs: &str) -> Result<(), Error>

Loads Luau definition source using default module label.

Source

pub fn add_definitions_with_name( &mut self, defs: &str, module_name: &str, ) -> Result<(), Error>

Loads Luau definition source with an explicit module label.

Source

pub fn check(&mut self, source: &str) -> Result<CheckResult, Error>

Type-checks a Luau source module with default options.

Source

pub fn check_with_options( &mut self, source: &str, options: CheckOptions<'_>, ) -> Result<CheckResult, Error>

Type-checks a Luau source module with explicit per-call options.

Trait Implementations§

Source§

impl Drop for Checker

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Checker

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.