Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softprops/zig-bson
zig library for working with bson data 🍃
https://github.com/softprops/zig-bson
zig-library zig-package zigdex-lib
Last synced: 2 months ago
JSON representation
zig library for working with bson data 🍃
- Host: GitHub
- URL: https://github.com/softprops/zig-bson
- Owner: softprops
- License: mit
- Created: 2024-05-28T21:38:58.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-01T23:26:16.000Z (5 months ago)
- Last Synced: 2024-10-12T12:41:18.613Z (3 months ago)
- Topics: zig-library, zig-package, zigdex-lib
- Language: Zig
- Homepage:
- Size: 4.66 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
zig bson
---
[](https://github.com/softprops/zig-bson/actions/workflows/ci.yml)   [](https://ziglang.org/documentation/0.13.0/)
## examples
See examples directory
## 📼 installing
Create a new exec project with `zig init`. Copy an example from the examples directory into your into `src/main.zig`
Create a `build.zig.zon` file to declare a dependency
> .zon short for "zig object notation" files are essentially zig structs. `build.zig.zon` is zigs native package manager convention for where to declare dependencies
Starting in zig 0.12.0, you can use and should prefer
```sh
zig fetch --save https://github.com/softprops/zig-bson/archive/refs/tags/v0.1.4.tar.gz
```
otherwise, to manually add it, do so as follows
```diff
.{
.name = "my-app",
.version = "0.1.0",
.dependencies = .{
+ // 👇 declare dep properties
+ .bson = .{
+ // 👇 uri to download
+ .url = "https://github.com/softprops/zig-bson/archive/refs/tags/v0.1.4.tar.gz",
+ // 👇 hash verification
+ .hash = "...",
+ },
},
}
```
> the hash below may vary. you can also depend any tag with `https://github.com/softprops/zig-bson/archive/refs/tags/v{version}.tar.gz` or current main with `https://github.com/softprops/zig-bson/archive/refs/heads/main/main.tar.gz`. to resolve a hash omit it and let zig tell you the expected value.
Add the following in your `build.zig` file
```diff
const std = @import("std");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
// 👇 de-reference dep from build.zig.zon
+ const bson = b.dependency("bson", .{
+ .target = target,
+ .optimize = optimize,
+ }).module("bson");
var exe = b.addExecutable(.{
.name = "your-exe",
.root_source_file = .{ .path = "src/main.zig" },
.target = target,
.optimize = optimize,
});
// 👇 add the module to executable
+ exe.root_mode.addImport("bson", bson);
b.installArtifact(exe);
}
```
## 🥹 for budding ziglings
Does this look interesting but you're new to zig and feel left out? No problem, zig is young so most us of our new are as well. Here are some resources to help get you up to speed on zig
- [the official zig website](https://ziglang.org/)
- [zig's one-page language documentation](https://ziglang.org/documentation/0.13.0/)
- [ziglearn](https://ziglearn.org/)
- [ziglings exercises](https://github.com/ratfactor/ziglings)
\- softprops 2024