Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.38 KB

README.md

File metadata and controls

52 lines (38 loc) · 2.38 KB

atomic-lib

crates.io Released API docs Discord chat MIT licensed github

Status: Beta. Breaking changes are expected until 1.0.

Rust library for using Atomic Data. Powers atomic-cli and atomic-server.

Check out the docs on docs.rs. For code examples, see examples/basic.rs and the many tests in the code.

Features

  • Two stores for Atomic Data:
    • In-memory store for getting / setting data (Store). Useful for clients.
    • On disk database (Db, uses Sled), which powers atomic-server.
  • JSON-AD Parser & Serializer
  • Serialization of atomic data to JSON-AD, plain JSON, RDF, Turtle, N-Triples and JSON-LD.
  • Path traversal
  • Convert Atomic Data to Rust native types
  • Resolve / parse mappings (bookmarks)
  • Validate Atomic Schema
  • Atomic Commits (transactions / delta's / changes / updates / versioning / history)
  • Plugin system (although not very mature)
  • Collections (pagination, sorting, filtering)
  • Querying (using triple pattern fragments)
  • Invites
  • Hierarchy
  • Saving Atomic Config files.

Optional features

Some features of this library are optional, to minimize bundle size and compile times.

db

The db features adds persistence, which means that you can store stuff on an HDD / SSD. It uses [Sled], a performant, embedded key-value store.

rdf

If you need RDF serialization options (Turtle / N-Triples), use this feature.

config

Filesystem management of Atomic Config files. Used in atomic-cli and atomic-server.