Skip to content

chore: remove unused convenience functions and fix timing docs - #59

Merged
danbugs merged 1 commit into
mainfrom
fix/remove-unused-fns
May 17, 2026
Merged

chore: remove unused convenience functions and fix timing docs#59
danbugs merged 1 commit into
mainfrom
fix/remove-unused-fns

Conversation

@danbugs

@danbugs danbugs commented May 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removes three unused public convenience functions (run_vm, run_vm_with_tools, run_vm_with_preopens) — the builder API (Sandbox::builder()) subsumes all of them and run_vm_capture_output (the only used one) is preserved
  • Fixes inconsistent timing claims: README now correctly describes the one-time ~3s warmup vs ~100ms per-run latency from snapshot, matching lib.rs and bin/pyhl.rs

Test plan

  • cargo test --lib passes (51 tests)
  • cargo clippy --lib clean
  • cargo fmt clean
  • Verified run_vm_capture_output and VmOutput still present

Signed-off-by: danbugs <danilochiarlone@gmail.com>

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linux Benchmarks

Details
Benchmark suite Current: 816bb1a Previous: 86d2609 Ratio
hello_world (median) 20 ms 20 ms 1
pandas (median) 110 ms 110 ms 1
density (per VM) 7 MB 7 MB 1
snapshot (disk) 385 MiB 385 MiB 1

This comment was automatically generated by workflow using github-action-benchmark.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Windows Benchmarks

Details
Benchmark suite Current: 816bb1a Previous: 86d2609 Ratio
hello_world (median) 262 ms 245 ms 1.07
pandas (median) 825 ms 725 ms 1.14
density (per VM) 6 MB 6 MB 1
snapshot (disk) 392 MiB 392 MiB 1

This comment was automatically generated by workflow using github-action-benchmark.

@danbugs
danbugs merged commit a9913ef into main May 17, 2026
79 checks passed
@danbugs
danbugs deleted the fix/remove-unused-fns branch May 17, 2026 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant