Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2025-10-11 10:08:29 -04:00
Code Issues Projects Releases Packages Wiki Activity
veilid/veilid-core
History
Christien Rioux 4e92fd0911 checkpoint
2025-10-09 13:34:47 -04:00
..
examples immutable config 2025-09-11 16:59:09 -04:00
proto checkpoint 2025-10-09 08:51:06 -04:00
src checkpoint 2025-10-09 13:34:47 -04:00
tests [ci skip] fix wasm unit tests 2025-03-11 21:39:56 -04:00
.gitignore
build.rs more startup logs 2025-09-08 12:59:11 -05:00
Cargo.toml Fix staging 2025-09-29 16:33:38 -04:00
LICENSE.md licensing 2023-07-19 12:48:44 -04:00
README.md Remove config callback 2025-09-08 12:59:10 -05:00
run_tests.sh 32 bit fix 2023-09-20 11:31:01 -04:00
run_windows_tests.bat fix async std test and make windows test script work 2023-09-06 09:53:28 -04:00
webdriver.json more test work 2022-11-30 21:32:41 -05:00

README.md

The Veilid Framework

This is the core library used to create a Veilid node and operate it as part of an application.

veilid-core contains all of the core logic for Veilid and can be used in mobile applications as well as desktop and in-browser WebAssembly apps.

Getting started

The public API is accessed by getting a [VeilidAPI] object via a call to [api_startup] or [api_startup_json].

From there, a [RoutingContext] object can get you access to public and private routed operations.

Cargo features

The default veilid-core configurations are:

  • default - Uses tokio as the async runtime.

If you use --no-default-features, you can switch to other runtimes:

  • default-async-std - Uses async-std as the async runtime.
  • default-wasm - When building for the wasm32 architecture, use this to enable wasm-bindgen-futures as the async runtime.