Packages

case class Plugin(name: String, sha256: String, command: String, builtin: Boolean = false, args: Array[String] = Array.empty, env: Array[String] = Array.empty) extends Product with Serializable

name

the name is what is used to look up plugins in the catalog.

sha256

the SHA256 sum of the plugin's binary. Before a plugin is run it's SHA will be checked against this value, if they do not match the plugin can not be run.

command

the command used to execute the plugin. This is relative to the plugin directory. e.g. "myplugin".

args

the arguments used to execute the plugin. If the arguments are provided here, the command parameter should only contain the named program. e.g. "--my_flag=1".

env

the environment variables used during the execution of the plugin. Each entry is of the form "key=value". e.g "FOO=BAR".

Source
Plugin.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Plugin
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Plugin(name: String, sha256: String, command: String, builtin: Boolean = false, args: Array[String] = Array.empty, env: Array[String] = Array.empty)

    name

    the name is what is used to look up plugins in the catalog.

    sha256

    the SHA256 sum of the plugin's binary. Before a plugin is run it's SHA will be checked against this value, if they do not match the plugin can not be run.

    command

    the command used to execute the plugin. This is relative to the plugin directory. e.g. "myplugin".

    args

    the arguments used to execute the plugin. If the arguments are provided here, the command parameter should only contain the named program. e.g. "--my_flag=1".

    env

    the environment variables used during the execution of the plugin. Each entry is of the form "key=value". e.g "FOO=BAR".

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Plugin, B)
    Implicit
    This member is added by an implicit conversion from Plugin toArrowAssoc[Plugin] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val args: Array[String]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val builtin: Boolean
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val command: String
  10. def ensuring(cond: (Plugin) => Boolean, msg: => Any): Plugin
    Implicit
    This member is added by an implicit conversion from Plugin toEnsuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Plugin) => Boolean): Plugin
    Implicit
    This member is added by an implicit conversion from Plugin toEnsuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): Plugin
    Implicit
    This member is added by an implicit conversion from Plugin toEnsuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Plugin
    Implicit
    This member is added by an implicit conversion from Plugin toEnsuring[Plugin] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. val env: Array[String]
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Plugin toStringFormat[Plugin] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val name: String
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val sha256: String
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (Plugin, B)
    Implicit
    This member is added by an implicit conversion from Plugin toArrowAssoc[Plugin] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromPlugin to StringFormat[Plugin]

Inherited by implicit conversion Ensuring fromPlugin to Ensuring[Plugin]

Inherited by implicit conversion ArrowAssoc fromPlugin to ArrowAssoc[Plugin]

Ungrouped