Object/Class

com.twitter.io

Buf

Related Docs: class Buf | package io

Permalink

object Buf

Buf wrapper-types (like Buf.ByteArray and Buf.ByteBuffer) provide Shared and Owned APIs, each of which with construction & extraction utilities.

The Owned APIs may provide direct access to a Buf's underlying implementation; and so mutating the data structure invalidates a Buf's immutability constraint. Users must take care to handle this data immutably.

The Shared variants, on the other hand, ensure that the Buf shares no state with the caller (at the cost of additional allocation).

Note: There are Java-friendly APIs for this object at com.twitter.io.Bufs.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Buf
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class ByteArray extends Buf

    Permalink

    A buffer representing an array of bytes.

  2. class ByteBuffer extends Buf

    Permalink

    A buffer representing the remaining bytes in the given ByteBuffer.

    A buffer representing the remaining bytes in the given ByteBuffer. The given buffer will not be affected.

    Modifications to the ByteBuffer's content will be visible to the resulting Buf. The ByteBuffer should be immutable in practice.

  3. sealed abstract class Composite extends Buf

    Permalink

    A Buf which is composed of other Bufs.

    A Buf which is composed of other Bufs.

    See also

    Buf.apply for creating new instances.

  4. abstract class Processor extends AnyRef

    Permalink

    returns

    true if the processor would like to continue processing more bytes and false otherwise.

    Note

    this is not a Function1[Byte, Boolean] despite very much fitting that interface. This was done to avoiding boxing of the Bytes which was quite squirrely and had an impact on performance.

    See also

    Buf.process

  5. abstract class StringCoder extends AnyRef

    Permalink

    A StringCoder for a given java.nio.charset.Charset provides an encoder: String to Buf and an extractor: Buf to Option[String].

    A StringCoder for a given java.nio.charset.Charset provides an encoder: String to Buf and an extractor: Buf to Option[String].

    Note

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

    See also

    Utf8 for UTF-8 encoding and decoding, and Bufs.UTF8 for Java users. Constants exist for other standard charsets as well.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object ByteArray

    Permalink
  5. object ByteBuffer

    Permalink
  6. object Composite

    Permalink
  7. val Empty: Buf

    Permalink

    An empty buffer.

  8. object Iso8859_1 extends StringCoder

    Permalink

    Create and deconstruct buffers encoded by the ISO Latin Alphabet No.

    Create and deconstruct buffers encoded by the ISO Latin Alphabet No. 1 charset.

    Note

    See com.twitter.io.Bufs.ISO_8859_1 for a Java-friendly API.

    ,

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

  9. object U32BE

    Permalink

    Create and deconstruct unsigned 32-bit big endian encoded buffers.

    Create and deconstruct unsigned 32-bit big endian encoded buffers.

    Deconstructing will return the value as well as the remaining buffer.

  10. object U32LE

    Permalink

    Create and deconstruct unsigned 32-bit little endian encoded buffers.

    Create and deconstruct unsigned 32-bit little endian encoded buffers.

    Deconstructing will return the value as well as the remaining buffer.

  11. object U64BE

    Permalink

    Create and deconstruct unsigned 64-bit big endian encoded buffers.

    Create and deconstruct unsigned 64-bit big endian encoded buffers.

    Deconstructing will return the value as well as the remaining buffer.

  12. object U64LE

    Permalink

    Create and deconstruct unsigned 64-bit little endian encoded buffers.

    Create and deconstruct unsigned 64-bit little endian encoded buffers.

    Deconstructing will return the value as well as the remaining buffer.

  13. object UsAscii extends StringCoder

    Permalink

    Create and deconstruct buffers encoded by the 7-bit ASCII, also known as ISO646-US or the Basic Latin block of the Unicode character set.

    Create and deconstruct buffers encoded by the 7-bit ASCII, also known as ISO646-US or the Basic Latin block of the Unicode character set.

    Note

    See com.twitter.io.Bufs.US_ASCII for a Java-friendly API.

    ,

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

  14. object Utf16 extends StringCoder

    Permalink

    Create and deconstruct 16-bit UTF buffers.

    Create and deconstruct 16-bit UTF buffers.

    Note

    See com.twitter.io.Bufs.UTF_16 for a Java-friendly API.

    ,

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

  15. object Utf16BE extends StringCoder

    Permalink

    Create and deconstruct buffers encoded by the 16-bit UTF charset with big-endian byte order.

    Create and deconstruct buffers encoded by the 16-bit UTF charset with big-endian byte order.

    Note

    See com.twitter.io.Bufs.UTF_16BE for a Java-friendly API.

    ,

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

  16. object Utf16LE extends StringCoder

    Permalink

    Create and deconstruct buffers encoded by the 16-bit UTF charset with little-endian byte order.

    Create and deconstruct buffers encoded by the 16-bit UTF charset with little-endian byte order.

    Note

    See com.twitter.io.Bufs.UTF_16LE for a Java-friendly API.

    ,

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

  17. object Utf8 extends StringCoder

    Permalink

    Create and deconstruct Utf-8 encoded buffers.

    Create and deconstruct Utf-8 encoded buffers.

    Note

    See com.twitter.io.Bufs.UTF_8 for a Java-friendly API.

    ,

    Malformed and unmappable input is silently replaced see java.nio.charset.CodingErrorAction.REPLACE

  18. def apply(bufs: Iterable[Buf]): Buf

    Permalink

    Create a Buf out of the given Bufs.

  19. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  20. def checkSliceArgs(from: Int, until: Int): Unit

    Permalink

    Helps Buf implementations validate the arguments to slicing functions.

  21. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def decodeString(buf: Buf, charset: Charset): String

    Permalink

    Decode a Buf using the specified Charset

  23. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. def equals(x: Buf, y: Buf): Boolean

    Permalink

    Byte equality between two buffers.

  25. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def hash(buf: Buf): Int

    Permalink

    The 32-bit FNV-1 of Buf

  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. def slowHexString(buf: Buf): String

    Permalink

    Return a string representing the buffer contents in hexadecimal.

  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped