Struct PreparedScanner 

pub struct PreparedScanner { /* private fields */ }

Scan options with their policy regular expressions compiled once.

A scanner can be shared between threads. Embedded language scanners (HTML script/style bodies, Markdown fences, Vue and Svelte regions) reuse the same compiled pattern sets as their parent.

Implementations

impl PreparedScanner

pub fn scan_profile( &self, source: &[u8], profile: &DeclarativeProfile, ) -> Result<ScanReport, ProfileError>

Scan a declarative profile with this scanner’s already-compiled policy.

pub fn transform_profile_plan( &self, source: &[u8], profile: &DeclarativeProfile, layout: Layout, ) -> Result<TransformPlan, ProfileError>

Plan a declarative-profile transformation without materializing its output bytes or source map.

impl PreparedScanner

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

Compile the policy patterns in options for reuse across any number of source files.

pub fn options(&self) -> &ScanOptions

The effective options this scanner was prepared from.

pub fn scan(&self, source: &[u8], language: Language) -> ScanReport

Scan one source without recompiling its policy regular expressions.

impl PreparedScanner

pub fn transform_plan( &self, source: &[u8], language: Language, layout: Layout, ) -> TransformPlan

Scan and plan edits with this scanner’s already-compiled policy.

pub fn transform( &self, source: &[u8], language: Language, layout: Layout, ) -> TransformResult

Produce a complete transformation with this scanner’s compiled policy.

pub fn transform_spans_plan( &self, source: &[u8], language: Language, spans: &[(ByteSpan, CommentKind)], layout: Layout, ) -> Result<TransformPlan, ExternalSpanError>

Validate externally supplied spans and plan their edits with this scanner’s already-compiled policy.

pub fn scan_spans( &self, source: &[u8], language: Language, spans: &[(ByteSpan, CommentKind)], ) -> Result<ScanReport, ExternalSpanError>

Validate and classify externally supplied spans without planning edits.

Trait Implementations

impl Clone for PreparedScanner

fn clone(&self) -> PreparedScanner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreparedScanner

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

Formats the value using the given formatter.