Packages

final case class ImplementMe(msg: String = "")(implicit loggingContext: ErrorLoggingContext) extends Impl with TopologyManagerError with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ImplementMe
  2. Serializable
  3. Product
  4. Equals
  5. TopologyManagerError
  6. Impl
  7. CantonError
  8. BaseCantonError
  9. BaseError
  10. LocationMixin
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ImplementMe(msg: String = "")(implicit loggingContext: ErrorLoggingContext)

Value Members

  1. def asGoogleGrpcStatus(implicit loggingContext: ErrorLoggingContext): Status
    Definition Classes
    BaseCantonError
  2. def asGrpcError: StatusRuntimeException
    Definition Classes
    CantonError
  3. def asGrpcError(implicit loggingContext: ErrorLoggingContext): StatusRuntimeException
    Definition Classes
    BaseCantonError
  4. val cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    ImplBaseError
  5. implicit val code: ErrorCode

    The error code, usually passed in as implicit where the error class is defined

    The error code, usually passed in as implicit where the error class is defined

    Definition Classes
    ImplBaseError
  6. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    BaseCantonErrorBaseError
  7. def definiteAnswerO: Option[Boolean]

    Controls whether a definite_answer error detail is added to the gRPC status code

    Controls whether a definite_answer error detail is added to the gRPC status code

    Definition Classes
    BaseError
  8. val location: Option[String]

    Contains the location where the error has been created.

    Contains the location where the error has been created.

    Definition Classes
    LocationMixin
  9. def log(): Unit
    Definition Classes
    CantonError
  10. def log()(implicit loggingContext: ErrorLoggingContext): Unit
    Definition Classes
    BaseCantonError
  11. def logOnCreation: Boolean

    Flag to control if an error should be logged at creation

    Flag to control if an error should be logged at creation

    Generally, we do want to log upon creation, except in the case of "nested" or combined errors, where we just nest the error but don't want it to be logged twice. See com.digitalasset.canton.error.ParentCantonError as an example.

    Definition Classes
    CantonError
  12. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  13. implicit val loggingContext: ErrorLoggingContext

    The logging context obtained when we created the error, usually passed in as implicit via com.digitalasset.canton.logging.NamedLogging

    The logging context obtained when we created the error, usually passed in as implicit via com.digitalasset.canton.logging.NamedLogging

    Definition Classes
    ImplementMeCantonError
  14. val msg: String
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. def resources: Seq[(ErrorResource, String)]

    The resources related to this error

    The resources related to this error

    We return the set of resources via com.google.rpc.ResourceInfo. Override this method in order to return resource information via com.google.rpc.Status

    Definition Classes
    BaseError
  17. def retryable: Option[ErrorCategoryRetry]

    Returns retryability information of this particular error

    Returns retryability information of this particular error

    In some cases, error instances would like to provide custom retry intervals. This can be achieved by locally overriding this method.

    Do not use this to change the contract of the error categories. Non-retryable errors shouldn't be made retryable. Only use it for adjusting the retry intervals.

    Definition Classes
    BaseError
  18. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  19. def rpcStatusWithoutLoggingContext(): Status
    Definition Classes
    BaseCantonError
  20. val throwableO: Option[Throwable]

    An optional argument to log exceptions

    An optional argument to log exceptions

    If you want to log an exception as part of your error, then use the following example:

    object MyCode extends ErrorCode(id="SUPER_DUPER_ERROR") { case class MyError(someString: String, throwable: Throwable) extends SomeInternalError( cause = "Something failed with an exception bla", throwableO = Some(throwable) ) }

    NOTE: This throwable's details are not included the exception communicated to the gRPC clients so if you want them communicated, you need to explicitly add them to the e.g. context map or cause string.

    Definition Classes
    ImplBaseError