cristalhq / bson

BSON for Go

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

bson's Issues

Struct cache probably doesn't work with nested structs

Currently in getStructInfo we iterate over top-level fields. Fields of fields of struct are ignored.

Also, we can sort fields once when we add a struct for the first time, so sort in structInfo.asDoc can be omitted.

Add logging helpers to `bsonproto`

func LogValue[T ScalarType](v T) slog.Value
func LogValueAny(v any) slog.Value

or

func GoString[T ScalarType](v T) string
func GoString(v any) string

given that the representation is always a Go-code-like string? For example, int32(42) and int64(42).

Rename RawObject to RawDocument

RawObject will decode only 1st level fields of the encoded documet.

On the other side RawDocument is already an encoded document and no processing should be made.

Pool temporary D objects

During encoding we've a few places where we allocate a new D for short period of time. Such allocations are harmless but we can get rid of them by allocating a D from sync.Pool.

As a result we should have zero-alloc encoding (in terms of D allocs, buffer grow or reflect is a separate topic).

Also: M.AsD() D should have an unexported version where we encode M into a given D.

Improve BSON tags for unnamed field

Right now the following field will get Bar BSON tag.

type Foo struct {
    Bar string
}

However, official Mongo client and mgo will generate bar. Decide which behaviour is better.

Change repository settings

I think it makes sense to enable branch protection rules (or newer rulesets) to require CI to pass.

Support `decimal128` values in `bsonproto`