StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Exception Class Reference

Base exception for the Multimedia module. More...

#include <StormByte/multimedia/exception.hxx>

Inheritance diagram for StormByte::Multimedia::Exception:
Collaboration diagram for StormByte::Multimedia::Exception:

Classes

struct  Path
 Additional path segments nested below StormByte.Multimedia. More...

Public Member Functions

template<typename... Args>
requires (sizeof...(Args) >= 1)
 Exception (std::string_view pattern, Args &&... args)
 Replace literal {} under StormByte.Multimedia.
 Exception (std::string_view message)
 Copy a borrowed plain message under StormByte.Multimedia.
template<typename... Args>
requires (sizeof...(Args) >= 1)
 Exception (Path path, std::string_view pattern, Args &&... args)
 Replace literal {} under an additional Multimedia path.
 Exception (Path path, std::string_view message)
 Copy a borrowed plain message under an additional Multimedia path.
 Exception (const Exception &other)
 Copy constructor.
 Exception (Exception &&other) noexcept
 Move constructor.
 ~Exception () noexcept override
 Destructor.
Exception & operator= (const Exception &other)
 Copy assignment.
Exception & operator= (Exception &&other) noexcept
 Move assignment.
Public Member Functions inherited from StormByte::Exception
 Exception (std::string_view message)
 Exception (const Exception &other)
 Exception (Exception &&other) noexcept
Exception & operator= (const Exception &other)
Exception & operator= (Exception &&other) noexcept
virtual const char * what () const noexcept

Additional Inherited Members

Protected Member Functions inherited from StormByte::Exception
 Exception () noexcept
 Exception (Path path, std::string_view message)
 Exception (Path path, Safe::String &&message)
 Exception (Path path, std::string_view pattern, Args &&... args)

Detailed Description

Base exception for the Multimedia module.

what() is StormByte.Multimedia: message.

This type applies the Multimedia segment. A further segment is an Path (File, Codec, Plan, AV.Decoder). The body does not include the path. Literal {} are replaced by StormByte::Safe::String::ReplaceToken. A specifier such as {:.3f} is not a token. A number uses std::to_string. The destructor is defined in this module.

Note
Base automatically recognizes complete exception derivatives as MaybeSafe. This hierarchy keeps copy/move operations and destruction in the multimedia provider and messages in Base-owned storage. Compatible compiler, standard-library ABI and provider layout are required; Base and multimedia providers must remain loaded while exceptions are alive.

Constructor & Destructor Documentation

◆ Exception() [1/6]

template<typename... Args>
requires (sizeof...(Args) >= 1)
StormByte::Multimedia::Exception::Exception ( std::string_view pattern,
Args &&... args )
inlineexplicit

Replace literal {} under StormByte.Multimedia.

Template Parameters
ArgsViews, numbers, or types that convert to std::string. A number uses std::to_string.
Parameters
patternBody with literal {} tokens.
argsReplacements. One per token, in order.

◆ Exception() [2/6]

StormByte::Multimedia::Exception::Exception ( std::string_view message)
explicit

Copy a borrowed plain message under StormByte.Multimedia.

Parameters
messageException text. Copied during the call and never retained.

◆ Exception() [3/6]

template<typename... Args>
requires (sizeof...(Args) >= 1)
StormByte::Multimedia::Exception::Exception ( Path path,
std::string_view pattern,
Args &&... args )
inlineexplicit

Replace literal {} under an additional Multimedia path.

Template Parameters
ArgsViews, numbers, or types that convert to std::string. A number uses std::to_string.
Parameters
pathAdditional segments nested below StormByte.Multimedia.
patternBody with literal {} tokens.
argsReplacements. One per token, in order.

◆ Exception() [4/6]

StormByte::Multimedia::Exception::Exception ( Path path,
std::string_view message )
explicit

Copy a borrowed plain message under an additional Multimedia path.

Parameters
pathAdditional segments nested below StormByte.Multimedia.
messageException text. Not a format string.

◆ Exception() [5/6]

StormByte::Multimedia::Exception::Exception ( const Exception & other)

Copy constructor.

Parameters
otherException to copy.

◆ Exception() [6/6]

StormByte::Multimedia::Exception::Exception ( Exception && other)
noexcept

Move constructor.

Parameters
otherException to take.

◆ ~Exception()

StormByte::Multimedia::Exception::~Exception ( )
overridevirtualnoexcept

Destructor.

Defined in the Multimedia library to anchor RTTI.

Reimplemented from StormByte::Exception.

Reimplemented in StormByte::Multimedia::FFmpeg::Exception.

Member Function Documentation

◆ operator=() [1/2]

Exception & StormByte::Multimedia::Exception::operator= ( const Exception & other)

Copy assignment.

Parameters
otherException to copy.
Returns
*this.

◆ operator=() [2/2]

Exception & StormByte::Multimedia::Exception::operator= ( Exception && other)
noexcept

Move assignment.

Parameters
otherException to take.
Returns
*this.

The documentation for this class was generated from the following file: