Qx v0.5.7
Qt Extensions Library
Loading...
Searching...
No Matches
Qx::Base85ParseError Class Reference

The Base85ParseError class is used to report errors while parsing a Base85 encoded string. More...

#include <qx/core/qx-base85.h>

Public Types

enum  ParseError {
  NoError ,
  InvalidEncoding ,
  PaddingRequired ,
  NonANSI ,
  CharacterSetMismatch ,
  ShortcutMidFrame
}
 

Public Member Functions

 Base85ParseError ()
 
 Base85ParseError (ParseError error, qsizetype offset)
 
ParseError error () const
 
QString errorString () const
 
qsizetype offset () const
 

Detailed Description

See also
Base85, and Base85Encoding.

Member Enumeration Documentation

◆ ParseError

This enum describes the type of error that occurred during the parsing of a Base85 encoded string.

Enumerator
NoError 

No error occurred.

InvalidEncoding 

The provided encoding is invalid.

PaddingRequired 

The string makes use of padding, but the specified encoding does not support padding.

NonANSI 

The string contains characters that are wider than a single byte.

CharacterSetMismatch 

The string contains characters that are not present in the specified encoding's character set.

ShortcutMidFrame 

A shortcut character appears in the middle of one of the string's 5-character ASCII frames.

Constructor & Destructor Documentation

◆ Base85ParseError() [1/2]

Qx::Base85ParseError::Base85ParseError ( )

Constructs a parse error report set to ParseError::NoError.

◆ Base85ParseError() [2/2]

Qx::Base85ParseError::Base85ParseError ( ParseError error,
qsizetype offset )

Constructs a parse error report set to error, with offset offset.

Member Function Documentation

◆ error()

Base85ParseError::ParseError Qx::Base85ParseError::error ( ) const

Returns the type of parse error. Is equal to Base85ParseError::NoError if the string was parsed correctly.

See also
ParseError and errorString().

◆ errorString()

QString Qx::Base85ParseError::errorString ( ) const

Returns the human-readable message appropriate to the reported Base85 parsing error.

◆ offset()

qsizetype Qx::Base85ParseError::offset ( ) const

Returns the offset in the input string where the parse error occurred.


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