PLCnext API Documentation 25.0.2.69
EndOfStreamException.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Core/PimplPtr.hxx"
9#include "Arp/Base/Commons/Exceptions/Io/IoException.hpp"
10
11namespace Arp::Base::Commons::Exceptions::Io
12{
13
15class ARP_BASE_COMMONS_EXPORT EndOfStreamException : public IoException
16{
17public: // Impl forward declaration
18 class Impl;
19
20public: // construction/destruction/assignment
21 template<typename... Args>
22 explicit EndOfStreamException(const char* message, const Args& ... args);
24 EndOfStreamException(const String& message);
25 EndOfStreamException(String&& message, const Exception& innerException);
26 EndOfStreamException(const String& message, const Exception& innerException);
27
32 ~EndOfStreamException(void)override;
33
34protected: // construction
35 EndOfStreamException(ExceptionTypeId typeId, String&& message, StackCounter stackCounter);
36
37public: // static factory operations
38 static EndOfStreamException Create(const String& message);
39
40public: // internal operations
41 Impl& GetImpl(void);
42 const Impl& GetImpl(void)const;
43
44protected: // overridden operations
45 Exception::Ptr Clone(void)const override;
46
47private: // Impl usings
49
50private: // Impl fields
51 Pimpl pimpl;
52};
53
55// inline methods of class EndOfStreamException
56
63template<typename... Args>
64inline EndOfStreamException::EndOfStreamException(const char* message, const Args& ... args)
65 : EndOfStreamException(ExceptionTypeId::IoEndOfStream, String::Format(message, args...), StackCounter())
66{
67}
68
69} // end of namespace Arp::Base::Commons::Exceptions::Io
70
71namespace Arp {
72// Import exception into Arp namespace as Arp::System::Commons library does
74} // end of namespace Arp
76// template specialization of ArgumentException formatter
77template<> struct fmt::formatter<Arp::Base::Commons::Exceptions::Io::EndOfStreamException> : public fmt::ostream_formatter
78{
79};
80
This exception is thrown when the end of stream is reached duing a stream read operation.
Definition: EndOfStreamException.hpp:16
EndOfStreamException & operator=(const EndOfStreamException &arg)
Default copy-assignment operator.
EndOfStreamException(const char *message, const Args &... args)
Creates an EndOfStreamException with message.
Definition: EndOfStreamException.hpp:64
EndOfStreamException & operator=(EndOfStreamException &&arg) noexcept
Default move-assignment operator.
EndOfStreamException(const EndOfStreamException &arg)
Default copy constructor.
~EndOfStreamException(void) override
Default destructor.
EndOfStreamException(EndOfStreamException &&arg) noexcept
Default move constructor.
This exception is thrown when an unspecified IO error occurs.
Definition: IoException.hpp:17
This class is used to count sequenced operation calls, which are e.g. invoked during an exception thr...
Definition: StackCounter.hpp:20
This is the base class of all Arp exception classes.
Definition: Exception.hpp:21
std::unique_ptr< Exception > Ptr
The smart pointer type of this class.
Definition: Exception.hpp:27
Adapter class to implement PImpl idiom.
Definition: PimplPtr.hxx:15
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
@ Create
Creates a new file. If the file already exists, it is overwritten.
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:15
Root namespace for the PLCnext API