Libmagicxx v10.0.3
A modern C++23 wrapper for libmagic — the library that powers the Unix file command.
Loading...
Searching...
No Matches

Flag retrieval methods. More...

Collaboration diagram for Flag Management:

Functions

FlagsContainerT Recognition::Magic::MagicPrivate::GetFlags () const
 Get current flags (throwing version).
std::optional< FlagsContainerTRecognition::Magic::MagicPrivate::GetFlags (const std::nothrow_t &tag) const noexcept
 Get current flags (noexcept version).

Detailed Description

Flag retrieval methods.

Methods for querying current configuration flags.

Function Documentation

◆ GetFlags() [1/2]

FlagsContainerT Recognition::Magic::MagicPrivate::GetFlags ( ) const
inlinenodiscard

Get current flags (throwing version).

Retrieves the flags currently configured for this instance. Uses FlagsConverter to transform the internal bitmask to a container of individual Flags enum values.

Returns
Container of active Flags values.
Exceptions
MagicIsClosedIf instance is not open.
Implementation
return FlagsConverter(m_flags_mask); // Implicit conversion
static void ThrowExceptionOnFailure(ResultT result, ExceptionArgsT &&... args)
Centralized error handling template.
Definition magic.cpp:1866
FlagsMaskT m_flags_mask
Definition magic.cpp:1921
bool IsOpen() const noexcept
Check if instance is open.
Definition magic.cpp:1285
Converter between C++ flag types and libmagic flag values.
Definition magic.cpp:2105
See also
Magic::GetFlags()
SetFlags()
FlagsConverter

◆ GetFlags() [2/2]

std::optional< FlagsContainerT > Recognition::Magic::MagicPrivate::GetFlags ( const std::nothrow_t & tag) const
inlinenodiscardnoexcept

Get current flags (noexcept version).

Non-throwing variant that returns std::nullopt if the instance is not open.

Parameters
[in]tagPass std::nothrow to select this overload.
Returns
Container of active Flags values, or std::nullopt if closed.
See also
Magic::GetFlags(const std::nothrow_t&)
SetFlags()