PxCrypt v0.2.2
Encrypt data within an image
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
PxCrypt::StandardEncoder::Error Class Referencefinal

The StandardEncoder::Error class is used to report errors during single image encoding. More...

#include <>>

Inherits Qx::AbstractError< "PxCrypt::StandardEncoder::Error", 6978 >.

Public Types

enum  Type {
  NoError ,
  MissingPayload ,
  InvalidImage ,
  WontFit ,
  InvalidBpc ,
  WeaveFailed
}
 

Public Member Functions

 Error (Type t=NoError, const QString &s={})
 
QString errorString () const
 
bool isValid () const
 
QString specific () const
 
Type type () const
 

Detailed Description

See also
StandardEncoder and StandardDecoder::Error.

Member Enumeration Documentation

◆ Type

enum PxCrypt::StandardEncoder::Error::Type

This enum specifies the type of encoding error that occurred.

Enumerator
NoError 

No error occurred.

MissingPayload 

No payload data was provided.

InvalidImage 

The medium was invalid.

WontFit 

The medium's dimensions were not large enough to fit the payload.

InvalidBpc 

The BPC value was not between 1 and 7.

WeaveFailed 

An unexpected error occurred while weaving data into the medium.

Constructor & Destructor Documentation

◆ Error()

PxCrypt::StandardEncoder::Error::Error ( Type t = NoError,
const QString & s = {} )

Constructs an error of type t, with specific information s.

See also
isValid().

Member Function Documentation

◆ errorString()

QString PxCrypt::StandardEncoder::Error::errorString ( ) const

Returns the string representation of the error.

See also
type().

◆ isValid()

bool PxCrypt::StandardEncoder::Error::isValid ( ) const

Returns true if the error's type is one other than NoError; otherwise, returns false.

See also
Type.

◆ specific()

QString PxCrypt::StandardEncoder::Error::specific ( ) const

Returns instance specific error information, if any.

See also
errorString().

◆ type()

StandardEncoder::Error::Type PxCrypt::StandardEncoder::Error::type ( ) const

Returns the type of encoding error.

See also
errorString().
The documentation for this class was generated from the following files: