std::experi...em::is_fifo(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸ’… std::experi...em::is_fifo(3) πŸ’…

okay so bestie, welcome to the C++ Standard Libary manual β€” yes, that's literally how the manual name is spelled here, and no, we are not fixing it. This page is all about std::experimental::filesystem::is_fifo, and it's giving "tiny little check, very important vibes." 🫢


✨ NAME ✨

std::experimental::filesystem::is_fifo β€” and yep, the name again for good measure: std::experimental::filesystem::is_fifo. πŸ’–


🌸 Synopsis 🌸

Defined in header <experimental/filesystem>
bool is_fifo( file_status s );                 (1) (filesystem TS)
bool is_fifo( const path& p );                 (2) (filesystem TS)
bool is_fifo( const path& p, error_code& ec ); (3) (filesystem TS)

So like, this whole thing checks if the given file status or path corresponds to a FIFO or pipe file. That's the whole assignment. πŸ’…

  1. Equivalent to s.type() == file_type::fifo.
  2. Equivalent to is_fifo(status(p)).
  3. Equivalent to is_fifo(status(p, ec)). Returns false and sets ec to an appropriate error code if an error occurs. Otherwise, ec is cleared with a call to ec.clear().

πŸŽ€ Parameters πŸŽ€

  • s β€” file status to check
  • p β€” path to query
  • ec β€” error code to modify in case of errors

⭐ Return value ⭐

Returns true if the given path or file status corresponds to a FIFO file. Iconic. βœ…


πŸ”₯ Exceptions πŸ”₯

  • 1,3) β€” noexcept specification: noexcept
  • 2) β€” Throws filesystem_error if an error occurs. The exception object is constructed with p as an argument.

πŸ‘€ See also πŸ‘€

This section is incomplete. 😭 not me leaving a section literally incomplete, but that is what the page says, bestie.


🏷️ Categories 🏷️

  • Noindexed pages
  • unconditionally noexcept
  • Todo without reason

πŸ™ˆ Hidden categories πŸ™ˆ

  • Pages with unreviewed unconditional noexcept template
  • Pages with unreviewed noexcept template

mwah πŸ’‹ β€” this little page came from http://cppreference.com, version 2024.06.10. Signed, sealed, and slayed. πŸ¦‹βœ¨

πŸ“¦ where this page comes from