Maxim Integrated / Mbed OS MAXREFDES155#

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   MaximInterface

Embed: (wiki syntax)

« Back to documentation index

Stream Class Reference

Stream Class Reference

Concept for reading and writing characters. More...

#include <stream.h>

Detailed Description

Concept for reading and writing characters.

For read-only stream, no need to implement PutBegin(), Put(), Flush() and PutEnd().

For write-only stream, only need to implement Put() and Flush().

concept Stream {
    typename Ch;    //!< Character type of the stream.

    //! Read the current character from stream without moving the read cursor.
    Ch Peek() const;

    //! Read the current character from stream and moving the read cursor to next character.
    Ch Take();

    //! Get the current read cursor.
    //! \return Number of characters read from start.
    size_t Tell();

    //! Begin writing operation at the current read pointer.
    //! \return The begin writer pointer.
    Ch* PutBegin();

    //! Write a character.
    void Put(Ch c);

    //! Flush the buffer.
    void Flush();

    //! End the writing operation.
    //! \param begin The begin write pointer returned by PutBegin().
    //! \return Number of characters written.
    size_t PutEnd(Ch* begin);
}
Generated on Tue Jul 12 2022 12:06:51 by  doxygen 1.7.2