# DocumentError enum

Enumerates possible error codes.

Inheritance
  - Object
  - Enum
  - DocumentError

## Constructors

DocumentError()
  const

## Values

success → const DocumentError

  No error.

insufficientBuffer → const DocumentError

  The given buffer is too small.

objectDoesNotExist → const DocumentError

  The requested object does not exist; a 'null' should be returned if possible.

base → const DocumentError

  Base error code of the Document module.

minimum → const DocumentError

  Minimum error code of the Document module.

invalidHandle → const DocumentError

  The handle is invalid.

invalidParameter → const DocumentError

  The parameter is invalid.

invalidPixelFormat → const DocumentError

  The image pixel format is invalid.

invalidModelPath → const DocumentError

  The model could not be found in the given directory path.

invalidDocumentTemplatePath → const DocumentError

  The document template could not be found at the given path.

unloadedModel → const DocumentError

  The model which is required for this operation has not been loaded.

unloadedDocumentTemplate → const DocumentError

  The document template required for this operation has not been loaded.

unknownAnnotation → const DocumentError

  The required element is not present in the document annotation.

invalidDocumentTemplateFormat → const DocumentError

  The format of the document template is invalid.

insufficientFrameNumber → const DocumentError

  The frame buffer is not full, and computation is not allowed.

backendError → const DocumentError

  One of our computation backends failed for unknown reasons.

inferenceBackendError → const DocumentError

  The inference backend failed to infer, probably due to inconsistent input.

processingUnitUnavailable → const DocumentError

  The requested processing unit is not available in this build.

functionNotImplemented → const DocumentError

  This function is not implemented.

## Properties

hashCode → int
  The hash code for this object.
  no setter inherited
index → int
  A numeric identifier for the enumerated value.
  no setter inherited
runtimeType → Type
  A representation of the runtime type of the object.
  no setter inherited

## Methods

noSuchMethod(Invocation invocation) → dynamic
  Invoked when a nonexistent method or property is accessed.
  inherited
toString() → String
  A string representation of this object.
  inherited

## Operators

operator ==(Object other) → bool
  The equality operator.
  inherited

## Constants

values → const List<DocumentError>
  A constant List of the values in this enum, in order of their declaration.
  `[success, insufficientBuffer, objectDoesNotExist, base, minimum, invalidHandle, invalidParameter, invalidPixelFormat, invalidModelPath, invalidDocumentTemplatePath, unloadedModel, unloadedDocumentTemp…`