Class RealSource
- All Implemented Interfaces:
Closeable,AutoCloseable,Channel,ReadableByteChannel,BufferSource,Source
- Since:
- Java 17+
- Author:
- Kimi Liu
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()关闭此源并释放此源持有的资源.booleanReturns true if there are no more bytes in this source.This source's internal buffer.longindexOf(byte b) Equivalent toindexOf(b, 0).longindexOf(byte b, long fromIndex) Returns the index of the firstbin the buffer at or afterfromIndex.longindexOf(byte b, long fromIndex, long toIndex) Returns the index ofbif it is found in the range offromIndexinclusive totoIndexexclusive.longindexOf(ByteString bytes) Equivalent toindexOf(bytes, 0).longindexOf(ByteString bytes, long fromIndex) Returns the index of the first match forbytesin the buffer at or afterfromIndex.longindexOfElement(ByteString targetBytes) Equivalent toindexOfElement(targetBytes, 0).longindexOfElement(ByteString targetBytes, long fromIndex) Returns the first index in this buffer that is at or afterfromIndexand that contains any of the bytes intargetBytes.Returns an input stream that reads from this source.booleanisOpen()peek()Returns a newBufferedSourcethat can read data from thisBufferedSourcewithout consuming it.booleanrangeEquals(long offset, ByteString bytes) Returns true if the bytes atoffsetin this source equalbytes.booleanrangeEquals(long offset, ByteString bytes, int bytesOffset, int byteCount) Returns true ifbyteCountbytes atoffsetin this source equalbytesatbytesOffset.intread(byte[] sink) Removes up tosink.lengthbytes from this and copies them intosink.intread(byte[] sink, int offset, int byteCount) Removes up tobyteCountbytes from this and copies them intosinkatoffset.intread(ByteBuffer sink) long从中删除至少1个字节,最多为byteCount字节, 并将它们 附加到sink。longRemoves all bytes from this and appends them tosink.bytereadByte()Removes a byte from this source and returns it.byte[]Removes all bytes from this and returns them as a byte array.byte[]readByteArray(long byteCount) RemovesbyteCountbytes from this and returns them as a byte array.Removes all bytes bytes from this and returns them as a byte string.readByteString(long byteCount) RemovesbyteCountbytes from this and returns them as a byte string.longReads a long from this source in signed decimal form (i.e., as a string in base 10 with optional leading '-').voidreadFully(byte[] sink) Removes exactlysink.lengthbytes from this and copies them intosink.voidRemoves exactlybyteCountbytes from this and appends them tosink.longReads a long form this source in hexadecimal form (i.e., as a string in base 16).intreadInt()Removes four bytes from this source and returns a big-endian int.intRemoves four bytes from this source and returns a little-endian int.longreadLong()Removes eight bytes from this source and returns a big-endian long.longRemoves eight bytes from this source and returns a little-endian long.shortRemoves two bytes from this source and returns a big-endian short.shortRemoves two bytes from this source and returns a little-endian short.readString(long byteCount, Charset charset) RemovesbyteCountbytes from this, decodes them ascharset, and returns the string.readString(Charset charset) Removes all bytes from this, decodes them ascharset, and returns the string.readUtf8()Removes all bytes from this, decodes them as UTF-8, and returns the string.readUtf8(long byteCount) RemovesbyteCountbytes from this, decodes them as UTF-8, and returns the string.intRemoves and returns a single UTF-8 code point, reading between 1 and 4 bytes as necessary.Removes and returns characters up to but not including the next line break.Removes and returns characters up to but not including the next line break.readUtf8LineStrict(long limit) LikeBufferSource.readUtf8LineStrict(), except this allows the caller to specify the longest allowed match.booleanrequest(long byteCount) Returns true when the buffer contains at leastbyteCountbytes, expanding it as necessary.voidrequire(long byteCount) Returns when the buffer contains at leastbyteCountbytes.intFinds the first string inoptionsthat is a prefix of this buffer, consumes it from this buffer, and returns its index.voidskip(long byteCount) Reads and discardsbyteCountbytes from this source.timeout()返回此源的超时时间.toString()
-
Field Details
-
buffer
-
source
-
-
Constructor Details
-
RealSource
-
-
Method Details
-
getBuffer
Description copied from interface:BufferSourceThis source's internal buffer.- Specified by:
getBufferin interfaceBufferSource
-
read
Description copied from interface:Source从中删除至少1个字节,最多为byteCount字节, 并将它们 附加到sink。返回读取的字节数,如果该源已耗尽,则返回-1- Specified by:
readin interfaceSource- Parameters:
sink- 缓冲byteCount- 长度大小- Returns:
- the long
- Throws:
IOException-IOExceptionIOException.
-
exhausted
Description copied from interface:BufferSourceReturns true if there are no more bytes in this source. This will block until there are bytes to read or the source is definitely exhausted.- Specified by:
exhaustedin interfaceBufferSource- Throws:
IOException
-
require
Description copied from interface:BufferSourceReturns when the buffer contains at leastbyteCountbytes. Throws anEOFExceptionif the source is exhausted before the required bytes can be read.- Specified by:
requirein interfaceBufferSource- Throws:
IOException
-
request
Description copied from interface:BufferSourceReturns true when the buffer contains at leastbyteCountbytes, expanding it as necessary. Returns false if the source is exhausted before the requested bytes can be read.- Specified by:
requestin interfaceBufferSource- Throws:
IOException
-
readByte
Description copied from interface:BufferSourceRemoves a byte from this source and returns it.- Specified by:
readBytein interfaceBufferSource- Throws:
IOException
-
readByteString
Description copied from interface:BufferSourceRemoves all bytes bytes from this and returns them as a byte string.- Specified by:
readByteStringin interfaceBufferSource- Returns:
- the
ByteString - Throws:
IOException
-
readByteString
Description copied from interface:BufferSourceRemovesbyteCountbytes from this and returns them as a byte string.- Specified by:
readByteStringin interfaceBufferSource- Returns:
- the
ByteString - Throws:
IOException
-
select
Description copied from interface:BufferSourceFinds the first string inoptionsthat is a prefix of this buffer, consumes it from this buffer, and returns its index. If no byte string inoptionsis a prefix of this buffer this returns -1 and no bytes are consumed.This can be used as an alternative to
BufferSource.readByteString()or evenBufferSource.readUtf8()if the set of expected values is known in advance.Options FIELDS = Options.of(ByteString.encodeUtf8("depth="), ByteString.encodeUtf8("height="), ByteString.encodeUtf8("width=")); Buffer buffer = new Buffer().writeUtf8("width=640\n").writeUtf8("height=480\n"); assertEquals(2, buffer.select(FIELDS)); assertEquals(640, buffer.readDecimalLong()); assertEquals('\n', buffer.readByte()); assertEquals(1, buffer.select(FIELDS)); assertEquals(480, buffer.readDecimalLong()); assertEquals('\n', buffer.readByte());- Specified by:
selectin interfaceBufferSource- Returns:
- the int
- Throws:
IOException
-
readByteArray
Description copied from interface:BufferSourceRemoves all bytes from this and returns them as a byte array.- Specified by:
readByteArrayin interfaceBufferSource- Returns:
- the byte
- Throws:
IOException
-
readByteArray
Description copied from interface:BufferSourceRemovesbyteCountbytes from this and returns them as a byte array.- Specified by:
readByteArrayin interfaceBufferSource- Returns:
- the byte
- Throws:
IOException
-
read
Description copied from interface:BufferSourceRemoves up tosink.lengthbytes from this and copies them intosink. Returns the number of bytes read, or -1 if this source is exhausted.- Specified by:
readin interfaceBufferSource- Throws:
IOException
-
readFully
Description copied from interface:BufferSourceRemoves exactlysink.lengthbytes from this and copies them intosink. Throws anEOFExceptionif the requested number of bytes cannot be read.- Specified by:
readFullyin interfaceBufferSource- Throws:
IOException
-
read
Description copied from interface:BufferSourceRemoves up tobyteCountbytes from this and copies them intosinkatoffset. Returns the number of bytes read, or -1 if this source is exhausted.- Specified by:
readin interfaceBufferSource- Throws:
IOException
-
read
- Specified by:
readin interfaceReadableByteChannel- Throws:
IOException
-
readFully
Description copied from interface:BufferSourceRemoves exactlybyteCountbytes from this and appends them tosink. Throws anEOFExceptionif the requested number of bytes cannot be read.- Specified by:
readFullyin interfaceBufferSource- Throws:
IOException
-
readAll
Description copied from interface:BufferSourceRemoves all bytes from this and appends them tosink. Returns the total number of bytes written tosinkwhich will be 0 if this is exhausted.- Specified by:
readAllin interfaceBufferSource- Throws:
IOException
-
readUtf8
Description copied from interface:BufferSourceRemoves all bytes from this, decodes them as UTF-8, and returns the string. Returns the empty string if this source is empty.Buffer buffer = new Buffer().writeUtf8("Uh uh uh!").writeByte(' ').writeUtf8("You didn't say the magic word!"); assertEquals("Uh uh uh! You didn't say the magic word!", buffer.readUtf8()); assertEquals(0, buffer.size()); assertEquals("", buffer.readUtf8()); assertEquals(0, buffer.size());- Specified by:
readUtf8in interfaceBufferSource- Throws:
IOException
-
readUtf8
Description copied from interface:BufferSourceRemovesbyteCountbytes from this, decodes them as UTF-8, and returns the string.Buffer buffer = new Buffer().writeUtf8("Uh uh uh!").writeByte(' ').writeUtf8("You didn't say the magic word!"); assertEquals(40, buffer.size()); assertEquals("Uh uh uh! You ", buffer.readUtf8(14)); assertEquals(26, buffer.size()); assertEquals("didn't say the", buffer.readUtf8(14)); assertEquals(12, buffer.size()); assertEquals(" magic word!", buffer.readUtf8(12)); assertEquals(0, buffer.size());- Specified by:
readUtf8in interfaceBufferSource- Throws:
IOException
-
readString
Description copied from interface:BufferSourceRemoves all bytes from this, decodes them ascharset, and returns the string.- Specified by:
readStringin interfaceBufferSource- Throws:
IOException
-
readString
Description copied from interface:BufferSourceRemovesbyteCountbytes from this, decodes them ascharset, and returns the string.- Specified by:
readStringin interfaceBufferSource- Throws:
IOException
-
readUtf8Line
Description copied from interface:BufferSourceRemoves and returns characters up to but not including the next line break. A line break is either"\n"or"\r\n"; these characters are not included in the result.Buffer buffer = new Buffer().writeUtf8("I'm a hacker!\n").writeUtf8("That's what I said: you're a nerd.\n") .writeUtf8("I prefer to be called a hacker!\n"); assertEquals(81, buffer.size()); assertEquals("I'm a hacker!", buffer.readUtf8Line()); assertEquals(67, buffer.size()); assertEquals("That's what I said: you're a nerd.", buffer.readUtf8Line()); assertEquals(32, buffer.size()); assertEquals("I prefer to be called a hacker!", buffer.readUtf8Line()); assertEquals(0, buffer.size()); assertEquals(null, buffer.readUtf8Line()); assertEquals(0, buffer.size());On the end of the stream this method returns null, just like
BufferedReader. If the source doesn't end with a line break then an implicit line break is assumed. Null is returned once the source is exhausted. Use this for human-generated data, where a trailing line break is optional.- Specified by:
readUtf8Linein interfaceBufferSource- Throws:
IOException
-
readUtf8LineStrict
Description copied from interface:BufferSourceRemoves and returns characters up to but not including the next line break. A line break is either"\n"or"\r\n"; these characters are not included in the result.On the end of the stream this method throws. Every call must consume either '\r\n' or '\n'. If these characters are absent in the stream, an
EOFExceptionis thrown. Use this for machine-generated data where a missing line break implies truncated input.- Specified by:
readUtf8LineStrictin interfaceBufferSource- Throws:
IOException
-
readUtf8LineStrict
Description copied from interface:BufferSourceLikeBufferSource.readUtf8LineStrict(), except this allows the caller to specify the longest allowed match. Use this to protect against streams that may not include"\n"or"\r\n".The returned string will have at most
limitUTF-8 bytes, and the maximum number of bytes scanned islimit + 2. Iflimit == 0this will always throw anEOFExceptionbecause no bytes will be scanned.This method is safe. No bytes are discarded if the match fails, and the caller is free to try another match:
Buffer buffer = new Buffer(); buffer.writeUtf8("12345\r\n"); // This will throw! There must be \r\n or \n at the limit or before it. buffer.readUtf8LineStrict(4); // No bytes have been consumed so the caller can retry. assertEquals("12345", buffer.readUtf8LineStrict(5));- Specified by:
readUtf8LineStrictin interfaceBufferSource- Throws:
IOException
-
readUtf8CodePoint
Description copied from interface:BufferSourceRemoves and returns a single UTF-8 code point, reading between 1 and 4 bytes as necessary.If this source is exhausted before a complete code point can be read, this throws an
EOFExceptionand consumes no input.If this source doesn't start with a properly-encoded UTF-8 code point, this method will remove 1 or more non-UTF-8 bytes and return the replacement character (
U+FFFD). This covers encoding problems (the input is not properly-encoded UTF-8), characters out of range (beyond the 0x10ffff limit of Unicode), code points for UTF-16 surrogates (U+d800..U+dfff) and overlong encodings (such as0xc080for the NUL character in modified UTF-8).- Specified by:
readUtf8CodePointin interfaceBufferSource- Throws:
IOException
-
readShort
Description copied from interface:BufferSourceRemoves two bytes from this source and returns a big-endian short.Buffer buffer = new Buffer().writeByte(0x7f).writeByte(0xff).writeByte(0x00).writeByte(0x0f); assertEquals(4, buffer.size()); assertEquals(32767, buffer.readShort()); assertEquals(2, buffer.size()); assertEquals(15, buffer.readShort()); assertEquals(0, buffer.size());- Specified by:
readShortin interfaceBufferSource- Throws:
IOException
-
readShortLe
Description copied from interface:BufferSourceRemoves two bytes from this source and returns a little-endian short.Buffer buffer = new Buffer().writeByte(0xff).writeByte(0x7f).writeByte(0x0f).writeByte(0x00); assertEquals(4, buffer.size()); assertEquals(32767, buffer.readShortLe()); assertEquals(2, buffer.size()); assertEquals(15, buffer.readShortLe()); assertEquals(0, buffer.size());- Specified by:
readShortLein interfaceBufferSource- Throws:
IOException
-
readInt
Description copied from interface:BufferSourceRemoves four bytes from this source and returns a big-endian int.Buffer buffer = new Buffer().writeByte(0x7f).writeByte(0xff).writeByte(0xff).writeByte(0xff).writeByte(0x00) .writeByte(0x00).writeByte(0x00).writeByte(0x0f); assertEquals(8, buffer.size()); assertEquals(2147483647, buffer.readInt()); assertEquals(4, buffer.size()); assertEquals(15, buffer.readInt()); assertEquals(0, buffer.size());- Specified by:
readIntin interfaceBufferSource- Returns:
- the int
- Throws:
IOException
-
readIntLe
Description copied from interface:BufferSourceRemoves four bytes from this source and returns a little-endian int.Buffer buffer = new Buffer().writeByte(0xff).writeByte(0xff).writeByte(0xff).writeByte(0x7f).writeByte(0x0f) .writeByte(0x00).writeByte(0x00).writeByte(0x00); assertEquals(8, buffer.size()); assertEquals(2147483647, buffer.readIntLe()); assertEquals(4, buffer.size()); assertEquals(15, buffer.readIntLe()); assertEquals(0, buffer.size());- Specified by:
readIntLein interfaceBufferSource- Returns:
- the int
- Throws:
IOException
-
readLong
Description copied from interface:BufferSourceRemoves eight bytes from this source and returns a big-endian long.Buffer buffer = new Buffer().writeByte(0x7f).writeByte(0xff).writeByte(0xff).writeByte(0xff).writeByte(0xff) .writeByte(0xff).writeByte(0xff).writeByte(0xff).writeByte(0x00).writeByte(0x00).writeByte(0x00) .writeByte(0x00).writeByte(0x00).writeByte(0x00).writeByte(0x00).writeByte(0x0f); assertEquals(16, buffer.size()); assertEquals(9223372036854775807L, buffer.readLong()); assertEquals(8, buffer.size()); assertEquals(15, buffer.readLong()); assertEquals(0, buffer.size());- Specified by:
readLongin interfaceBufferSource- Returns:
- the long
- Throws:
IOException
-
readLongLe
Description copied from interface:BufferSourceRemoves eight bytes from this source and returns a little-endian long.Buffer buffer = new Buffer().writeByte(0xff).writeByte(0xff).writeByte(0xff).writeByte(0xff).writeByte(0xff) .writeByte(0xff).writeByte(0xff).writeByte(0x7f).writeByte(0x0f).writeByte(0x00).writeByte(0x00) .writeByte(0x00).writeByte(0x00).writeByte(0x00).writeByte(0x00).writeByte(0x00); assertEquals(16, buffer.size()); assertEquals(9223372036854775807L, buffer.readLongLe()); assertEquals(8, buffer.size()); assertEquals(15, buffer.readLongLe()); assertEquals(0, buffer.size());- Specified by:
readLongLein interfaceBufferSource- Returns:
- the long
- Throws:
IOException
-
readDecimalLong
Description copied from interface:BufferSourceReads a long from this source in signed decimal form (i.e., as a string in base 10 with optional leading '-'). This will iterate until a non-digit character is found.Buffer buffer = new Buffer().writeUtf8("8675309 -123 00001"); assertEquals(8675309L, buffer.readDecimalLong()); assertEquals(' ', buffer.readByte()); assertEquals(-123L, buffer.readDecimalLong()); assertEquals(' ', buffer.readByte()); assertEquals(1L, buffer.readDecimalLong());- Specified by:
readDecimalLongin interfaceBufferSource- Returns:
- the long
- Throws:
IOException
-
readHexadecimalUnsignedLong
Description copied from interface:BufferSourceReads a long form this source in hexadecimal form (i.e., as a string in base 16). This will iterate until a non-hexadecimal character is found.Buffer buffer = new Buffer().writeUtf8("ffff CAFEBABE 10"); assertEquals(65535L, buffer.readHexadecimalUnsignedLong()); assertEquals(' ', buffer.readByte()); assertEquals(0xcafebabeL, buffer.readHexadecimalUnsignedLong()); assertEquals(' ', buffer.readByte()); assertEquals(0x10L, buffer.readHexadecimalUnsignedLong());- Specified by:
readHexadecimalUnsignedLongin interfaceBufferSource- Returns:
- the long
- Throws:
IOException
-
skip
Description copied from interface:BufferSourceReads and discardsbyteCountbytes from this source. Throws anEOFExceptionif the source is exhausted before the requested bytes can be skipped.- Specified by:
skipin interfaceBufferSource- Throws:
IOException
-
indexOf
Description copied from interface:BufferSourceEquivalent toindexOf(b, 0).- Specified by:
indexOfin interfaceBufferSource- Throws:
IOException
-
indexOf
Description copied from interface:BufferSourceReturns the index of the firstbin the buffer at or afterfromIndex. This expands the buffer as necessary untilbis found. This reads an unbounded number of bytes into the buffer. Returns -1 if the stream is exhausted before the requested byte is found.Buffer buffer = new Buffer(); buffer.writeUtf8("Don't move! He can't see us if we don't move."); byte m = 'm'; assertEquals(6, buffer.indexOf(m)); assertEquals(40, buffer.indexOf(m, 12));- Specified by:
indexOfin interfaceBufferSource- Throws:
IOException
-
indexOf
Description copied from interface:BufferSourceReturns the index ofbif it is found in the range offromIndexinclusive totoIndexexclusive. Ifbisn't found, or iffromIndex == toIndex, then -1 is returned.The scan terminates at either
toIndexor the end of the buffer, whichever comes first. The maximum number of bytes scanned istoIndex-fromIndex.- Specified by:
indexOfin interfaceBufferSource- Throws:
IOException
-
indexOf
Description copied from interface:BufferSourceEquivalent toindexOf(bytes, 0).- Specified by:
indexOfin interfaceBufferSource- Throws:
IOException
-
indexOf
Description copied from interface:BufferSourceReturns the index of the first match forbytesin the buffer at or afterfromIndex. This expands the buffer as necessary untilbytesis found. This reads an unbounded number of bytes into the buffer. Returns -1 if the stream is exhausted before the requested bytes are found.ByteString MOVE = ByteString.encodeUtf8("move"); Buffer buffer = new Buffer(); buffer.writeUtf8("Don't move! He can't see us if we don't move."); assertEquals(6, buffer.indexOf(MOVE)); assertEquals(40, buffer.indexOf(MOVE, 12));- Specified by:
indexOfin interfaceBufferSource- Throws:
IOException
-
indexOfElement
Description copied from interface:BufferSourceEquivalent toindexOfElement(targetBytes, 0).- Specified by:
indexOfElementin interfaceBufferSource- Throws:
IOException
-
indexOfElement
Description copied from interface:BufferSourceReturns the first index in this buffer that is at or afterfromIndexand that contains any of the bytes intargetBytes. This expands the buffer as necessary until a target byte is found. This reads an unbounded number of bytes into the buffer. Returns -1 if the stream is exhausted before the requested byte is found.ByteString ANY_VOWEL = ByteString.encodeUtf8("AEOIUaeoiu"); Buffer buffer = new Buffer(); buffer.writeUtf8("Dr. Alan Grant"); assertEquals(4, buffer.indexOfElement(ANY_VOWEL)); // 'A' in 'Alan'. assertEquals(11, buffer.indexOfElement(ANY_VOWEL, 9)); // 'a' in 'Grant'.- Specified by:
indexOfElementin interfaceBufferSource- Throws:
IOException
-
rangeEquals
Description copied from interface:BufferSourceReturns true if the bytes atoffsetin this source equalbytes. This expands the buffer as necessary until a byte does not match, all bytes are matched, or if the stream is exhausted before enough bytes could determine a match.ByteString simonSays = ByteString.encodeUtf8("Simon says:"); Buffer standOnOneLeg = new Buffer().writeUtf8("Simon says: Stand on one leg."); assertTrue(standOnOneLeg.rangeEquals(0, simonSays)); Buffer payMeMoney = new Buffer().writeUtf8("Pay me $1,000,000."); assertFalse(payMeMoney.rangeEquals(0, simonSays));- Specified by:
rangeEqualsin interfaceBufferSource- Throws:
IOException
-
rangeEquals
public boolean rangeEquals(long offset, ByteString bytes, int bytesOffset, int byteCount) throws IOException Description copied from interface:BufferSourceReturns true ifbyteCountbytes atoffsetin this source equalbytesatbytesOffset. This expands the buffer as necessary until a byte does not match, all bytes are matched, or if the stream is exhausted before enough bytes could determine a match.- Specified by:
rangeEqualsin interfaceBufferSource- Throws:
IOException
-
peek
Description copied from interface:BufferSourceReturns a newBufferedSourcethat can read data from thisBufferedSourcewithout consuming it. The returned source becomes invalid once this source is next read or closed.For example, we can use
peek()to lookahead and read the same data multiple times.Buffer buffer = new Buffer(); buffer.writeUtf8("abcdefghi"); buffer.readUtf8(3) // returns "abc", buffer contains "defghi" BufferedSource peek = buffer.peek(); peek.readUtf8(3); // returns "def", buffer contains "defghi" peek.readUtf8(3); // returns "ghi", buffer contains "defghi" buffer.readUtf8(3); // returns "def", buffer contains "ghi"- Specified by:
peekin interfaceBufferSource
-
inputStream
Description copied from interface:BufferSourceReturns an input stream that reads from this source.- Specified by:
inputStreamin interfaceBufferSource
-
isOpen
-
close
Description copied from interface:Source关闭此源并释放此源持有的资源. 读取闭源是一个错误。多次关闭源是安全的.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceChannel- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceSource- Throws:
IOException-IOExceptionIOException.
-
timeout
-
toString
-