Packages

t

com.digitalasset.canton.console

InstanceReferenceWithPublicApi

trait InstanceReferenceWithPublicApi extends InstanceReference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InstanceReferenceWithPublicApi
  2. InstanceReference
  3. CertificateAdministration
  4. PrettyPrinting
  5. PrettyUtil
  6. ShowUtil
  7. ShowSyntax
  8. ToShowOps
  9. FeatureFlagFilter
  10. NoTracing
  11. NamedLogging
  12. Helpful
  13. AdminCommandRunner
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  3. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  4. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  5. implicit class ShowStringSyntax extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil
  6. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil

Abstract Value Members

  1. abstract def adminCommand[Svc <: AbstractStub[Svc], Result](command: AdminCommand[Svc, _, _, Result]): ConsoleCommandResult[Result]

    Run an admin command and return its result.

    Run an admin command and return its result.

    Attributes
    protected[console]
    Definition Classes
    AdminCommandRunner
  2. abstract def certificatesPath: String
  3. abstract def config: NodeConfig
    Definition Classes
    InstanceReference
  4. abstract def connection: String
  5. abstract val consoleEnvironment: ConsoleEnvironment
  6. abstract def health: HealthAdministration[_ <: Status]
    Definition Classes
    InstanceReference
  7. abstract def identity: IdentityAdministrationGroup
    Definition Classes
    InstanceReference
  8. abstract val instanceType: String
    Attributes
    protected
    Definition Classes
    InstanceReference
  9. abstract def keys: KeyAdministrationGroup
    Definition Classes
    InstanceReference
  10. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  11. abstract val name: String
    Definition Classes
    InstanceReference
  12. abstract def parties: PartiesAdministrationGroup
    Definition Classes
    InstanceReference

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  5. def adminCommand[Svc <: AbstractStub[Svc], Result](commandGenerator: (CryptoPureApi) => AdminCommand[Svc, _, _, Result]): ConsoleCommandResult[Result]

    Generate a command for a potentially running instance then run it and return its result.

    Generate a command for a potentially running instance then run it and return its result.

    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  8. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  9. def clear_cache(): Unit
    Definition Classes
    InstanceReference
    Annotations
    @Summary(s = "Clear locally cached variables", flag = FeatureFlag.Testing) @Description(s = "Some commands cache values on the client side. Use this command to explicitly clear the caches of these values.")
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. val cryptoPureApi: CryptoPureApi
    Attributes
    protected
    Definition Classes
    InstanceReference
  12. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    InstanceReference → AnyRef → Any
  17. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  18. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  27. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  28. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  29. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  30. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  31. def pretty: Pretty[InstanceReference]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    InstanceReferencePrettyPrinting
  32. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  33. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  34. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  35. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  36. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  37. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  38. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  39. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  42. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  43. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  44. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  45. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  46. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  47. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from InstanceReference

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from FeatureFlagFilter

Inherited from NoTracing

Inherited from NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped