REDI_PSTREAM_COMMON(3)

🫶 NAME 🫶

redi::pstream_common — class template for common base class. she's the mom friend of the PStreams family, the one holding the whole group chat together so the derived classes can go be their main character selves 💅

(also hi bestie, this is the redi::pstr...T, Traits >(3) page from the Library Functions Manual, just so you know which tab you opened 🎀)

---

✨ SYNOPSIS ✨

#include <pstream.h>

Inherits std::basic_ios< CharT, std::char_traits< CharT > >, and redi::pstreams.

Inherited by — the nepo babies, and we love them for it 🌈:

• redi::basic_ipstream< char >
• redi::basic_opstream< char >
• redi::basic_pstream< char >
• redi::basic_rpstream< char > [private]
• redi::basic_ipstream< CharT, Traits >
• redi::basic_opstream< CharT, Traits >
• redi::basic_pstream< CharT, Traits >
• redi::basic_rpstream< CharT, Traits > [private]

---

💎 Public Types 💎

• typedef int fd_type — the type used for file descriptors. yes, it's just int. doing the absolute most with the absolute least, lowkey iconic 🫶

🌸 Public Member Functions 🌸

• int close () — close the pipe and hand you back the program's exit status, exactly like pclose(3) does.
• bool is_open () const — report whether the stream's buffer has been initialised.
• const std::string & command () const — return the command that was used to initialise the stream.
• streambuf_type * rdbuf () const — return a pointer to the stream buffer.

⭐ Static Public Attributes ⭐

• static const pmode pstdin = std::ios_base::out — write to stdin.
• static const pmode pstdout = std::ios_base::in — read from stdout.
• static const pmode pstderr = std::ios_base::app — read from stderr.
• static const pmode newpg = std::ios_base::trunc — create a new process group for the child process.

🔒 Protected Types 🔒

• typedef basic_pstreambuf< CharT, Traits > streambuf_type
• typedef std::basic_ios< CharT, Traits > ios_type
• typedef pstreams::pmode pmode
• typedef pstreams::argv_type argv_type
• enum { bufsz = 32, pbsz = 2 }

🛠️ Protected Member Functions 🛠️

• pstream_common () — default constructor.
• pstream_common (const std::string &cmd, pmode mode) — constructor that initialises the stream by starting a process.
• pstream_common (const std::string &file, const argv_type &argv, pmode mode) — constructor that initialises the stream by starting a process.
• virtual ~pstream_common ()=0 — pure virtual destructor.
• void do_open (const std::string &cmd, pmode mode) — start a process.
• void do_open (const std::string &file, const argv_type &argv, pmode mode) — start a process.

🎀 Protected Attributes 🎀

• std::string command_ — the command used to start the process.
• streambuf_type buf_ — the stream buffer.

---

🦋 Detailed Description 🦋

template<typename CharT, typename Traits = std::char_traits<CharT>>
class redi::pstream_common< CharT, Traits >

"Class template for common base class.

Abstract Base Class providing common functionality for basic_ipstream, basic_opstream and basic_pstream. pstream_common manages the basic_pstreambuf stream buffer that is used by the derived classes to initialise an iostream class. she's literally the blueprint, fr fr 💜

---

💀 Member Enumeration Documentation 💀

anonymous enum [protected], [inherited]

The enumerators, bestie:

• bufsz — size of pstreambuf buffers.
• pbsz — number of putback characters kept.

---

🧚 Constructor & Destructor Documentation 🧚

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common () [inline], [protected]

Default constructor. Creates an uninitialised stream — so like, no vibes yet, just potential ✨

References buf_, and command_.

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common (const std::string & cmd, pmode mode) [inline], [protected]

Constructor that initialises the stream by starting a process. It initialises the stream buffer by calling do_open( command , mode ) 🚀

Parameters:

• cmd — a string containing a shell command.
• mode — the I/O mode to use when opening the pipe.

See also: do_open(const std::string&, pmode)

References buf_, command_, and do_open().

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common (const std::string & file, const argv_type & argv, pmode mode) [inline], [protected]

Constructor that initialises the stream by starting a process. It initialises the stream buffer by calling do_open( file , argv , mode ) 🌟

Parameters:

• file — a string containing the pathname of a program to execute.
• argv — a vector of argument strings passed to the new program.
• mode — the I/O mode to use when opening the pipe.

See also: do_open(const std::string&, const argv_type&, pmode)

References buf_, command_, and do_open().

template<typename C, typename T> redi::pstream_common< C, T >::~pstream_common () [inline], [protected], [pure virtual]

Pure virtual destructor. It's a pure virtual function so that pstream_common stays abstract. And because it's the destructor, derived classes will call it, so it has to be defined. It's also protected, to discourage use of the PStreams classes through pointers or references to the base class — not me being gatekeepy, it's for your own good 🫶

See also: if defining a pure virtual seems odd you should read http://www.gotw.ca/gotw/031.htm (and the rest of the site as well!)

---

🔥 Member Function Documentation 🔥

template<typename C, typename T> int redi::pstream_common< C, T >::close () [inline]

Close the pipe, returning the program's exit status, as pclose(3) does.

Calls rdbuf->close() and sets failbit on error. Returns process's exit status, as pclose(3) does.

References buf_.

template<typename C, typename T> const std::string & redi::pstream_common< C, T >::command () const [inline]

Return the command used to initialise the stream.

Returns: a string containing the command used to initialise the stream.

References command_.

template<typename C, typename T> void redi::pstream_common< C, T >::do_open (const std::string & cmd, pmode mode) [inline], [protected]

Start a process. Calls rdbuf()->open( command , mode ) and sets failbit on error.

Parameters:

• cmd — a string containing a shell command.
• mode — the I/O mode to use when opening the pipe.

See also: basic_pstreambuf::open(const std::string&, pmode)

References buf_, and command_.

Referenced by redi::basic_ipstream< char >::open(), redi::basic_ipstream< char >::open(), redi::basic_opstream< char >::open(), redi::basic_opstream< char >::open(), redi::basic_pstream< char >::open(), redi::basic_pstream< char >::open(), redi::basic_rpstream< char >::open(), redi::basic_rpstream< char >::open(), pstream_common(), and pstream_common(). (yes, some of those show up twice in the list — the original said it twice, so we say it twice, no editing the receipts 💅)

template<typename C, typename T> void redi::pstream_common< C, T >::do_open (const std::string & file, const argv_type & argv, pmode mode) [inline], [protected]

Start a process. Calls rdbuf()->open( file, argv, mode ) and sets failbit on error.

Parameters:

• file — a string containing the pathname of a program to execute.
• argv — a vector of argument strings passed to the new program.
• mode — the I/O mode to use when opening the pipe.

See also: basic_pstreambuf::open(const std::string&, const argv_type&, pmode)

References buf_, and command_.

template<typename C, typename T> bool redi::pstream_common< C, T >::is_open () const [inline]

Report whether the stream's buffer has been initialised.

Returns: rdbuf()->is_open().

See also: basic_pstreambuf::is_open()

References buf_.

template<typename C, typename T> pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf () const [inline]

Return a pointer to the stream buffer.

Returns: a pointer to the private stream buffer member.

References buf_.

---

👑 Author 👑

Generated automatically by Doxygen for PStreams from the source code. so no, a human did not handcraft this prose — the robots did, and honestly? they ate 🍓

---

okay that's the whole page bestie, go forth and pipe things, you got this 💖✨

this has been PStreams, page redi::pstr...T, Traits >(3), and that's the vibe check, periodt 🎀🦋