https://github.com/rorm-orm/rorm-lib

FFI bindings to rorm-db
https://github.com/rorm-orm/rorm-lib

Last synced: 3 months ago
JSON representation

FFI bindings to rorm-db

• Host: GitHub
• URL: https://github.com/rorm-orm/rorm-lib
• Owner: rorm-orm
• License: mit
• Created: 2022-11-22T01:42:53.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-03-08T22:12:30.000Z (about 2 years ago)
• Last Synced: 2025-01-11T03:40:30.336Z (5 months ago)
• Language: Rust
• Size: 60.5 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
# rorm-lib

![license](https://img.shields.io/github/license/rorm-orm/rorm-lib?label=License)

[![crates-io-version](https://img.shields.io/crates/v/rorm-lib)](https://crates.io/crates/rorm-lib)

[![docs](https://img.shields.io/docsrs/rorm-lib?label=Docs)](https://docs.rs/rorm-lib/latest/rorm/)

`rorm-lib` provides FFI bindings for [rorm-db](https://github.com/rorm-orm/rorm-db).

With the help of this crate, it is possible for other languages to use the orm.

## Compile `rorm-lib`

In order to compile `rorm-lib`, a [rustup](https://rustup.rs/) installation 

is recommended.

```bash

## Clone the repository

git clone --recursive -b main https://github.com/rorm-orm/rorm-lib && cd rorm-lib

## To compile the current development version, use:

# git clone --recursive -b dev https://github.com/rorm-orm/rorm-lib && cd rorm-lib

# Compile the release version (optimized + no debug symbols) 

cargo build -r -p rorm-lib

## or build the debug build:

# cargo build -p rorm-lib

## or also enable the logging functionality:

# cargo build -p rorm-lib -F logging

```

The resulting libraries will be written to `./target/release/` or `./target/debug/`

depending on the build type.

## API definition

The current API definition can be generated by using `cbindgen`:

```bash

# Install / update cbindgen

cargo install -f cbindgen

# Generate header

cbindgen --crate rorm-lib --config cbindgen.toml --output rorm.h

```

The generated header file is located in `./rorm.h`.

## Further notes

To provide a similar experience as `rorm` for users, it is required to build 

an additional layer upon this binding as well as an interface for `rorm-cli`.