PxCrypt v0.2.2
Encrypt data within an image
Loading...
Searching...
No Matches
PxCrypt::StandardDecoder::Error Class Referencefinal

The StandardDecoder::Error class is used to report errors during image decoding. More...

#include <>>

Inherits Qx::AbstractError< "PxCrypt::StandardDecoder::Error", 6878 >.

Public Types

enum  Type {
  NoError ,
  InvalidSource ,
  MissingMedium ,
  DimensionMismatch ,
  NotLargeEnough ,
  InvalidMeta ,
  SkimFailed
}
 

Public Member Functions

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

Detailed Description

Member Enumeration Documentation

◆ Type

This enum specifies the type of encoding error that occurred.

Enumerator
NoError 

No error occurred.

InvalidSource 

The encoded image was invalid.

MissingMedium 

The encoded image required a medium to be decoded but none was provided.

DimensionMismatch 

The required medium image had different dimensions than the encoded image.

NotLargeEnough 

The provided image was not large enough to be an encoded image.

InvalidMeta 

The provided image was not encoded.

SkimFailed 

An unexpected error occurred while skimming data from the image.

Constructor & Destructor Documentation

◆ Error()

PxCrypt::StandardDecoder::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::StandardDecoder::Error::errorString ( ) const

Returns the string representation of the error.

See also
type().

◆ isValid()

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

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

See also
Type.

◆ specific()

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

Returns instance specific error information, if any.

See also
errorString().

◆ type()

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

Returns the type of decoding error.

See also
errorString().

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