object ByteVector extends Serializable
- Grouped
- Alphabetic
- By Inheritance
- ByteVector
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
apply(bs: GenTraversableOnce[Byte]): ByteVector
Constructs a
ByteVector
from ascala.collection
source of bytes. -
def
apply(buffer: ByteBuffer): ByteVector
Constructs a
ByteVector
from aByteBuffer
.Constructs a
ByteVector
from aByteBuffer
. The givenByteBuffer
is is copied to ensure the resultingByteVector
is immutable. If this is not desired, useByteVector.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(bytes: Array[Byte], offset: Int, length: Int): ByteVector
Constructs a
ByteVector
from anArray[Byte]
, an offset, and a length.Constructs a
ByteVector
from anArray[Byte]
, an offset, and a length. The givenArray[Byte]
is copied to ensure the resultingByteVector
is immutable. If this is not desired, useByteVector.view
. -
def
apply(bytes: Array[Byte]): ByteVector
Constructs a
ByteVector
from anArray[Byte]
.Constructs a
ByteVector
from anArray[Byte]
. The givenArray[Byte]
is copied to ensure the resultingByteVector
is immutable. If this is not desired, useByteVector.view
. -
def
apply(bytes: Vector[Byte]): ByteVector
Constructs a
ByteVector
from a collection of bytes. -
def
apply[A](bytes: A*)(implicit arg0: Integral[A]): ByteVector
Constructs a
ByteVector
from a list of literal bytes.Constructs a
ByteVector
from a list of literal bytes. Only the least significant byte is used of each integral value. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
concat(bvs: GenTraversableOnce[ByteVector]): ByteVector
Concatenates all the given
ByteVector
s into a single instance. -
val
empty: ByteVector
Empty byte vector.
-
def
encodeAscii(str: String): Either[CharacterCodingException, ByteVector]
Encodes the specified string to a
ByteVector
using the US-ASCII charset. -
def
encodeString(str: String)(implicit charset: Charset): Either[CharacterCodingException, ByteVector]
Encodes the specified string to a
ByteVector
using the implicitly availableCharset
. -
def
encodeUtf8(str: String): Either[CharacterCodingException, ByteVector]
Encodes the specified string to a
ByteVector
using the UTF-8 charset. -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
fill[A](size: Long)(b: A)(implicit arg0: Integral[A]): ByteVector
Constructs a
ByteVector
of the given size, where all bytes have the valueb
. -
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fromBase64(str: String, alphabet: Base64Alphabet = Bases.Alphabets.Base64): Option[ByteVector]
Constructs a
ByteVector
from a base 64 string or returnsNone
if the string is not valid base 64.Constructs a
ByteVector
from a base 64 string or returnsNone
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
fromBase64Descriptive(str: String, alphabet: Base64Alphabet = Bases.Alphabets.Base64): Either[String, ByteVector]
Constructs a
ByteVector
from a base 64 string or returns an error message if the string is not valid base 64.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
fromBin(str: String, alphabet: BinaryAlphabet = Bases.Alphabets.Binary): Option[ByteVector]
Constructs a
ByteVector
from a binary string or returnsNone
if the string is not valid binary.Constructs a
ByteVector
from a binary string or returnsNone
if the string is not valid binary.The string may start with a
0b
and it may contain whitespace or underscore characters. -
def
fromBinDescriptive(str: String, alphabet: BinaryAlphabet = Bases.Alphabets.Binary): 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
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.- b
value to encode
-
def
fromHex(str: String, alphabet: HexAlphabet = Bases.Alphabets.HexLowercase): Option[ByteVector]
Constructs a
ByteVector
from a hexadecimal string or returnsNone
if the string is not valid hexadecimal.Constructs a
ByteVector
from a hexadecimal string or returnsNone
if the string is not valid hexadecimal.The string may start with a
0x
and it may contain whitespace or underscore characters. -
def
fromHexDescriptive(str: String, alphabet: HexAlphabet = Bases.Alphabets.HexLowercase): 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
fromInt(i: Int, size: Int = 4, ordering: ByteOrdering = ByteOrdering.BigEndian): 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.- i
value to encode
- size
size of vector (<= 4)
- ordering
byte ordering of vector
-
def
fromLong(l: Long, size: Int = 8, ordering: ByteOrdering = ByteOrdering.BigEndian): 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.- l
value to encode
- size
size of vector (<= 8)
- ordering
byte ordering of vector
-
def
fromShort(s: Short, size: Int = 2, ordering: ByteOrdering = ByteOrdering.BigEndian): 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.- s
value to encode
- size
size of vector (<= 2)
- ordering
byte ordering of vector
-
final
def
fromUUID(u: UUID): ByteVector
Constructs a
ByteVector
containing the binary representation of the specified UUID.Constructs a
ByteVector
containing the binary representation of the specified UUID. The bytes are in MSB-to-LSB order.- u
value to encode
-
def
fromValidBase64(str: String, alphabet: Base64Alphabet = Bases.Alphabets.Base64): ByteVector
Constructs a
ByteVector
from a base 64 string or throws an IllegalArgumentException if the string is not valid base 64.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.- Exceptions thrown
IllegalArgumentException
if the string is not valid base 64
-
def
fromValidBin(str: String, alphabet: BinaryAlphabet = Bases.Alphabets.Binary): 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.- Exceptions thrown
IllegalArgumentException
if the string is not valid binary
-
def
fromValidHex(str: String, alphabet: HexAlphabet = Bases.Alphabets.HexLowercase): 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.- Exceptions thrown
IllegalArgumentException
if the string is not valid hexadecimal
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
high(size: Long): ByteVector
Constructs a
ByteVector
of the given size, where all bytes have the value0xff
. -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
low(size: Long): ByteVector
Constructs a
ByteVector
of the given size, where all bytes have the value0
. -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unapplySeq(b: ByteVector): Some[Seq[Byte]]
Extractor used in support of pattern matching on the bytes of a vector.
-
def
view(bytes: ByteBuffer): ByteVector
Constructs a
ByteVector
from aByteBuffer
.Constructs a
ByteVector
from aByteBuffer
. Unlikeapply
, 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
view(bytes: Array[Byte], offset: Int, size: Int): ByteVector
Constructs a
ByteVector
from a slice of anArray[Byte]
.Constructs a
ByteVector
from a slice of anArray[Byte]
. Unlikeapply
, 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]): ByteVector
Constructs a
ByteVector
from anArray[Byte]
.Constructs a
ByteVector
from anArray[Byte]
. Unlikeapply
, 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
viewAt(at: (Long) ⇒ Byte, size: Long): ByteVector
Constructs a
ByteVector
from a function fromLong => Byte
and a size. -
def
viewI(at: (Long) ⇒ Int, size: Long): ByteVector
Constructs a
ByteVector
from a function fromLong => Int
and a size, where theInt
returned byat
must fit in aByte
. -
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )