|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectakka.util.ByteString
public abstract class ByteString
A rope-like immutable data structure containing bytes. The goal of this structure is to reduce copying of arrays when concatenating and slicing sequences of bytes, and also providing a thread safe way of working with bytes.
TODO: Add performance characteristics
| Nested Class Summary | |
|---|---|
static class |
ByteString.ByteString1
An unfragmented ByteString. |
static class |
ByteString.ByteString1$
|
static class |
ByteString.ByteString1C
A compact (unsliced) and unfragmented ByteString, implementation of ByteString1C. |
static class |
ByteString.ByteString1C$
|
static class |
ByteString.ByteStrings
A ByteString with 2 or more fragments. |
static class |
ByteString.ByteStrings$
|
| Nested classes/interfaces inherited from interface scala.collection.immutable.IndexedSeq |
|---|
scala.collection.immutable.IndexedSeq.Impl<A> |
| Nested classes/interfaces inherited from interface scala.PartialFunction |
|---|
scala.PartialFunction.AndThen<A,B,C>, scala.PartialFunction.Lifted<A,B>, scala.PartialFunction.OrElse<A,B>, scala.PartialFunction.Unlifted<A,B> |
| Nested classes/interfaces inherited from interface scala.collection.IndexedSeqLike |
|---|
scala.collection.IndexedSeqLike.Elements |
| Nested classes/interfaces inherited from interface scala.collection.SeqLike |
|---|
scala.collection.SeqLike.CombinationsItr, scala.collection.SeqLike.PermutationsItr |
| Nested classes/interfaces inherited from interface scala.collection.TraversableLike |
|---|
scala.collection.TraversableLike.WithFilter |
| Nested classes/interfaces inherited from interface scala.collection.TraversableOnce |
|---|
scala.collection.TraversableOnce.BufferedCanBuildFrom<A,CC extends scala.collection.TraversableOnce<java.lang.Object>>, scala.collection.TraversableOnce.FlattenOps<A>, scala.collection.TraversableOnce.ForceImplicitAmbiguity, scala.collection.TraversableOnce.MonadOps<A>, scala.collection.TraversableOnce.OnceCanBuildFrom<A> |
| Constructor Summary | |
|---|---|
ByteString()
|
|
| Method Summary | ||
|---|---|---|
abstract byte |
apply(int idx)
|
|
abstract java.nio.ByteBuffer |
asByteBuffer()
Returns a read-only ByteBuffer that directly wraps this ByteString if it is not fragmented. |
|
abstract scala.collection.immutable.Iterable<java.nio.ByteBuffer> |
asByteBuffers()
Scala API: Returns an immutable Iterable of read-only ByteBuffers that directly wraps this ByteStrings all fragments. |
|
static scala.collection.generic.CanBuildFrom<scala.collection.TraversableOnce<java.lang.Object>,java.lang.Object,ByteString> |
canBuildFrom()
|
|
abstract CompactByteString |
compact()
Create a new ByteString with all contents compacted into a single, full byte array. |
|
ByteString |
concat(ByteString that)
Java API: efficiently concatenate another ByteString. |
|
|
copyToArray(java.lang.Object xs,
int start,
int len)
|
|
int |
copyToBuffer(java.nio.ByteBuffer buffer)
Copy as many bytes as possible to a ByteBuffer, starting from it's current position. |
|
abstract java.lang.String |
decodeString(java.lang.String charset)
Decodes this ByteString using a charset to produce a String. |
|
ByteString |
drop(int n)
|
|
ByteString |
dropRight(int n)
|
|
ByteString |
dropWhile(scala.Function1<java.lang.Object,java.lang.Object> p)
|
|
static ByteString |
empty()
|
|
|
foreach(scala.Function1<java.lang.Object,U> f)
|
|
static ByteString |
fromArray(byte[] array)
Creates a new ByteString by copying a byte array. |
|
static ByteString |
fromArray(byte[] array,
int offset,
int length)
Creates a new ByteString by copying length bytes starting at offset from an Array. |
|
static ByteString |
fromByteBuffer(java.nio.ByteBuffer buffer)
Creates a new ByteString by copying bytes out of a ByteBuffer. |
|
static ByteString |
fromInts(int... array)
JAVA API Creates a new ByteString by copying an int array by converting from integral numbers to bytes. |
|
static ByteString |
fromInts(scala.collection.Seq<java.lang.Object> array)
JAVA API Creates a new ByteString by copying an int array by converting from integral numbers to bytes. |
|
static ByteString |
fromString(java.lang.String string)
Creates a new ByteString which will contain the UTF-8 representation of the given String |
|
static ByteString |
fromString(java.lang.String string,
java.lang.String charset)
Creates a new ByteString which will contain the representation of the given String in the given charset |
|
java.lang.Iterable<java.nio.ByteBuffer> |
getByteBuffers()
Java API: Returns an Iterable of read-only ByteBuffers that directly wraps this ByteStrings all fragments. |
|
byte |
head()
|
|
|
indexOf(B elem)
|
|
int |
indexWhere(scala.Function1<java.lang.Object,java.lang.Object> p)
|
|
ByteString |
init()
|
|
abstract boolean |
isCompact()
Check whether this ByteString is compact in memory. |
|
ByteIterator |
iterator()
|
|
byte |
last()
|
|
ByteString |
mapI(scala.Function1<java.lang.Object,java.lang.Object> f)
map method that will automatically cast Int back into Byte. |
|
protected ByteStringBuilder |
newBuilder()
|
|
ByteString |
slice(int from,
int until)
|
|
scala.Tuple2<ByteString,ByteString> |
span(scala.Function1<java.lang.Object,java.lang.Object> p)
|
|
scala.Tuple2<ByteString,ByteString> |
splitAt(int n)
|
|
ByteString |
tail()
|
|
ByteString |
take(int n)
|
|
ByteString |
takeRight(int n)
|
|
ByteString |
takeWhile(scala.Function1<java.lang.Object,java.lang.Object> p)
|
|
protected byte[] |
toArray()
Java API: copy this ByteString into a fresh byte array |
|
|
toArray(scala.reflect.ClassTag<B> arg0)
|
|
java.nio.ByteBuffer |
toByteBuffer()
Creates a new ByteBuffer with a copy of all bytes contained in this ByteString. |
|
java.lang.String |
utf8String()
Decodes this ByteString as a UTF-8 encoded String. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface scala.collection.immutable.IndexedSeq |
|---|
companion, seq, toIndexedSeq |
| Methods inherited from interface scala.collection.immutable.Seq |
|---|
parCombiner, toSeq |
| Methods inherited from interface scala.PartialFunction |
|---|
andThen, applyOrElse, isDefinedAt, lift, orElse, runWith |
| Methods inherited from interface scala.Function1 |
|---|
apply, apply$mcDD$sp, apply$mcDF$sp, apply$mcDI$sp, apply$mcDJ$sp, apply$mcFD$sp, apply$mcFF$sp, apply$mcFI$sp, apply$mcFJ$sp, apply$mcID$sp, apply$mcIF$sp, apply$mcII$sp, apply$mcIJ$sp, apply$mcJD$sp, apply$mcJF$sp, apply$mcJI$sp, apply$mcJJ$sp, apply$mcVD$sp, apply$mcVF$sp, apply$mcVI$sp, apply$mcVJ$sp, apply$mcZD$sp, apply$mcZF$sp, apply$mcZI$sp, apply$mcZJ$sp, compose, toString |
| Methods inherited from interface scala.collection.generic.GenericTraversableTemplate |
|---|
flatten, genericBuilder, isEmpty, transpose, unzip, unzip3 |
| Methods inherited from interface scala.collection.IndexedSeqLike |
|---|
hashCode, thisCollection, toBuffer, toCollection |
| Methods inherited from interface scala.collection.SeqLike |
|---|
$colon$plus, $plus$colon, combinations, contains, containsSlice, corresponds, diff, distinct, endsWith, indexOfSlice, indexOfSlice, indexWhere, indices, intersect, isEmpty, lastIndexOfSlice, lastIndexOfSlice, lastIndexWhere, length, lengthCompare, padTo, patch, permutations, reverse, reverseIterator, reverseMap, segmentLength, size, sortBy, sorted, sortWith, startsWith, toString, union, updated, view, view |
| Methods inherited from interface scala.collection.IterableLike |
|---|
canEqual, exists, find, foldRight, forall, grouped, reduceRight, sameElements, sliding, sliding, toIterable, toIterator, toStream, zip, zipAll, zipWithIndex |
| Methods inherited from interface scala.collection.TraversableLike |
|---|
$plus$plus, $plus$plus$colon, $plus$plus$colon, collect, filter, filterNot, flatMap, groupBy, hasDefiniteSize, headOption, inits, isTraversableAgain, lastOption, map, partition, repr, scan, scanLeft, scanRight, sliceWithKnownBound, sliceWithKnownDelta, stringPrefix, tails, to, toTraversable, withFilter |
| Methods inherited from interface scala.collection.TraversableOnce |
|---|
$colon$bslash, $div$colon, addString, addString, addString, aggregate, collectFirst, copyToArray, copyToArray, copyToBuffer, count, fold, foldLeft, max, maxBy, min, minBy, mkString, mkString, mkString, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, reduceRightOption, reversed, sum, toList, toMap, toSet, toVector |
| Methods inherited from interface scala.collection.GenSeqLike |
|---|
equals, indexOf, isDefinedAt, lastIndexOf, lastIndexOf, lastIndexWhere, prefixLength, startsWith |
| Methods inherited from interface scala.collection.Parallelizable |
|---|
par |
| Methods inherited from interface scala.collection.IndexedSeqOptimized |
|---|
endsWith, exists, find, foldLeft, foldRight, forall, indexWhere, isEmpty, lastIndexWhere, lengthCompare, reduceLeft, reduceRight, reverse, reverseIterator, sameElements, segmentLength, startsWith, zip, zipWithIndex |
| Constructor Detail |
|---|
public ByteString()
| Method Detail |
|---|
public static ByteString fromInts(int... array)
array - (undocumented)
public static ByteString fromArray(byte[] array)
array - (undocumented)
public static ByteString fromArray(byte[] array,
int offset,
int length)
array - (undocumented)offset - (undocumented)length - (undocumented)
public static ByteString fromInts(scala.collection.Seq<java.lang.Object> array)
array - (undocumented)
public static ByteString fromString(java.lang.String string)
string - (undocumented)
public static ByteString fromString(java.lang.String string,
java.lang.String charset)
string - (undocumented)charset - (undocumented)
public static ByteString fromByteBuffer(java.nio.ByteBuffer buffer)
buffer - (undocumented)
public static ByteString empty()
public static scala.collection.generic.CanBuildFrom<scala.collection.TraversableOnce<java.lang.Object>,java.lang.Object,ByteString> canBuildFrom()
public abstract byte apply(int idx)
apply in interface scala.collection.GenSeqLike<java.lang.Object,ByteString>apply in interface scala.collection.SeqLike<java.lang.Object,ByteString>protected ByteStringBuilder newBuilder()
newBuilder in interface scala.collection.generic.GenericTraversableTemplate<java.lang.Object,scala.collection.GenTraversable>newBuilder in interface scala.collection.generic.HasNewBuilder<java.lang.Object,ByteString>newBuilder in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteIterator iterator()
iterator in interface scala.collection.GenIterableLike<java.lang.Object,ByteString>iterator in interface scala.collection.IndexedSeqLike<java.lang.Object,ByteString>iterator in interface scala.collection.IterableLike<java.lang.Object,ByteString>public byte head()
head in interface scala.collection.generic.GenericTraversableTemplate<java.lang.Object,scala.collection.GenTraversable>head in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>head in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>head in interface scala.collection.IterableLike<java.lang.Object,ByteString>head in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteString tail()
tail in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>tail in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>tail in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public byte last()
last in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>last in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>last in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteString init()
init in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>init in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>init in interface scala.collection.TraversableLike<java.lang.Object,ByteString>
public ByteString slice(int from,
int until)
slice in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>slice in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>slice in interface scala.collection.IterableLike<java.lang.Object,ByteString>slice in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteString take(int n)
take in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>take in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>take in interface scala.collection.IterableLike<java.lang.Object,ByteString>take in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteString takeRight(int n)
takeRight in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>takeRight in interface scala.collection.IterableLike<java.lang.Object,ByteString>public ByteString drop(int n)
drop in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>drop in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>drop in interface scala.collection.IterableLike<java.lang.Object,ByteString>drop in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteString dropRight(int n)
dropRight in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>dropRight in interface scala.collection.IterableLike<java.lang.Object,ByteString>public ByteString takeWhile(scala.Function1<java.lang.Object,java.lang.Object> p)
takeWhile in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>takeWhile in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>takeWhile in interface scala.collection.IterableLike<java.lang.Object,ByteString>takeWhile in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public ByteString dropWhile(scala.Function1<java.lang.Object,java.lang.Object> p)
dropWhile in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>dropWhile in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>dropWhile in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public scala.Tuple2<ByteString,ByteString> span(scala.Function1<java.lang.Object,java.lang.Object> p)
span in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>span in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>span in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public scala.Tuple2<ByteString,ByteString> splitAt(int n)
splitAt in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>splitAt in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>splitAt in interface scala.collection.TraversableLike<java.lang.Object,ByteString>public int indexWhere(scala.Function1<java.lang.Object,java.lang.Object> p)
indexWhere in interface scala.collection.GenSeqLike<java.lang.Object,ByteString>public <B> int indexOf(B elem)
indexOf in interface scala.collection.GenSeqLike<java.lang.Object,ByteString>protected byte[] toArray()
public <B> java.lang.Object toArray(scala.reflect.ClassTag<B> arg0)
toArray in interface scala.collection.GenTraversableOnce<java.lang.Object>toArray in interface scala.collection.TraversableOnce<java.lang.Object>
public <B> void copyToArray(java.lang.Object xs,
int start,
int len)
copyToArray in interface scala.collection.GenTraversableOnce<java.lang.Object>copyToArray in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>copyToArray in interface scala.collection.IterableLike<java.lang.Object,ByteString>copyToArray in interface scala.collection.TraversableLike<java.lang.Object,ByteString>copyToArray in interface scala.collection.TraversableOnce<java.lang.Object>public <U> void foreach(scala.Function1<java.lang.Object,U> f)
foreach in interface scala.collection.generic.FilterMonadic<java.lang.Object,ByteString>foreach in interface scala.collection.generic.GenericTraversableTemplate<java.lang.Object,scala.collection.GenTraversable>foreach in interface scala.collection.GenTraversableLike<java.lang.Object,ByteString>foreach in interface scala.collection.GenTraversableOnce<java.lang.Object>foreach in interface scala.collection.IndexedSeqOptimized<java.lang.Object,ByteString>foreach in interface scala.collection.IterableLike<java.lang.Object,ByteString>foreach in interface scala.collection.TraversableLike<java.lang.Object,ByteString>foreach in interface scala.collection.TraversableOnce<java.lang.Object>public ByteString concat(ByteString that)
that - (undocumented)
public int copyToBuffer(java.nio.ByteBuffer buffer)
buffer - a ByteBuffer to copy bytes to
public abstract CompactByteString compact()
public abstract boolean isCompact()
public abstract java.nio.ByteBuffer asByteBuffer()
public abstract scala.collection.immutable.Iterable<java.nio.ByteBuffer> asByteBuffers()
public java.lang.Iterable<java.nio.ByteBuffer> getByteBuffers()
public java.nio.ByteBuffer toByteBuffer()
public final java.lang.String utf8String()
public abstract java.lang.String decodeString(java.lang.String charset)
charset - (undocumented)
public final ByteString mapI(scala.Function1<java.lang.Object,java.lang.Object> f)
f - (undocumented)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||