https://github.com/scodec/scodec-bits

Provides immutable datatypes for working with bits and bytes
https://github.com/scodec/scodec-bits

Last synced: about 1 year ago
JSON representation

Provides immutable datatypes for working with bits and bytes

• Host: GitHub
• URL: https://github.com/scodec/scodec-bits
• Owner: scodec
• License: bsd-3-clause
• Created: 2014-02-05T22:49:09.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2025-05-06T13:51:46.000Z (over 1 year ago)
• Last Synced: 2025-05-06T15:02:05.184Z (over 1 year ago)
• Language: Scala
• Size: 3.96 MB
• Stars: 116
• Watchers: 8
• Forks: 59
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Discord](https://img.shields.io/discord/632277896739946517.svg?label=&logo=discord&logoColor=ffffff&color=404244&labelColor=6A7EC2)](https://discord.gg/wKn3cpfRVz)

[![Maven Central](https://img.shields.io/maven-central/v/org.scodec/scodec-bits_3)](https://maven-badges.herokuapp.com/maven-central/org.scodec/scodec-bits_3)

[![javadoc](https://javadoc.io/badge2/org.scodec/scodec-bits_3/javadoc.svg)](https://javadoc.io/doc/org.scodec/scodec-bits_3)

scodec-bits

===========

Provides persistent datatypes for working with bits and bytes.

Design Constraints

------------------

 - No dependencies on other libraries in order to be applicable to as many projects as possible.

Administrative

--------------

This project is licensed under a [3-clause BSD license](LICENSE).

The [scodec channel on Typelevel Discord](https://discord.gg/wKn3cpfRVz) is a good place to go for help.

Introduction

------------

There are two fundamental data structures provided:

 - [`BitVector`](core/shared/src/main/scala/scodec/bits/BitVector.scala)

 - [`ByteVector`](core/shared/src/main/scala/scodec/bits/ByteVector.scala)

Both datatypes provide collection like functionality, although neither directly implement the Scala

collection library traits. Both are implemented as binary trees where each node is either a leaf

node containing bits/bytes or is an inner node containing an operation on other trees (e.g., append).

As a result, many operations are implemented in logarithmic time with respect to the depth of the tree.

Both strict and lazy constructors are provided. Of particular interest are the methods that work

with Java NIO sources like `java.nio.channels.ReadableByteChannel` and `java.nio.channels.FileChannel`,

which allow efficient, lazy access and manipulation of bits and bytes from a variety of sources.

Hexadecimal and binary string literals are supported via the `hex` and `bin` string interpolators.

For example:

    val x: ByteVector = hex"deadbeef"

    val y: BitVector = bin"00101101010010101"

Base conversions to and from strings are supported. Binary, hexadecimal, and base 64 conversions are

supported. Each have a default alphabet but support alternative alphabets as well as user defined

alphabets.

For more information, see the [API documentation](https://javadoc.io/doc/org.scodec/scodec-bits_3).

For a combinator based approach to encoding values to/from binary, see the companion project [scodec](https://github.com/scodec/scodec).

Getting Binaries

----------------

See the [releases page on the website](http://scodec.org/releases/).

Building

--------

This project uses sbt and requires node.js to be installed in order to run Scala.js tests. To build, run `sbt publishLocal`.

Code of Conduct

---------------

See the [Code of Conduct](CODE_OF_CONDUCT.md).