rustkernel 0.0.11

Kernel for running Rust code interactively in VS Code, will later be extended to other platforms
Documentation

Rustkernel

Introduction

This kernel is made primarily for running code generated by VS Code Notebooks, it takes requests in the form of Rust code along with VS Code Notebook cell information. Data is retained in memory as long as the server is running, it's meant only for a single client and it has no security features whatsoever, don't use this as a server to process unknown http requests!

It's currently being used just for the VS Code extension - Rustnote.

This is still in the experimental stages, there are many features to be added.

Links

Quick Start

To start a server on port 8787 and await requests:

cargo install rustkernel 
rustkernel

Request format

Request should be a POST request to root: /, the body should match the documentation structure here The only header required at this stage is Content-Length: [len of body]

Currently working

  • - Take in Rust code, run it and return stdout / stderr
  • - Work with VS Code Notebook features e.g. cell order may change

In development

  • If the file that notebook is being run from changes, reset state
  • Extract functions from code and put them outside the fn main body
  • Move use, structs and enums outside the fn main body
  • Add use required crates to cargo.toml
  • Pre-cache most popular crates, run this as an opt in background process
  • Environment variable to set the port
  • Move to web framework for security features
  • Use traits to allow for use from VS Code or from browser
  • On request where last item is an expression, return debug/format output in nicely formatted html that can be rendered in VS Code or a browser.