object ByteString

Source
ByteString.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ByteString
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class ByteString1 extends ByteString with Serializable

    An unfragmented ByteString.

  2. 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()
  3. final class ByteStrings extends ByteString with Serializable

    A ByteString with 2 or more fragments.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val UTF_8: String

    Standard "UTF-8" charset

  5. def apply(string: String, charset: Charset): ByteString

    Creates a new ByteString by encoding a String with a charset.

  6. def apply(string: String, charset: String): ByteString

    Creates a new ByteString by encoding a String with a charset.

  7. def apply(string: String): ByteString

    Creates a new ByteString by encoding a String as UTF-8.

  8. def apply(bytes: ByteBuffer): ByteString

    Creates a new ByteString by copying bytes from a ByteBuffer.

  9. def apply[T](bytes: T*)(implicit num: Integral[T]): ByteString

    Creates a new ByteString by converting from integral numbers to bytes.

  10. def apply(bytes: IterableOnce[Byte]): ByteString

    Creates a new ByteString by iterating over bytes.

  11. def apply(bytes: Byte*): ByteString

    Creates a new ByteString by copying bytes.

  12. def apply(bytes: Array[Byte]): ByteString

    Creates a new ByteString by copying a byte array.

  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  15. def createBuilder: ByteStringBuilder

    Java API

  16. val empty: ByteString
  17. def emptyByteString: ByteString

    Java API

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def fromArray(array: Array[Byte], offset: Int, length: Int): ByteString

    Creates a new ByteString by copying length bytes starting at offset from an Array.

  21. def fromArray(array: Array[Byte]): ByteString

    Creates a new ByteString by copying a byte array.

  22. 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.

  23. 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.

  24. def fromByteBuffer(buffer: ByteBuffer): ByteString

    Creates a new ByteString by copying bytes out of a ByteBuffer.

  25. 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()
  26. def fromString(string: String, charset: Charset): ByteString

    Creates a new ByteString which will contain the representation of the given String in the given charset

  27. def fromString(string: String, charset: String): ByteString

    Creates a new ByteString which will contain the representation of the given String in the given charset

  28. def fromString(string: String): ByteString

    Creates a new ByteString which will contain the UTF-8 representation of the given String

  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def newBuilder: ByteStringBuilder
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped