object ByteString
- Source
- ByteString.scala
- Alphabetic
- By Inheritance
- ByteString
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
class
ByteString1 extends ByteString with Serializable
An unfragmented ByteString.
-
final
class
ByteString1C extends CompactByteString
A compact (unsliced) and unfragmented ByteString, implementation of ByteString1C.
A compact (unsliced) and unfragmented ByteString, implementation of ByteString1C.
- Annotations
- @SerialVersionUID()
-
final
class
ByteStrings extends ByteString with Serializable
A ByteString with 2 or more fragments.
Value Members
-
val
UTF_8: String
Standard "UTF-8" charset
-
def
apply(string: String, charset: Charset): ByteString
Creates a new ByteString by encoding a String with a charset.
-
def
apply(string: String, charset: String): ByteString
Creates a new ByteString by encoding a String with a charset.
-
def
apply(string: String): ByteString
Creates a new ByteString by encoding a String as UTF-8.
-
def
apply(bytes: ByteBuffer): ByteString
Creates a new ByteString by copying bytes from a ByteBuffer.
-
def
apply[T](bytes: T*)(implicit num: Integral[T]): ByteString
Creates a new ByteString by converting from integral numbers to bytes.
-
def
apply(bytes: Byte*): ByteString
Creates a new ByteString by copying bytes.
-
def
apply(bytes: Array[Byte]): ByteString
Creates a new ByteString by copying a byte array.
- implicit val canBuildFrom: CanBuildFrom[TraversableOnce[Byte], Byte, ByteString]
-
def
createBuilder: ByteStringBuilder
Java API
- val empty: ByteString
-
def
fromArray(array: Array[Byte], offset: Int, length: Int): ByteString
Creates a new ByteString by copying length bytes starting at offset from an Array.
-
def
fromArray(array: Array[Byte]): ByteString
Creates a new ByteString by copying a byte array.
-
def
fromArrayUnsafe(array: Array[Byte], offset: Int, length: Int): ByteString
Unsafe API: Use only in situations you are completely confident that this is what you need, and that you understand the implications documented below.
Unsafe API: Use only in situations you are completely confident that this is what you need, and that you understand the implications documented below.
Creates a ByteString without copying the passed in byte array, unlike other factory methods defined on ByteString. This method of creating a ByteString saves one array copy and allocation and therefore can lead to better performance, however it also means that one MUST NOT modify the passed in array, or unexpected immutable data structure contract-breaking behavior will manifest itself.
This API is intended for users who have obtained an byte array from some other API, and want wrap it into an ByteArray, and from there on only use that reference (the ByteString) to operate on the wrapped data. For all other intents and purposes, please use the usual apply and create methods - which provide the immutability guarantees by copying the array.
-
def
fromArrayUnsafe(array: Array[Byte]): ByteString
Unsafe API: Use only in situations you are completely confident that this is what you need, and that you understand the implications documented below.
Unsafe API: Use only in situations you are completely confident that this is what you need, and that you understand the implications documented below.
Creates a ByteString without copying the passed in byte array, unlike other factory methods defined on ByteString. This method of creating a ByteString saves one array copy and allocation and therefore can lead to better performance, however it also means that one MUST NOT modify the passed in array, or unexpected immutable data structure contract-breaking behavior will manifest itself.
This API is intended for users who have obtained an byte array from some other API, and want wrap it into an ByteArray, and from there on only use that reference (the ByteString) to operate on the wrapped data. For all other intents and purposes, please use the usual apply and create methods - which provide the immutability guarantees by copying the array.
-
def
fromByteBuffer(buffer: ByteBuffer): ByteString
Creates a new ByteString by copying bytes out of a ByteBuffer.
-
def
fromInts(array: Int*): ByteString
JAVA API Creates a new ByteString by copying an int array by converting from integral numbers to bytes.
JAVA API Creates a new ByteString by copying an int array by converting from integral numbers to bytes.
- Annotations
- @varargs()
-
def
fromString(string: String, charset: Charset): ByteString
Creates a new ByteString which will contain the representation of the given String in the given charset
-
def
fromString(string: String, charset: String): ByteString
Creates a new ByteString which will contain the representation of the given String in the given charset
-
def
fromString(string: String): ByteString
Creates a new ByteString which will contain the UTF-8 representation of the given String
- def newBuilder: ByteStringBuilder