Struct sourcemap::SourceMapIndex

pub struct SourceMapIndex { /* private fields */ }

Represents a sourcemap index in memory

Implementations

impl SourceMapIndex

pub fn from_reader<R: Read>(rdr: R) -> Result<SourceMapIndex>

Creates a sourcemap index from a reader over a JSON stream in UTF-8 format. Optionally a “garbage header” as defined by the sourcemap draft specification is supported. In case a regular sourcemap is encountered an error is returned.

Examples found in repository

examples/split_ram_bundle.rs (line 36)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args: Vec<_> = env::args().collect();
    if args.len() < 4 {
        println!("{USAGE}");
        std::process::exit(1);
    }

    let bundle_path = Path::new(&args[1]);
    let ram_bundle = RamBundle::parse_indexed_from_path(bundle_path)
        .or_else(|_| RamBundle::parse_unbundle_from_path(bundle_path))?;

    match ram_bundle.bundle_type() {
        RamBundleType::Indexed => println!("Indexed RAM Bundle detected"),
        RamBundleType::Unbundle => println!("File RAM Bundle detected"),
    }

    let sourcemap_file = File::open(&args[2])?;
    let ism = SourceMapIndex::from_reader(sourcemap_file).unwrap();

    let output_directory = Path::new(&args[3]);
    if !output_directory.exists() {
        panic!("Directory {} does not exist!", output_directory.display());
    }

    println!(
        "Ouput directory: {}",
        output_directory.canonicalize()?.display()
    );
    let ram_bundle_iter = split_ram_bundle(&ram_bundle, &ism).unwrap();
    for result in ram_bundle_iter {
        let (name, sv, sm) = result.unwrap();
        println!("Writing down source: {name}");
        fs::write(output_directory.join(name.clone()), sv.source())?;

        let sourcemap_name = format!("{name}.map");
        println!("Writing down sourcemap: {sourcemap_name}");
        let out_sm = File::create(output_directory.join(sourcemap_name))?;
        sm.to_writer(out_sm)?;
    }
    println!("Done.");

    Ok(())
}

pub fn to_writer<W: Write>(&self, w: W) -> Result<()>

Writes a sourcemap index into a writer.

pub fn from_slice(slice: &[u8]) -> Result<SourceMapIndex>

Creates a sourcemap index from a reader over a JSON byte slice in UTF-8 format. Optionally a “garbage header” as defined by the sourcemap draft specification is supported. In case a regular sourcemap is encountered an error is returned.

pub fn new( file: Option<String>, sections: Vec<SourceMapSection> ) -> SourceMapIndex

Constructs a new sourcemap index from raw components.

• file: an optional filename of the index
• sections: a vector of source map index sections

pub fn new_ram_bundle_compatible( file: Option<String>, sections: Vec<SourceMapSection>, x_facebook_offsets: Option<Vec<Option<u32>>>, x_metro_module_paths: Option<Vec<String>> ) -> SourceMapIndex

Constructs a new sourcemap index from raw components including the facebook RAM bundle extensions.

• file: an optional filename of the index
• sections: a vector of source map index sections
• x_facebook_offsets: a vector of facebook offsets
• x_metro_module_paths: a vector of metro module paths

pub fn get_file(&self) -> Option<&str>

Returns the embedded filename in case there is one.

pub fn set_file(&mut self, value: Option<&str>)

Sets a new value for the file.

pub fn get_section_count(&self) -> u32

Returns the number of sections in this index

pub fn get_section(&self, idx: u32) -> Option<&SourceMapSection>

Looks up a single section and returns it

pub fn get_section_mut(&mut self, idx: u32) -> Option<&mut SourceMapSection>

Looks up a single section and returns it as a mutable ref

pub fn sections(&self) -> SourceMapSectionIter<'_>

Iterates over all sections

pub fn get_original_function_name<'a>( &self, line: u32, col: u32, minified_name: &str, sv: &'a SourceView<'a> ) -> Option<&str>

Given a location, name and minified source file resolve a minified name to an original function name.

This invokes some guesswork and requires access to the original minified source. This will not yield proper results for anonymous functions or functions that do not have clear function names. (For instance it’s recommended that dotted function names are not passed to this function).

pub fn lookup_token(&self, line: u32, col: u32) -> Option<Token<'_>>

Looks up the closest token to a given line and column.

This requires that the referenced sourcemaps are actually loaded. If a sourcemap is encountered that is not embedded but just externally referenced it is silently skipped.

pub fn flatten(&self) -> Result<SourceMap>

Flattens an indexed sourcemap into a regular one. This requires that all referenced sourcemaps are attached.

pub fn flatten_and_rewrite( self, options: &RewriteOptions<'_> ) -> Result<SourceMap>

Flattens an indexed sourcemap into a regular one and automatically rewrites it. This is more useful than plain flattening as this will cause the sourcemap to be properly deduplicated.

Examples found in repository

examples/read.rs (lines 11-14)

fn load_from_reader<R: Read>(mut rdr: R) -> SourceMap {
    match decode(&mut rdr).unwrap() {
        DecodedMap::Regular(sm) => sm,
        DecodedMap::Index(idx) => idx
            .flatten_and_rewrite(&RewriteOptions {
                load_local_source_contents: true,
                ..Default::default()
            })
            .unwrap(),
        _ => panic!("unexpected sourcemap format"),
    }
}

examples/rewrite.rs (lines 28-31)

fn load_from_reader<R: Read>(mut rdr: R) -> SourceMap {
    match decode(&mut rdr).unwrap() {
        DecodedMap::Regular(sm) => sm,
        DecodedMap::Index(idx) => idx
            .flatten_and_rewrite(&RewriteOptions {
                load_local_source_contents: true,
                ..Default::default()
            })
            .unwrap(),
        _ => panic!("unexpected sourcemap format"),
    }
}

pub fn is_for_ram_bundle(&self) -> bool

Returns true if this sourcemap is for a RAM bundle.

pub fn x_facebook_offsets(&self) -> Option<&[Option<u32>]>

Returns embeded x-facebook-offset values.

pub fn x_metro_module_paths(&self) -> Option<&[String]>

Returns embedded metro module paths.

Trait Implementations

impl Clone for SourceMapIndex

fn clone(&self) -> SourceMapIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceMapIndex

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

Formats the value using the given formatter.