|
| 1 | +:source-highlighter: pygments |
| 2 | +:pygments-style: arduino |
| 3 | +:ext-relative: adoc |
| 4 | + |
| 5 | += Stream |
| 6 | + |
| 7 | + |
| 8 | +// OVERVIEW SECTION STARTS |
| 9 | +[#overview] |
| 10 | +-- |
| 11 | + |
| 12 | +[float] |
| 13 | +=== Description |
| 14 | +Stream is the base class for character and binary based streams. It is not called directly, but invoked whenever you use a function that relies on it. |
| 15 | + |
| 16 | +Stream defines the reading functions in Arduino. When using any core functionality that uses a `read()` or similar method, you can safely assume it calls on the Stream class. For functions like `print()`, Stream inherits from the Print class. |
| 17 | + |
| 18 | +Some of the libraries that rely on Stream include : |
| 19 | + |
| 20 | +* link:serial{ext-relative}[Serial] + |
| 21 | +* link:{ext-relative}[Wire] + |
| 22 | +* link:{ext-relative}[Ethernet Client] + |
| 23 | +* link:{ext-relative}[Ethernet Server] + |
| 24 | +* link:{ext-relative}[SD] |
| 25 | + |
| 26 | + |
| 27 | +-- |
| 28 | +// OVERVIEW SECTION ENDS |
| 29 | + |
| 30 | + |
| 31 | +// FUNCTIONS SECTION STARTS |
| 32 | +[#functions] |
| 33 | +-- |
| 34 | + |
| 35 | +''' |
| 36 | + |
| 37 | +[float] |
| 38 | +=== Functions |
| 39 | +link:/Stream/streamAvailable{ext-relative}[available()] + |
| 40 | +link:/Stream/streamRead{ext-relative}[read()] + |
| 41 | +link:/Stream/streamFlush{ext-relative}[flush()] + |
| 42 | +link:/Stream/streamFind{ext-relative}[find()] + |
| 43 | +link:/Stream/streamFindUntil{ext-relative}[findUntil()] + |
| 44 | +link:/Stream/streamPeek{ext-relative}[peek()] + |
| 45 | +link:/Stream/streamReadBytes{ext-relative}[readBytes()] + |
| 46 | +link:/Stream/streamReadBytesUntil{ext-relative}[readBytesUntil()] + |
| 47 | +link:/Stream/streamReadString{ext-relative}[readString()] + |
| 48 | +link:/Stream/streamReadStringUntil{ext-relative}[readStringUntil()] + |
| 49 | +link:/Stream/streamParseInt{ext-relative}[parseInt()] + |
| 50 | +link:/Stream/streamParseFloat{ext-relative}[parseFloat()] + |
| 51 | +link:/Stream/streamSetTimeout{ext-relative}[setTimeout()] |
| 52 | + |
| 53 | +''' |
| 54 | + |
| 55 | +-- |
| 56 | +// FUNCTIONS SECTION ENDS |
0 commit comments