Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2025-07-02 02:26:52 -04:00
Code Issues Projects Releases Packages Wiki Activity
veilid/veilid-core
History
Christien Rioux 3dba776c91 make peer info creation fallible
2025-06-13 10:31:23 -04:00
..
examples add private route example 2025-06-04 16:52:24 -04:00
proto chore: update capnp version to 1.1.0 2025-05-06 11:48:48 -04:00
src make peer info creation fallible 2025-06-13 10:31:23 -04:00
tests [ci skip] fix wasm unit tests 2025-03-11 21:39:56 -04:00
.gitignore minor cleanup and pipeline test 2021-12-08 08:29:49 -05:00
build.rs chore: update capnp version to 1.1.0 2025-05-06 11:48:48 -04:00
Cargo.toml Version update: v0.4.6 → v0.4.7 2025-06-03 10:24:08 -05:00
LICENSE.md licensing 2023-07-19 12:48:44 -04:00
README.md Add READMEs, basic veilid-core example 2025-05-31 00:05:58 +00: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], [api_startup_json], or [api_startup_config].

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.