ByteVector

object ByteVector extends ByteVectorPlatform

Companion for ByteVector.

Companion for ByteVector.

Companion
class
trait ByteVectorPlatform
class Object
trait Matchable
class Any

Document{}

Empty byte vector.

Empty byte vector.

def apply[A](bytes: A*)(`evidence$1`: Integral[A]): ByteVector

Constructs a ByteVector from a list of literal bytes. Only the least significant byte is used of each integral value.

Constructs a ByteVector from a list of literal bytes. Only the least significant byte is used of each integral value.

def apply(bytes: Vector[Byte]): ByteVector

Constructs a ByteVector from a collection of bytes.

Constructs a ByteVector from a collection of bytes.

def apply(bytes: Array[Byte]): ByteVector

Constructs a ByteVector from an Array[Byte]. The given Array[Byte] is copied to ensure the resulting ByteVector is immutable. If this is not desired, use ByteVector.view.

Constructs a ByteVector from an Array[Byte]. The given Array[Byte] is copied to ensure the resulting ByteVector is immutable. If this is not desired, use ByteVector.view.

def apply(bytes: Array[Byte], offset: Int, length: Int): ByteVector

Constructs a ByteVector from an Array[Byte], an offset, and a length. The given Array[Byte] is copied to ensure the resulting ByteVector is immutable. If this is not desired, use ByteVector.view.

Constructs a ByteVector from an Array[Byte], an offset, and a length. The given Array[Byte] is copied to ensure the resulting ByteVector is immutable. If this is not desired, use ByteVector.view.

def apply(buffer: ByteBuffer): ByteVector

Constructs a ByteVector from a ByteBuffer. The given ByteBuffer is is copied to ensure the resulting ByteVector is immutable. If this is not desired, use ByteVector.view.

Constructs a ByteVector from a ByteBuffer. The given ByteBuffer is is copied to ensure the resulting ByteVector is immutable. If this is not desired, use ByteVector.view.

The returned vector is a copy of a subsequence of the buffer, with bounds determined by the buffer's position and limit at the time this method is called.

def apply(bs: IterableOnce[Byte]): ByteVector

Constructs a ByteVector from a scala.collection source of bytes.

Constructs a ByteVector from a scala.collection source of bytes.

def view(bytes: Array[Byte]): ByteVector

Constructs a ByteVector from an Array[Byte]. Unlike apply, this does not make a copy of the input array, so callers should take care not to modify the contents of the array passed to this function.

Constructs a ByteVector from an Array[Byte]. Unlike apply, this does not make a copy of the input array, so callers should take care not to modify the contents of the array passed to this function.

def view(bytes: Array[Byte], offset: Int, size: Int): ByteVector

Constructs a ByteVector from a slice of an Array[Byte]. Unlike apply, this does not make a copy of the input array, so callers should take care not to modify the contents of the array passed to this function.

Constructs a ByteVector from a slice of an Array[Byte]. Unlike apply, this does not make a copy of the input array, so callers should take care not to modify the contents of the array passed to this function.

def view(bytes: ByteBuffer): ByteVector

Constructs a ByteVector from a ByteBuffer. Unlike apply, this does not make a copy of the input buffer, so callers should take care not to modify the contents of the buffer passed to this function.

Constructs a ByteVector from a ByteBuffer. Unlike apply, this does not make a copy of the input buffer, so callers should take care not to modify the contents of the buffer passed to this function.

The returned vector is a view of a subsequence of the buffer, with bounds determined by the buffer's position and limit at the time this method is called.

def viewAt(at: Long => Byte, size: Long): ByteVector

Constructs a ByteVector from a function from Long => Byte and a size.

Constructs a ByteVector from a function from Long => Byte and a size.

def viewI(at: Long => Int, size: Long): ByteVector

Constructs a ByteVector from a function from Long => Int and a size, where the Int returned by at must fit in a Byte.

Constructs a ByteVector from a function from Long => Int and a size, where the Int returned by at must fit in a Byte.

def fill[A](size: Long)(b: A)(`evidence$2`: Integral[A]): ByteVector

Constructs a ByteVector of the given size, where all bytes have the value b.

Constructs a ByteVector of the given size, where all bytes have the value b.

def low(size: Long): ByteVector

Constructs a ByteVector of the given size, where all bytes have the value 0.

Constructs a ByteVector of the given size, where all bytes have the value 0.

def high(size: Long): ByteVector

Constructs a ByteVector of the given size, where all bytes have the value 0xff.

Constructs a ByteVector of the given size, where all bytes have the value 0xff.

def fromByte(b: Byte): ByteVector

Constructs a ByteVector vector with the 2's complement encoding of the specified byte.

Constructs a ByteVector vector with the 2's complement encoding of the specified byte.

Value Params
b

value to encode

def fromShort(s: Short, size: Int, ordering: ByteOrdering): ByteVector

Constructs a ByteVector vector with the 2's complement encoding of the specified value.

Constructs a ByteVector vector with the 2's complement encoding of the specified value.

Value Params
ordering

byte ordering of vector

s

value to encode

size

size of vector (<= 2)

def fromInt(i: Int, size: Int, ordering: ByteOrdering): ByteVector

Constructs a ByteVector with the 2's complement encoding of the specified value.

Constructs a ByteVector with the 2's complement encoding of the specified value.

Value Params
i

value to encode

ordering

byte ordering of vector

size

size of vector (<= 4)

def fromLong(l: Long, size: Int, ordering: ByteOrdering): ByteVector

Constructs a ByteVector with the 2's complement encoding of the specified value.

Constructs a ByteVector with the 2's complement encoding of the specified value.

Value Params
l

value to encode

ordering

byte ordering of vector

size

size of vector (<= 8)

final def fromUUID(u: UUID): ByteVector

Constructs a ByteVector containing the binary representation of the specified UUID. The bytes are in MSB-to-LSB order.

Constructs a ByteVector containing the binary representation of the specified UUID. The bytes are in MSB-to-LSB order.

Value Params
u

value to encode

def fromHexDescriptive(str: String, alphabet: HexAlphabet): Either[String, ByteVector]

Constructs a ByteVector from a hexadecimal string or returns an error message if the string is not valid hexadecimal.

Constructs a ByteVector from a hexadecimal string or returns an error message if the string is not valid hexadecimal.

The string may start with a 0x and it may contain whitespace or underscore characters.

def fromHex(str: String, alphabet: HexAlphabet): Option[ByteVector]

Constructs a ByteVector from a hexadecimal string or returns None if the string is not valid hexadecimal.

Constructs a ByteVector from a hexadecimal string or returns None if the string is not valid hexadecimal.

The string may start with a 0x and it may contain whitespace or underscore characters.

def fromValidHex(str: String, alphabet: HexAlphabet): ByteVector

Constructs a ByteVector from a hexadecimal string or throws an IllegalArgumentException if the string is not valid hexadecimal.

Constructs a ByteVector from a hexadecimal string or throws an IllegalArgumentException if the string is not valid hexadecimal.

The string may start with a 0x and it may contain whitespace or underscore characters.

Throws
IllegalArgumentException

if the string is not valid hexadecimal

def fromBinDescriptive(str: String, alphabet: BinaryAlphabet): Either[String, ByteVector]

Constructs a ByteVector from a binary string or returns an error message if the string is not valid binary.

Constructs a ByteVector from a binary string or returns an error message if the string is not valid binary.

The string may start with a 0b and it may contain whitespace or underscore characters.

def fromBin(str: String, alphabet: BinaryAlphabet): Option[ByteVector]

Constructs a ByteVector from a binary string or returns None if the string is not valid binary.

Constructs a ByteVector from a binary string or returns None if the string is not valid binary.

The string may start with a 0b and it may contain whitespace or underscore characters.

def fromValidBin(str: String, alphabet: BinaryAlphabet): ByteVector

Constructs a ByteVector from a binary string or throws an IllegalArgumentException if the string is not valid binary.

Constructs a ByteVector from a binary string or throws an IllegalArgumentException if the string is not valid binary.

The string may start with a 0b and it may contain whitespace or underscore characters.

Throws
IllegalArgumentException

if the string is not valid binary

def fromBase32Descriptive(str: String, alphabet: Base32Alphabet): Either[String, ByteVector]

Constructs a ByteVector from a base 32 string or returns an error message if the string is not valid base 32. An empty input string results in an empty ByteVector. The string may contain whitespace characters and hyphens which are ignored.

Constructs a ByteVector from a base 32 string or returns an error message if the string is not valid base 32. An empty input string results in an empty ByteVector. The string may contain whitespace characters and hyphens which are ignored.

def fromBase32(str: String, alphabet: Base32Alphabet): Option[ByteVector]

Constructs a ByteVector from a base 64 string or returns None if the string is not valid base 32. Details pertaining to base 32 decoding can be found in the comment for fromBase32Descriptive. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 64 string or returns None if the string is not valid base 32. Details pertaining to base 32 decoding can be found in the comment for fromBase32Descriptive. The string may contain whitespace characters which are ignored.

def fromValidBase32(str: String, alphabet: Base32Alphabet): ByteVector

Constructs a ByteVector from a base 32 string or throws an IllegalArgumentException if the string is not valid base 32. Details pertaining to base 32 decoding can be found in the comment for fromBase32Descriptive. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 32 string or throws an IllegalArgumentException if the string is not valid base 32. Details pertaining to base 32 decoding can be found in the comment for fromBase32Descriptive. The string may contain whitespace characters which are ignored.

Throws
IllegalArgumentException

if the string is not valid base 32

def fromBase58Descriptive(str: String, alphabet: Alphabet): Either[String, ByteVector]

Constructs a ByteVector from a base 58 string or returns an error message if the string is not valid base 58. It is similar to Base64 but has been modified to avoid both non-alphanumeric characters and letters which might look ambiguous when printed. It is therefore designed for human users who manually enter the data, copying from some visual source Compared to Base64, the following similar-looking letters are omitted: 0 (zero), O (capital o), I (capital i) and l (lower case L) as well as the non-alphanumeric characters + (plus) and / (slash). The actual order of letters in the alphabet depends on the application, the default order is the same used in Bitcoin An empty input string results in an empty ByteVector. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 58 string or returns an error message if the string is not valid base 58. It is similar to Base64 but has been modified to avoid both non-alphanumeric characters and letters which might look ambiguous when printed. It is therefore designed for human users who manually enter the data, copying from some visual source Compared to Base64, the following similar-looking letters are omitted: 0 (zero), O (capital o), I (capital i) and l (lower case L) as well as the non-alphanumeric characters + (plus) and / (slash). The actual order of letters in the alphabet depends on the application, the default order is the same used in Bitcoin An empty input string results in an empty ByteVector. The string may contain whitespace characters which are ignored.

def fromBase58(str: String, alphabet: Alphabet): Option[ByteVector]

Constructs a ByteVector from a base 58 string or returns None if the string is not valid base 58. Details pertaining to base 58 decoding can be found in the comment for fromBase58Descriptive. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 58 string or returns None if the string is not valid base 58. Details pertaining to base 58 decoding can be found in the comment for fromBase58Descriptive. The string may contain whitespace characters which are ignored.

def fromValidBase58(str: String, alphabet: Alphabet): ByteVector

Constructs a ByteVector from a base 58 string or throws an IllegalArgumentException if the string is not valid base 58. Details pertaining to base 58 decoding can be found in the comment for fromBase58Descriptive. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 58 string or throws an IllegalArgumentException if the string is not valid base 58. Details pertaining to base 58 decoding can be found in the comment for fromBase58Descriptive. The string may contain whitespace characters which are ignored.

Throws
IllegalArgumentException

if the string is not valid base 58

def fromBase64Descriptive(str: String, alphabet: Base64Alphabet): Either[String, ByteVector]

Constructs a ByteVector from a base 64 string or returns an error message if the string is not valid base 64. If the final encoding quantum does not contain 4 characters, i.e. the total number of characters is not evenly divisible by 4, padding is inferred if the final quantum contains 2 or 3 characters. This is to say that padding is optional as long as the inferred padding would yield a valid base 64 string. The input is considered invalid if the final quantum only contains a single character. If padding characters are present, they must be used in accordance with the base 64 specification and no padding characters will be inferred. An empty input string results in an empty ByteVector. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 64 string or returns an error message if the string is not valid base 64. If the final encoding quantum does not contain 4 characters, i.e. the total number of characters is not evenly divisible by 4, padding is inferred if the final quantum contains 2 or 3 characters. This is to say that padding is optional as long as the inferred padding would yield a valid base 64 string. The input is considered invalid if the final quantum only contains a single character. If padding characters are present, they must be used in accordance with the base 64 specification and no padding characters will be inferred. An empty input string results in an empty ByteVector. The string may contain whitespace characters which are ignored.

def fromBase64(str: String, alphabet: Base64Alphabet): Option[ByteVector]

Constructs a ByteVector from a base 64 string or returns None if the string is not valid base 64. Details pertaining to base 64 decoding can be found in the comment for fromBase64Descriptive. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 64 string or returns None if the string is not valid base 64. Details pertaining to base 64 decoding can be found in the comment for fromBase64Descriptive. The string may contain whitespace characters which are ignored.

def fromValidBase64(str: String, alphabet: Base64Alphabet): ByteVector

Constructs a ByteVector from a base 64 string or throws an IllegalArgumentException if the string is not valid base 64. Details pertaining to base 64 decoding can be found in the comment for fromBase64Descriptive. The string may contain whitespace characters which are ignored.

Constructs a ByteVector from a base 64 string or throws an IllegalArgumentException if the string is not valid base 64. Details pertaining to base 64 decoding can be found in the comment for fromBase64Descriptive. The string may contain whitespace characters which are ignored.

Throws
IllegalArgumentException

if the string is not valid base 64

def encodeString(str: String)(charset: Charset): Either[CharacterCodingException, ByteVector]

Encodes the specified string to a ByteVector using the implicitly available Charset.

Encodes the specified string to a ByteVector using the implicitly available Charset.

def encodeUtf8(str: String): Either[CharacterCodingException, ByteVector]

Encodes the specified string to a ByteVector using the UTF-8 charset.

Encodes the specified string to a ByteVector using the UTF-8 charset.

def encodeAscii(str: String): Either[CharacterCodingException, ByteVector]

Encodes the specified string to a ByteVector using the US-ASCII charset.

Encodes the specified string to a ByteVector using the US-ASCII charset.

def concat(bvs: IterableOnce[ByteVector]): ByteVector

Concatenates all the given ByteVectors into a single instance.

Concatenates all the given ByteVectors into a single instance.

def unapplySeq(b: ByteVector): Some[Seq[Byte]]

Extractor used in support of pattern matching on the bytes of a vector.

Extractor used in support of pattern matching on the bytes of a vector.

Type members

Classlikes

final class GroupedOp(val self: ByteVector) extends AnyVal