1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-25 15:29:32 -05:00
denoland-deno/runtime
Luca Casonato 3b6b75bb46
feat(core): improve resource read & write traits (#16115)
This commit introduces two new buffer wrapper types to `deno_core`. The
main benefit of these new wrappers is that they can wrap a number of
different underlying buffer types. This allows for a more flexible read
and write API on resources that will require less copying of data
between different buffer representations.

- `BufView` is a read-only view onto a buffer. It can be backed by
`ZeroCopyBuf`, `Vec<u8>`, and `bytes::Bytes`.
- `BufViewMut` is a read-write view onto a buffer. It can be cheaply
converted into a `BufView`. It can be backed by `ZeroCopyBuf` or
`Vec<u8>`.

Both new buffer views have a cursor. This means that the start point of
the view can be constrained to write / read from just a slice of the
view. Only the start point of the slice can be adjusted. The end point
is fixed. To adjust the end point, the underlying buffer needs to be
truncated.

Readable resources have been changed to better cater to resources that
do not support BYOB reads. The basic `read` method now returns a
`BufView` instead of taking a `ZeroCopyBuf` to fill. This allows the
operation to return buffers that the resource has already allocated,
instead of forcing the caller to allocate the buffer. BYOB reads are
still very useful for resources that support them, so a new `read_byob`
method has been added that takes a `BufViewMut` to fill. `op_read`
attempts to use `read_byob` if the resource supports it, which falls
back to `read` and performs an additional copy if it does not. For
Rust->JS reads this change should have no impact, but for Rust->Rust
reads, this allows the caller to avoid an additional copy in many
scenarios. This combined with the support for `BufView` to be backed by
`bytes::Bytes` allows us to avoid one data copy when piping from a
`fetch` response into an `ext/http` response.

Writable resources have been changed to take a `BufView` instead of a
`ZeroCopyBuf` as an argument. This allows for less copying of data in
certain scenarios, as described above. Additionally a new
`Resource::write_all` method has been added that takes a `BufView` and
continually attempts to write the resource until the entire buffer has
been written. Certain resources like files can override this method to
provide a more efficient `write_all` implementation.
2022-10-09 14:49:25 +00:00
..
examples feat: implement Web Cache API (#15829) 2022-09-28 17:41:12 +05:30
js refactor(ext/http): remove op_http_read (#16096) 2022-09-30 07:54:12 +02:00
ops feat(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
build.rs feat(npm): implement Node API (#13633) 2022-10-05 19:36:44 +05:30
Cargo.toml chore: forward v1.26.1 release commit to main (#16178) 2022-10-06 16:49:40 -04:00
colors.rs feat(test): change "failures:" headers in test report (#14490) 2022-05-09 10:56:13 +02:00
errors.rs chore: update copyright to 2022 (#13306) 2022-01-07 22:09:52 -05:00
fmt_errors.rs refactor: move JsError formatting to deno_runtime (#15345) 2022-09-02 22:53:23 +02:00
fs_util.rs perf(runtime): optimize allocations in read/write checks (#15631) 2022-08-27 20:50:05 +05:30
inspector_server.rs fix(repl): don't terminate on unhandled error events (#15548) 2022-09-02 12:43:39 +02:00
js.rs Revert "refactor(snapshots): to their own crate (#14794)" (#15076) 2022-07-05 00:12:41 +02:00
lib.rs feat(npm): implement Node API (#13633) 2022-10-05 19:36:44 +05:30
permissions.rs feat(npm): implement Node API (#13633) 2022-10-05 19:36:44 +05:30
README.md chore: fix decendents in runtime readme (#9718) 2021-03-08 13:23:46 +01:00
tokio_util.rs refactor: rename run_basic to run_local (#15068) 2022-07-11 19:02:23 +02:00
web_worker.rs feat(npm): implement Node API (#13633) 2022-10-05 19:36:44 +05:30
worker.rs feat(npm): implement Node API (#13633) 2022-10-05 19:36:44 +05:30
worker_bootstrap.rs perf(ext/console): avoid wrapConsole when not inspecting (#15931) 2022-09-17 15:34:43 +05:30

deno_runtime crate

crates docs

This is a slim version of the Deno CLI which removes typescript integration and various tooling (like lint and doc). Basically only JavaScript execution with Deno's operating system bindings (ops).

Stability

This crate is built using battle-tested modules that were originally in deno crate, however the API of this crate is subject to rapid and breaking changes.

MainWorker

The main API of this crate is MainWorker. MainWorker is a structure encapsulating deno_core::JsRuntime with a set of ops used to implement Deno namespace.

When creating a MainWorker implementors must call MainWorker::bootstrap to prepare JS runtime for use.

MainWorker is highly configurable and allows to customize many of the runtime's properties:

  • module loading implementation
  • error formatting
  • support for source maps
  • support for V8 inspector and Chrome Devtools debugger
  • HTTP client user agent, CA certificate
  • random number generator seed

Worker Web API

deno_runtime comes with support for Worker Web API. The Worker API is implemented using WebWorker structure.

When creating a new instance of MainWorker implementors must provide a callback function that is used when creating a new instance of Worker.

All WebWorker instances are descendents of MainWorker which is responsible for setting up communication with child worker. Each WebWorker spawns a new OS thread that is dedicated solely to that worker.