REDI_BASIC_RPSTREAM(3)

💖 NAME 💖

okay so bestie, welcome to redi::basic_rpstream — the Class template for Restricted PStreams. she's the whole reason you're here, and she's iconic for it 💅

---

✨ SYNOPSIS ✨

#include <pstream.h>

so like, before anything else, she inherits from a whole friend group of base classes, no cap:

• std::basic_ostream< CharT, std::char_traits< CharT > >
• std::basic_istream< CharT, std::char_traits< CharT > >
• redi::pstream_common< CharT, Traits >
• redi::pstreams

🌸 Public Types 🌸

• typedef pbase_type::pmode pmode — the type you use to say how you wanna connect to the process 🫶
• typedef pbase_type::argv_type argv_type — the type that holds all the arguments for a command, like her little to-do list 📝
• typedef int fd_type — the type used for file descriptors, literally just int, slay

💅 Public Member Functions 💅

• basic_rpstream () — default constructor, makes an uninitialised stream (she's not ready yet, give her a sec 🙈)
• basic_rpstream (const std::string &cmd, pmode mode=pstdout|pstdin) — constructor that initialises the stream by starting a process
• basic_rpstream (const std::string &file, const argv_type &argv, pmode mode=pstdout|pstdin) — constructor that initialises the stream by starting a process
• basic_rpstream (const argv_type &argv, pmode mode=pstdout|pstdin) — constructor that initialises the stream by starting a process
• ~basic_rpstream () — destructor, she's leaving the group chat 💀
• void open (const std::string &cmd, pmode mode=pstdout|pstdin) — start a process
• void open (const std::string &file, const argv_type &argv, pmode mode=pstdout|pstdin) — start a process
• istream_type & out () — get a reference to the istream that reads the process' stdout 👀
• istream_type & err () — get a reference to the istream that reads the process' stderr 😭

⭐ 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 🧚

• enum { bufsz = 32, pbsz = 2 }

---

👑 Detailed Description 👑

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

Class template for Restricted PStreams.

ok so here's the tea ☕️ — writing to an rpstream that was opened with pmode pstdin writes to the standard input of the command. periodt.

but listen: it is not possible to read directly from an rpstream object. to use an rpstream as an istream you must call either basic_rpstream::out() or basic_rpstream::err(). and why, you ask? because the class is literally protecting you from yourself — it's to prevent accidental reads from the wrong input source. she's a bodyguard, honestly 🫶

if the rpstream was not opened with pmode pstderr then the class cannot read the process' stderr, and basic_rpstream::err() will return an istream that reads from the process' stdout. and vice versa, bestie, vice versa.

reading from an rpstream opened with pmode pstdout and/or pstderr reads the command's standard output and/or standard error. any of the process' stdin, stdout or stderr that is not connected to the pstream (as specified by the pmode) will be the same as the process that created the pstream object — unless altered by the command itself. iykyk.

---

🎀 Member Enumeration Documentation 🎀

anonymous enum [protected], [inherited]

enumerators, bestie:

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

---

🌈 Constructor & Destructor Documentation 🌈

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_rpstream< CharT, Traits >::basic_rpstream (const std::string & cmd, pmode mode = pstdout|pstdin) [inline], [explicit]

constructor that initialises the stream by starting a process ✨

she initialises the stream buffer by calling do_open() with the supplied arguments. so organised.

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)

---

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_rpstream< CharT, Traits >::basic_rpstream (const std::string & file, const argv_type & argv, pmode mode = pstdout|pstdin) [inline]

constructor that initialises the stream by starting a process ✨

she initialises the stream buffer by calling do_open() with the supplied arguments. again. consistent queen.

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)

---

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_rpstream< CharT, Traits >::basic_rpstream (const argv_type & argv, pmode mode = pstdout|pstdin) [inline], [explicit]

constructor that initialises the stream by starting a process ✨

she initialises the stream buffer by calling do_open(argv[0],argv,mode). yes, argv[0], that's the whole trick 🦋

Parameters

• 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)

---

💜 Member Function Documentation 💜

template<typename CharT, typename Traits = std::char_traits<CharT>> istream_type & redi::basic_rpstream< CharT, Traits >::err () [inline]

obtain a reference to the istream that reads the process' stderr 👀

Returns

• *this

---

template<typename CharT, typename Traits = std::char_traits<CharT>> void redi::basic_rpstream< CharT, Traits >::open (const std::string & cmd, pmode mode = pstdout|pstdin) [inline]

start a process. calls do_open( cmd , 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)

---

template<typename CharT, typename Traits = std::char_traits<CharT>> void redi::basic_rpstream< CharT, Traits >::open (const std::string & file, const argv_type & argv, pmode mode = pstdout|pstdin) [inline]

start a process. calls 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)

---

template<typename CharT, typename Traits = std::char_traits<CharT>> istream_type & redi::basic_rpstream< CharT, Traits >::out () [inline]

obtain a reference to the istream that reads the process' stdout 👀

Returns

• *this

---

🫶 Author 🫶

generated automatically by Doxygen for PStreams from the source code. she didn't write herself, she was born that way 💅

---

and that's the whole page, bestie!! this was redi::basic_rpstream(3) from PStreams — the manual name is right there in the title so you always know which page you're on, and the footer was just the same title with PStreams as the source and no date attached (doxygen left the date blank, so we move 🎀). mwah, go read the source, ily 💖✨