Library Moduleswift-bson 1.0.0BSON

BSON

An umbrella module providing a BSON parser, encoder, and decoder.

README.md
import BSON

Module information

Declarations
29
Symbols
77

Coverage

27.6 percent of the declarations in BSON are fully documented72.4 percent of the declarations in BSON are indirectly documented

Declarations

3.4 percent of the declarations in BSON are operators27.6 percent of the declarations in BSON are initializers, type members, or enum cases62.1 percent of the declarations in BSON are instance members6.9 percent of the declarations in BSON are structures

Interfaces

100.0 percent of the declarations in BSON are unrestricted
Module stats and coverage details

Tutorials

  • BSON Usage Examples

    Using BSON in production generally consists of three kinds of tasks: defining root types that model the documents you want to store as BSON, defining reusable supporting types to model fields in other types, and actually encoding and decoding BSON documents to and from binary data.

    Read More
  • BSON Decoding and Encoding, Explained

    This article walks through the process of implementing BSONDocumentDecodable and BSONDocumentEncodable conformances for a model type in detail, and explains the rationale behind library’s design decisions.

    Read More
  • Advanced Serialization Patterns

    Level up your BSON encoding skills by learning these composable serialiation patterns. Internalizing these techniques will help you write more efficient and maintainable database applications by avoiding temporary allocations and reusing generic library code.

    Read More
  • Textures and Coordinates

    BSON documents can embed arbitrary binary data. This is useful for storing trivial repeating values like RGB colors or 3D coordinates, and can save an enormous amount of keying overhead, though at the cost of making the data un-queryable, as the database will not understand your custom data format.

    Read More

Linking the BSON libraries

This module re-exports the BSONABI, BSONEncoding, BSONDecoding, and BSONArrays modules. Importing them directly is discouraged.

Some BSON modules (currently BSONLegacy and BSONReflection) are considered ancillary and are not included in this umbrella module.

Other modules

  • BSONABI

    Models the BSON type system and the binary interface of the BSON serialization format.

  • BSONArrays

    Implements the packed binary array system.

  • BSONDecoding

    Implements the BSON decoding system.

  • BSONEncoding

    Implements the BSON encoding system.

  • BSONLegacy

  • BSONReflection

    This module contains tools for inspecting, canonicalizing, and comparing BSON for equality.

  • BSON_ISO

    An overlay module providing BSONEncodable and BSONDecodable conformances for the types in the ISO module.

  • BSON_UUID

    An overlay module providing BSONEncodable and BSONDecodable conformances for the UUID type.