1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-22 23:34:47 -05:00
denoland-deno/core
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(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
00_primordials.js fix(ext/timers): create primordial eval (#15110) 2022-09-02 17:55:44 +02:00
01_core.js feat(core): add Deno.core.setPromiseHooks (#15475) 2022-09-28 16:09:33 +02:00
02_error.js fix(core): make errors more resistant to tampering (#15789) 2022-09-07 09:11:16 -04:00
async_cancel.rs chore: use Rust 1.63.0 (#15464) 2022-08-21 19:31:14 +02:00
async_cell.rs build: require safety comments on unsafe code (#13870) 2022-06-26 00:13:24 +02:00
bindings.rs feat(ops): Automatic fast ops creation (#15527) 2022-09-22 10:05:24 +05:30
Cargo.toml feat(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
encode_decode_test.js perf(ops): Monomorphic sync op calls (#15337) 2022-08-11 15:56:56 +02:00
error.rs chore: fix clippy warnings (#15944) 2022-09-19 10:25:03 +02:00
error_builder_test.js perf(ops): Monomorphic sync op calls (#15337) 2022-08-11 15:56:56 +02:00
error_codes.rs fix(core): support classifying ENOTDIR (#14646) 2022-05-17 19:20:57 +02:00
extensions.rs feat(ops): V8 Fast Calls (#15291) 2022-08-21 17:37:53 +05:30
flags.rs chore: update copyright to 2022 (#13306) 2022-01-07 22:09:52 -05:00
gotham_state.rs chore: update copyright to 2022 (#13306) 2022-01-07 22:09:52 -05:00
icudtl.dat chore: upgrade rusty_v8 to 0.43.1 (#14713) 2022-05-26 13:13:01 +02:00
inspector.rs fix(repl): don't terminate on unhandled error events (#15548) 2022-09-02 12:43:39 +02:00
internal.d.ts chore: update copyright year (#13434) 2022-01-20 16:10:16 +09:00
io.rs feat(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
lib.deno_core.d.ts feat(core): add Deno.core.setPromiseHooks (#15475) 2022-09-28 16:09:33 +02:00
lib.rs feat(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
module_specifier.rs fix(core): don't panic on non-existent cwd (#14957) 2022-06-25 09:21:58 +05:30
modules.rs fix(core): Register external references for imports to the SnapshotCreator (#15621) 2022-09-06 14:35:04 +02:00
normalize_path.rs perf(runtime): optimize allocations in read/write checks (#15631) 2022-08-27 20:50:05 +05:30
ops.rs feat(ops): Fallible fast ops (#15989) 2022-09-23 08:25:37 +05:30
ops_builtin.rs feat(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
ops_builtin_v8.rs feat(core): add Deno.core.setPromiseHooks (#15475) 2022-09-28 16:09:33 +02:00
ops_metrics.rs fix(core): remove unsafe in OpsTracker (#15025) 2022-07-01 00:43:25 +02:00
README.md chore(core): update deno_core README (#14042) 2022-03-20 16:08:35 +05:30
resources.rs feat(core): improve resource read & write traits (#16115) 2022-10-09 14:49:25 +00:00
runtime.rs feat(core): Reorder extension initialization (#16136) 2022-10-07 14:38:06 +02:00
serialize_deserialize_test.js perf(ops): Monomorphic sync op calls (#15337) 2022-08-11 15:56:56 +02:00
source_map.rs feat: emit files on demand and fix racy emit (#15220) 2022-07-19 11:58:18 -04:00

Deno Core Crate

crates docs

The main dependency of this crate is rusty_v8, which provides the V8-Rust bindings.

This Rust crate contains the essential V8 bindings for Deno's command-line interface (Deno CLI). The main abstraction here is the JsRuntime which provides a way to execute JavaScript.

The JsRuntime implements an event loop abstraction for the executed code that keeps track of all pending tasks (async ops, dynamic module loads). It is user's responsibility to drive that loop by using JsRuntime::run_event_loop method - it must be executed in the context of Rust's future executor (eg. tokio, smol).

Rust functions can be registered in JavaScript using deno_core::Extension. Use the Deno.core.opSync() and Deno.core.opAsync() functions to trigger the op function callback. A conventional way to write ops is using the deno_ops crate.

Documentation for this crate is thin at the moment. Please see hello_world.rs and http_bench_json_ops.rs as examples of usage.

TypeScript support and lots of other functionality are not available at this layer. See the CLI for that.