Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

​
DA.Exception

Exception handling in Daml. DEPRECATED: Use failWithStatus and FailureStatus over Daml Exceptions

​
Module Snapshot

Lifecycle

Deprecated.

Notices

Status: active Introduced in: 3.4.9 Removed in: - Warnings: 0 Deprecations: 2 Deprecated since: 3.4.9
Exceptions are deprecated, prefer failWithStatus, and avoid using catch.
  • Exceptions are deprecated, prefer failWithStatus, and avoid using catch.
  • Use -Wno-deprecated-exceptions to disable this warning.

​
Data Types

​
type Exception = (HasThrow e, HasMessage e, HasToAnyException e, HasFromAnyException e)

Exception typeclass. This should not be implemented directly, instead, use the exception syntax.

​
Typeclasses

​
class HasThrow e

Part of the Exception constraint. Methods:
  • throwPure : e -> t Throw exception in a pure context.
Instances:
  • instance HasThrow ArithmeticError
  • instance HasThrow AssertionFailed
  • instance HasThrow GeneralError
  • instance HasThrow PreconditionFailed

​
class HasMessage e

Part of the Exception constraint. Methods:
  • message : e -> Text Get the error message associated with an exception.
Instances:
  • instance HasMessage AnyException
  • instance HasMessage ArithmeticError
  • instance HasMessage AssertionFailed
  • instance HasMessage GeneralError
  • instance HasMessage PreconditionFailed

​
class HasToAnyException e

Part of the Exception constraint. Methods:
  • toAnyException : e -> AnyException Convert an exception type to AnyException.
Instances:
  • instance HasToAnyException AnyException
  • instance HasToAnyException ArithmeticError
  • instance HasToAnyException AssertionFailed
  • instance HasToAnyException GeneralError
  • instance HasToAnyException PreconditionFailed

​
class HasFromAnyException e

Part of the Exception constraint. Methods:
  • fromAnyException : AnyException -> Optional e Convert an AnyException back to the underlying exception type, if possible.
Instances:
  • instance HasFromAnyException AnyException
  • instance HasFromAnyException ArithmeticError
  • instance HasFromAnyException AssertionFailed
  • instance HasFromAnyException GeneralError
  • instance HasFromAnyException PreconditionFailed

​
class Action m => ActionThrow m

Action type in which throw is supported. Methods:
  • throw : Exception e => e -> m t
Instances:
  • instance ActionThrow Update

​
class ActionThrow m => ActionCatch m

Action type in which try ... catch ... is supported. DEPRECATED: Avoid the use of catch in daml code, prefer error handling on client, and throwing using failWithStatus Methods:
  • _tryCatch : (() -> m t) -> (AnyException -> Optional (m t)) -> m t Handle an exception. Use the try ... catch ... syntax instead of calling this method directly.
Instances:
  • instance ActionCatch Update

​
Orphan Typeclass Instances

  • instance GetField message GeneralError Text
  • instance SetField message GeneralError Text
  • instance GetField message ArithmeticError Text
  • instance SetField message ArithmeticError Text
  • instance GetField message PreconditionFailed Text
  • instance SetField message PreconditionFailed Text
  • instance GetField message AssertionFailed Text
  • instance SetField message AssertionFailed Text