Skip to main content

DocumentAnalysisOptions

Struct DocumentAnalysisOptions 

Source
pub struct DocumentAnalysisOptions<'a> {
    pub source: &'a str,
    pub main_path: Option<&'a Path>,
    pub signature_roots: &'a [SyntaxNode],
    pub existing_root: Option<SyntaxNode>,
    pub max_parse_errors: Option<usize>,
    pub sig_definition_locations: Option<&'a HashMap<String, (PathBuf, u32)>>,
}
Expand description

Options for building a DocumentAnalysis.

Use DocumentAnalysis::new_with_options to run parsing and analysis with these options. Keeps the API extensible (e.g. max_parse_errors, “skip analysis”) without breaking callers.

Fields§

§source: &'a str

Source code of the main document.

§main_path: Option<&'a Path>

When set and build_include_tree succeeds, analysis uses the include tree.

§signature_roots: &'a [SyntaxNode]

Parsed signature roots (e.g. from parse_signatures) to seed the scope.

§existing_root: Option<SyntaxNode>

Previous syntax root for incremental reparse; when Some, parsing reuses it when applicable.

§max_parse_errors: Option<usize>

Max parse errors to collect in recovery mode (default: 64).

§sig_definition_locations: Option<&'a HashMap<String, (PathBuf, u32)>>

When set, function/global name -> (path, 0-based line) from .sig files for hover links (e.g. getCellX, getCellY).

Trait Implementations§

Source§

impl<'a> Default for DocumentAnalysisOptions<'a>

Source§

fn default() -> DocumentAnalysisOptions<'a>

Returns the “default value” for a type. Read more

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.