Struct eszip::v2::EszipV2

pub struct EszipV2 {
    pub ordered_modules: Vec<String>,
    /* private fields */
}

Version 2 of the Eszip format. This format supports streaming sources and source maps.

Fields

ordered_modules: Vec<String>

Implementations

impl EszipV2

pub async fn parse<R: AsyncRead + Unpin>(
    reader: BufReader<R>
) -> Result<(EszipV2, impl Future<Output = Result<BufReader<R>, ParseError>>), ParseError>

Parse a EszipV2 from an AsyncRead stream. This function returns once the header section of the eszip has been parsed. Once this function returns, the data section will not necessarially have been parsed yet. To parse the data section, poll/await the future returned in the second tuple slot.

pub fn add_import_map(&mut self, specifier: String, source: Arc<Vec<u8>>)

Add an import map to the eszip archive. The import map will always be placed at the top of the archive, so it can be read before any other modules are loaded.

If a module with this specifier is already present, then this is a no-op (except that this specifier will now be at the top of the archive).

pub fn into_bytes(self) -> Vec<u8>

Serialize the eszip archive into a byte buffer.

pub fn from_graph(
    graph: ModuleGraph,
    emit_options: EmitOptions
) -> Result<Self, Error>

Turn a deno_graph::ModuleGraph into an EszipV2. All modules from the graph will be transpiled and stored in the eszip archive.

The ordering of the modules in the graph is dependant on the module graph tree. The root module is added to the top of the archive, and the leaves to the end. This allows for efficient deserialization of the archive right into an isolate.

pub fn get_module(&self, specifier: &str) -> Option<Module>

Get the module metadata for a given module specifier. This function will follow redirects. The returned module has functions that can be used to obtain the module source and source map.

pub fn specifiers(&self) -> Vec<String>

Trait Implementations

impl Debug for EszipV2

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

Formats the value using the given formatter.

impl Default for EszipV2

fn default() -> EszipV2

Returns the “default value” for a type.