raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Improved documentation of ByteString methods compact and isCompact

Browse source
This commit is contained in:
Oliver Schulz 2012-05-26 12:29:03 +02:00
parent 151b74262e
commit b54e9ba78e
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
akka-actor/src/main/scala/akka/util/ByteString.scala
View file

@ -311,12 +311,16 @@ sealed abstract class ByteString extends IndexedSeq[Byte] with IndexedSeqOptimiz
/**
* Create a new ByteString with all contents compacted into a single,
* full byte array.
* If isCompact returns true, compact is an O(1) operation, but
* might return a different object with an optimized implementation.
*/
def compact: CompactByteString
/**
* Check whether this ByteString is compact in memory
* (i.e. represented by a single, full byte array).
* Check whether this ByteString is compact in memory.
* If the ByteString is compact, it might, however, not be represented
* by an object that takes full adventage of that fact. Use compact to
* get such an object.
*/
def isCompact: Boolean