https://github.com/grayjack/janetrs

Rust high level bindings for Janet
https://github.com/grayjack/janetrs

binding bindings janet janet-lang library rust rust-lang

Last synced: 7 days ago
JSON representation

Rust high level bindings for Janet

• Host: GitHub
• URL: https://github.com/grayjack/janetrs
• Owner: GrayJack
• License: mit
• Created: 2020-06-11T23:29:21.000Z (over 4 years ago)
• Default Branch: dev
• Last Pushed: 2024-04-24T10:00:26.000Z (8 months ago)
• Last Synced: 2024-05-10T09:56:09.088Z (8 months ago)
• Topics: binding, bindings, janet, janet-lang, library, rust, rust-lang
• Language: Rust
• Homepage:
• Size: 8.2 MB
• Stars: 58
• Watchers: 5
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# JanetRS

[![Hits-of-Code](https://hitsofcode.com/github/grayjack/janetrs?branch=dev)](https://hitsofcode.com/view/github/grayjack/janetrs?branch=dev)

[![Build Status](https://github.com/GrayJack/janetrs/workflows/Check%20and%20Test/badge.svg)](https://github.com/GrayJack/janetrs/actions)

[![Crates.io](https://img.shields.io/crates/v/janetrs?logo=rust)](https://crates.io/crates/janetrs)

[![Docs latest release](https://img.shields.io/static/v1?label=Docs&message=latest&color=blue&logo=rust)](https://docs.rs/janetrs/)

[![Docs dev branch](https://img.shields.io/static/v1?label=Docs&message=dev&color=lightgray&logo=rust)](https://grayjack.github.io/janetrs/janetrs/index.html)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENCE)

A crate with high level bindings to Janet C API.

## Goals

Provide a safe and ergonomic interface to the Janet C API to create Janet

clients and Janet modules/libraries using Rust.

This project still are in it's early stages, so breaking changes may happen,

there is no minimal supported Rust version (MSRV) yet.

## Cargo Features

- `std`: Enable some trait impl for types that only exist on the `std` and the

  Error trait

- `unicode`: Enable more methods for JanetString and JanetBuffer

- `inline-more`: More aggressive inlining

- `amalgation`: Link the Janet runtime to the package, enabling to use the

  client module

- `unicode`: Enable some unicode methods for JanetString and JanetBuffer

- `system`: Use system header to get Janet functions

- `link-system`: Link the Janet runtime to the package from the system, enabling

  to use the client module

- `nightly`: Enable some parts of the crate that uses nightly features, to use

  this feature you must compile the crate using a nightly rust version

By default, the following features are enabled: `std`, `unicode`, `amalgation`.

**Note:** If you don't need the Janet runtime (eg. making a Janet Library), you can use disable the default features

```toml

janetrs = { version = "0.7.0", default-features = false, features = ["std", "unicode"] }

```

## Environment variables

**These variables are only used when the `amalgation` feature is enabled**

It is possible to use environment variables to overwrite some Janet definitions.

- `JANET_RECURSION_GUARD=`

- `JANET_MAX_PROTO_DEPTH=`

- `JANET_MAX_MACRO_EXPAND=`

- `JANET_STACK_MAX=`

## Licensing

This software is licensed under the terms of the

[MIT Public License](./LICENSE).

### TODO: Types: Lacking or Incomplete

- [ ] Marshaling

`[ ]: Lacking` `[I]: Incomplete` `[X]: Done`

Probably there is much more missing, for that you can use the `lowlevel` module

to access the raw C API of Janet

### TODO: Lib level

- Better docs.

- Marshalling mechanism

## Acknowledgments

- [Calvin Rose](https://github.com/bakpakin) for creating this amazing language

  called Janet

- [andrewchambers](https://github.com/andrewchambers) for janet_ll crate and

  discuss with us some ideas for the abstractions of this crate