Struct TransformPlan 

pub struct TransformPlan {
    pub edits: Vec<Edit>,
    pub report: ScanReport,
}

The scan and edits of a transformation, before output bytes are built.

Planning is the useful half of a transformation for a checker, a report renderer, or a caller that wants to inspect or filter edits. It deliberately carries neither a copy of the transformed source nor a source map. Call Self::finish only when those materialized results are needed.

Fields

edits: Vec<Edit>

The edits selected by the scan, sorted and non-overlapping.

report: ScanReport

The scan those edits were decided from.

Implementations

impl TransformPlan

pub fn finish(self, source: &[u8]) -> TransformResult

Apply this plan and build its source map.

Panics

Panics when source is not the source the plan was made for and an edit consequently lies outside it, just like apply_edits.

pub fn output(&self, source: &[u8]) -> Vec<u8>

Build only the transformed bytes, leaving the plan available.

pub fn source_map(&self, source_len: usize) -> SourceMap

Build only the source map, leaving the plan available.

Trait Implementations

impl Clone for TransformPlan

fn clone(&self) -> TransformPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransformPlan

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

Formats the value using the given formatter.

impl Default for TransformPlan

fn default() -> TransformPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransformPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TransformPlan

impl PartialEq for TransformPlan

fn eq(&self, other: &TransformPlan) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TransformPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TransformPlan