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

The EncodeError class is used to report errors during image encoding. More...

#include <>>

Collaboration diagram for PxCrypt::EncodeError:
[legend]

Public Types

enum  Type {
  NoError = 0 ,
  MissingPayload = 1 ,
  InvalidImage = 2 ,
  WontFit = 3 ,
  InvalidBpc = 4
}
 

Public Member Functions

 EncodeError ()
 
QString errorString () const
 
bool isValid () const
 
Type type () const
 

Friends

class Encoder
 

Detailed Description

See also
Encoder and DecodeError.

Member Enumeration Documentation

◆ Type

enum PxCrypt::EncodeError::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.

Constructor & Destructor Documentation

◆ EncodeError()

PxCrypt::EncodeError::EncodeError ( )

Constructs an invalid encoder error.

See also
isValid().

Member Function Documentation

◆ errorString()

QString PxCrypt::EncodeError::errorString ( ) const

Returns the string representation of the error.

See also
type().

◆ isValid()

bool PxCrypt::EncodeError::isValid ( ) const

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

See also
Type.

◆ type()

EncodeError::Type PxCrypt::EncodeError::type ( ) const

Returns the type of encoding error.

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