Constructors

Magic construction methods. More...

Collaboration diagram for Constructors:

Functions
	Recognition::Magic::Magic () noexcept
	Default constructor. Creates an unopened Magic instance.
	Recognition::Magic::Magic (FlagsMaskT flags_mask, const std::filesystem::path &database_file=DEFAULT_DATABASE_FILE)
	Construct and initialize Magic with flags and database.
	Recognition::Magic::Magic (FlagsMaskT flags_mask, const std::nothrow_t &tag, const std::filesystem::path &database_file=DEFAULT_DATABASE_FILE) noexcept
	Construct and initialize Magic with flags and database (noexcept version).
	Recognition::Magic::Magic (const FlagsContainerT &flags_container, const std::filesystem::path &database_file=DEFAULT_DATABASE_FILE)
	Construct and initialize Magic with a container of flags.
	Recognition::Magic::Magic (const FlagsContainerT &flags_container, const std::nothrow_t &tag, const std::filesystem::path &database_file=DEFAULT_DATABASE_FILE) noexcept
	Construct and initialize Magic with a container of flags (noexcept version).

Detailed Description

Magic construction methods.

Constructors for creating Magic instances in various initial states.

Function Documentation

Magic() [1/5]

Recognition::Magic::Magic ( )

noexcept

Default constructor. Creates an unopened Magic instance.

The instance is not valid for file identification until Open() and LoadDatabaseFile() are called.

Magic magic;  // Not yet valid
magic.Open(Magic::Flags::Mime);
magic.LoadDatabaseFile();
// Now valid for identification

See also

Open()

LoadDatabaseFile()

IsValid()

Since

10.0.0

Magic() [2/5]

Recognition::Magic::Magic ( const FlagsContainerT & flags_container, const std::filesystem::path & database_file = DEFAULT_DATABASE_FILE )

explicit

Construct and initialize Magic with a container of flags.

Alternative constructor accepting a container of individual flags instead of a bitmask. Useful when flags are determined at runtime.

Parameters

[in]	flags_container	Vector or other container of Flags values.
[in]	database_file	Path to magic database file (default: DEFAULT_DATABASE_FILE).

Exceptions

MagicOpenError	If opening the Magic instance fails.
EmptyPath	If database_file path is empty.
PathDoesNotExist	If database_file does not exist.
PathIsNotRegularFile	If database_file is not a regular file.
MagicLoadDatabaseFileError	If loading the database fails.

std::vector<Magic::Flags> flags = {Magic::Flags::Mime, Magic::Flags::Compress};
Magic magic{flags};

Note

The ".mgc" extension is automatically appended to the database path if needed.

See also

FlagsContainerT

Since

10.0.0

Magic() [3/5]

Recognition::Magic::Magic ( const FlagsContainerT & flags_container, const std::nothrow_t & tag, const std::filesystem::path & database_file = DEFAULT_DATABASE_FILE )

noexcept

Construct and initialize Magic with a container of flags (noexcept version).

Non-throwing variant that silently fails if initialization errors occur. Check IsValid() after construction to verify success.

Parameters

[in]	flags_container	Vector or other container of Flags values.
[in]	tag	Pass std::nothrow to select this overload.
[in]	database_file	Path to magic database file (default: DEFAULT_DATABASE_FILE).

Note

The ".mgc" extension is automatically appended to the database path if needed.

See also

IsValid()

Since

10.0.0

Magic() [4/5]

Recognition::Magic::Magic ( FlagsMaskT flags_mask, const std::filesystem::path & database_file = DEFAULT_DATABASE_FILE )

explicit

Construct and initialize Magic with flags and database.

This constructor opens Magic with the specified flags and loads the magic database file in a single step. On success, the instance is immediately ready for file identification.

Parameters

[in]	flags_mask	Configuration flags (use Flags enum values combined with |).
[in]	database_file	Path to magic database file (default: DEFAULT_DATABASE_FILE).

Exceptions

MagicOpenError	If opening the Magic instance fails.
EmptyPath	If database_file path is empty.
PathDoesNotExist	If database_file does not exist.
PathIsNotRegularFile	If database_file is not a regular file.
MagicLoadDatabaseFileError	If loading the database fails.

// Use MIME output with default database
Magic magic1{Magic::Flags::Mime};
 
// Combine flags
Magic magic2{Magic::Flags::Mime | Magic::Flags::Compress};
 
// Custom database path
Magic magic3{Magic::Flags::Mime, "/custom/path/magic"};

Note

The ".mgc" extension is automatically appended to the database path if needed.

See also

LoadDatabaseFile()

Since

10.0.0

Magic() [5/5]

Recognition::Magic::Magic ( FlagsMaskT flags_mask, const std::nothrow_t & tag, const std::filesystem::path & database_file = DEFAULT_DATABASE_FILE )

noexcept

Construct and initialize Magic with flags and database (noexcept version).

Non-throwing variant that silently fails if initialization errors occur. Check IsValid() after construction to verify success.

Parameters

[in]	flags_mask	Configuration flags (use Flags enum values combined with |).
[in]	tag	Pass std::nothrow to select this overload.
[in]	database_file	Path to magic database file (default: DEFAULT_DATABASE_FILE).

Magic magic{Magic::Flags::Mime, std::nothrow};
if (magic.IsValid()) {
    // Safe to use
}

Note

The ".mgc" extension is automatically appended to the database path if needed.

See also

IsValid()

Since

10.0.0