scodec.bits.package.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scodec-bits_sjs0.6_2.10 Show documentation

scodec-bits

There is a newer version: 1.1.12

Show newest version

package scodec

import scala.language.experimental.macros

/**
 * Provides immutable data types for working with bits and bytes.
 *
 * @see [[BitVector]] and [[ByteVector]]
 */
package object bits {

  /**
   * Provides the `bin` string interpolator, which returns `BitVector` instances from binary strings.
   */
  final implicit class BinStringSyntax(val sc: StringContext) extends AnyVal {

    /**
     * Converts this binary literal string to a `BitVector`. Whitespace characters are ignored.
     *
     * Named arguments are supported in the same manner as the standard `s` interpolator but they must be
     * of type `BitVector`.
     */
    def bin(args: BitVector*): BitVector = macro LiteralSyntaxMacros.binStringInterpolator
  }

  /**
   * Provides the `hex` string interpolator, which returns `ByteVector` instances from hexadecimal strings.
   */
  final implicit class HexStringSyntax(val sc: StringContext) extends AnyVal {

    /**
     * Converts this hexadecimal literal string to a `ByteVector`. Whitespace characters are ignored.
     *
     * Named arguments are supported in the same manner as the standard `s` interpolator but they must be
     * of type `ByteVector`.
     */
    def hex(args: ByteVector*): ByteVector = macro LiteralSyntaxMacros.hexStringInterpolator
  }
}