Skip to main content

Extractor

Struct Extractor 

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

The main entry point for annotation extraction.

Construct with Extractor::new (auto-discovers ast-grep on PATH) or Extractor::with_binary (explicit binary path).

Implementations§

Source§

impl Extractor

Source

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

Construct an Extractor using the bundled (compile-time embedded) rules and ast-grep from PATH.

Returns ExtractorError::BinaryNotFound if ast-grep cannot be located.

Source

pub fn with_rules(rules_path: PathBuf) -> Result<Self, ExtractorError>

Construct using a custom rules YAML path and ast-grep from PATH.

Source

pub fn with_binary( rules_path: PathBuf, ast_grep_bin: PathBuf, ) -> Result<Self, ExtractorError>

Construct using explicit paths for both the rules file and the binary.

Source

pub fn scan_dir(&self, root: &Path) -> Result<ScanResult, ExtractorError>

Scan an entire directory tree for G8 annotations.

Uses the ignore crate to walk the tree (respects .gitignore). Source files are processed via ast-grep; Markdown sidecars are processed by the native section scanner.

The file .g8/INTENT_SUMMARY.md is excluded from extraction to avoid a feedback loop (per ARCHITECTURE.md §3.2).

Source

pub fn scan_file(&self, file: &Path) -> Result<Vec<Annotation>, ExtractorError>

Scan a single source file for magic-comment annotations.

For Markdown sidecars, delegates to the native section parser. For other file types, invokes ast-grep restricted to that one file.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more