spells

Spells

trait Spells extends AnsiModule with AnyOpsModule with CalendarOpsModule with ClearPrintModule with ClipboardModule with CustomRenderingModule with DateOpsModule with DurationOpsModule with FunctionNOpsModule with HumanRenderingModule with MiscModule with SpellsConfigModule with StackTraceElementModule with StringOpsModule with StylePrintModule with ThrowableOpsModule with TraversableOpsModule with Tuple2OpsModule with XrayModule

The main spells module. Mix it into the highest level package object you can afford, in order to gain the most benefit from spells.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Spells
  2. XrayModule
  3. Tuple2OpsModule
  4. TraversableOpsModule
  5. ThrowableOpsModule
  6. StylePrintModule
  7. StringOpsModule
  8. StackTraceElementModule
  9. SpellsConfigModule
  10. LocationAwarePropertyModule
  11. LocationAwareConfigModule
  12. MiscModule
  13. HumanRenderingModule
  14. FunctionNOpsModule
  15. DurationOpsModule
  16. DateOpsModule
  17. CustomRenderingModule
  18. ClipboardModule
  19. ClearPrintModule
  20. CalendarOpsModule
  21. AnyOpsModule
  22. AnsiModule
  23. AnyRef
  24. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. implicit final class AnsiString extends AnyRef

    Provides the method in which converts Any to String in AnsiStyle.

  2. final class AnsiStyle extends AnyRef

    Encoding of AnsiStyles

  3. implicit final class AnsiStyleBuilder extends AnyRef

    Provides method toAnsiStyle which converts ansi codes to AnsiStyle.

  4. implicit final class AnyOpsFromSpells extends AnyRef

    Definition Classes
    AnyOpsModule
  5. final class AvailableWidthInCharacters extends AnyRef

    Definition Classes
    StringOpsModule
  6. implicit final class CalendarOpsFromSpells extends (CalendarOpsModule.this)#CustomRendering

    Definition Classes
    CalendarOpsModule
  7. trait CustomRendering extends AnyRef

    Definition Classes
    CustomRenderingModule
  8. implicit final class DateOpsFromSpells extends (DateOpsModule.this)#CustomRendering

    Definition Classes
    DateOpsModule
  9. implicit final class Description extends AnyRef

    A wrapper for Strings, provided so that it can be used as an implicit parameter, which Strings are not ideal for.

  10. implicit final class DurationOpsFromSpells extends (DurationOpsModule.this)#CustomRendering

    Definition Classes
    DurationOpsModule
  11. implicit final class Function0OpsFromSpells[R, F[_]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  12. implicit final class Function10OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, R, F[_, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  13. implicit final class Function11OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, R, F[_, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  14. implicit final class Function12OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  15. implicit final class Function13OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  16. implicit final class Function14OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  17. implicit final class Function15OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  18. implicit final class Function16OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  19. implicit final class Function17OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  20. implicit final class Function18OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  21. implicit final class Function19OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  22. implicit final class Function1OpsFromSpells[T1, R, F[_, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  23. implicit final class Function20OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  24. implicit final class Function21OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  25. implicit final class Function22OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22, R, F[_, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  26. implicit final class Function2OpsFromSpells[T1, T2, R, F[_, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  27. implicit final class Function3OpsFromSpells[T1, T2, T3, R, F[_, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  28. implicit final class Function4OpsFromSpells[T1, T2, T3, T4, R, F[_, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  29. implicit final class Function5OpsFromSpells[T1, T2, T3, T4, T5, R, F[_, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  30. implicit final class Function6OpsFromSpells[T1, T2, T3, T4, T5, T6, R, F[_, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  31. implicit final class Function7OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, R, F[_, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  32. implicit final class Function8OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, R, F[_, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  33. implicit final class Function9OpsFromSpells[T1, T2, T3, T4, T5, T6, T7, T8, T9, R, F[_, _, _, _, _, _, _, _, _, _]] extends (FunctionNOpsModule.this)#TypeTagBasedCustomRendering

    Definition Classes
    FunctionNOpsModule
  34. implicit final class IncreaseStackTraceDepthBy extends AnyRef

    A wrapper for Ints, provided so that it can be used as an implicit parameter, which Ints are not ideal for.

  35. abstract class LocationAwareProperty[T] extends AnyRef

    Definition Classes
    LocationAwarePropertyModule
  36. case class Rendering(value: Long) extends Product with Serializable

    Definition Classes
    HumanRenderingModule
  37. implicit final class StackTraceElementOpsFromSpells extends (StackTraceElementModule.this)#CustomRendering

    Definition Classes
    StackTraceElementModule
  38. implicit final class StringOpsFromSpells extends AnyRef

    Definition Classes
    StringOpsModule
  39. implicit final class ThrowableOpsFromSpells extends (ThrowableOpsModule.this)#CustomRendering

    Definition Classes
    ThrowableOpsModule
  40. abstract class TypeTagBasedCustomRendering extends (FunctionNOpsModule.this)#CustomRendering

    Definition Classes
    FunctionNOpsModule
  41. implicit final class XrayFromSpells[T] extends AnyRef

    Implicit conversion from T to XrayFromSpells, which contains methods like xray and xrayIf.

  42. final class XrayReport[+T] extends (XrayModule.this)#CustomRendering

    Instances of this class are created by methods like xray or xrayIf.

  43. implicit final class XrayWeakFromSpells[T] extends AnyRef

    Definition Classes
    XrayModule

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. object AnsiStyle

    Provides out-of-the-box AnsiStyles as well as a utility method to remove them.

  7. implicit final def ArrayOpsFromSpells[A, T[A] <: Array[A]](value: T[A])(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[T[A]], rendering: (A) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    TraversableOpsModule
  8. object ClearPrint

    Definition Classes
    ClearPrintModule
  9. object Clipboard

    Utility object, which provides an API to write and read from the operating systems' clipboard.

  10. implicit final def CollectionOpsFromSpells[A, T[A] <: Collection[A]](value: T[A])(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[T[A]], rendering: (A) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    TraversableOpsModule
  11. object CustomRendering

    Definition Classes
    CustomRenderingModule
  12. object DateOpsFromSpells

    Definition Classes
    DateOpsModule
  13. implicit final def JavaMapOpsFromSpells[Key, Value, T[Key, Value] <: Map[Key, Value]](value: T[Key, Value])(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[T[Key, Value]], rendering: (Entry[Key, Value]) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    TraversableOpsModule
  14. implicit final def MapEntryOpsFromSpells[Key, Value](entry: Entry[Key, Value])(implicit keyRendering: (Key) ⇒ CustomRendering = CustomRendering.Defaults.Any, valueRendering: (Value) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    Tuple2OpsModule
  15. implicit final def MapOpsFromSpells[Key, Value, T[Key, Value] <: Map[Key, Value]](value: T[Key, Value])(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[T[Key, Value]], rendering: ((Key, Value)) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    TraversableOpsModule
  16. object SpellsConfig

    Definition Classes
    SpellsConfigModule
  17. object StylePrint

    Definition Classes
    StylePrintModule
  18. implicit final def TraversableOpsFromSpells[A, T[A] <: Traversable[A]](value: T[A])(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[T[A]], rendering: (A) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    TraversableOpsModule
  19. implicit final def Tuple2OpsFromSpells[Key, Value](tuple: (Key, Value))(implicit keyRendering: (Key) ⇒ CustomRendering = CustomRendering.Defaults.Any, valueRendering: (Value) ⇒ CustomRendering = CustomRendering.Defaults.Any): CustomRendering

    Definition Classes
    Tuple2OpsModule
  20. object Xray

    Definition Classes
    XrayModule
  21. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  22. implicit final def availableWidthInCharactersBackToInt(availableWidthInCharacters: AvailableWidthInCharacters): Int

    Definition Classes
    StringOpsModule
  23. implicit final def byteToRendering(value: Byte): Rendering

    Definition Classes
    HumanRenderingModule
  24. final def clearPrint(input: Any = "")(implicit style: AnsiStyle = AnsiStyle.Reset): Unit

    Prints an object to out using its toString method, beginning at the first character in the current line of your terminal.

    Prints an object to out using its toString method, beginning at the first character in the current line of your terminal.

    input

    the object to print

    style

    custom AnsiStyle

    Definition Classes
    ClearPrintModule
  25. final def clearPrintln(input: Any = "")(implicit style: AnsiStyle = AnsiStyle.Reset): Unit

    Prints out an object to the default output, beginning at the first character in the current line of your terminal, followed by a newline character.

    Prints out an object to the default output, beginning at the first character in the current line of your terminal, followed by a newline character.

    input

    the object to print

    style

    custom AnsiStyle

    Definition Classes
    ClearPrintModule
  26. final def cleared(input: Any = "")(implicit style: AnsiStyle = AnsiStyle.Reset): String

    Moves the caret to the beginning of the line.

    Moves the caret to the beginning of the line.

    input

    the object to be moved to the beginning of the line

    style

    custom AnsiStyle

    returns

    the object, which when printing will begin at the first character in the current line of your terminal.

    Definition Classes
    ClearPrintModule
  27. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def currentLineStackTraceElement(implicit increaseStackTraceDepthBy: IncreaseStackTraceDepthBy = 0): StackTraceElement

    Creates an instance of StackTraceElement at current line.

    Creates an instance of StackTraceElement at current line.

    increaseStackTraceDepthBy

    adjust if you build a library around it and the line stopps matching

    returns

    an instance of StackTraceElement at current line.

    Definition Classes
    XrayModule
  29. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  30. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  31. final def erred(error: Any): String

    Styles Any in Red.

    Styles Any in Red.

    error

    which will be styled

    returns

    Definition Classes
    StylePrintModule
  32. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  34. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  35. implicit final def intToRendering(value: Int): Rendering

    Definition Classes
    HumanRenderingModule
  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  37. def loadSpellsConfig: Config

    Attributes
    protected
    Definition Classes
    LocationAwareConfigModule
  38. implicit final def longToRendering(value: Long): Rendering

    Definition Classes
    HumanRenderingModule
  39. final def measureExecutionTime[T](expression: ⇒ T): (T, scala.concurrent.duration.Duration)

    Measures the execution time of an expression.

    Measures the execution time of an expression.

    T

    the result type of the expression

    expression

    the expression to be measured

    returns

    a Tuple2 with the value of the expression and it's execution time

    Definition Classes
    MiscModule
  40. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  41. final def noop[T]: (T) ⇒ Unit

    This method is similar to the identity method from the Scala standard library, but this one does not return anything.

    This method is similar to the identity method from the Scala standard library, but this one does not return anything.

    T

    input type

    returns

    ()

    Definition Classes
    MiscModule
  42. final def notify(): Unit

    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  44. final def print(input: Any = "")(implicit style: AnsiStyle = AnsiStyle.Reset): Unit

    Prints an object to out using its toString method.

    Prints an object to out using its toString method.

    input

    the object to print; may be null

    style

    the style for the object to be printed in

    Definition Classes
    StylePrintModule
  45. final def printerr(error: Any): Unit

    Write to the err stream in AnsiStyle.Red.

    Write to the err stream in AnsiStyle.Red.

    error

    which will be written to the stream

    Definition Classes
    StylePrintModule
  46. final def println(input: Any = "")(implicit style: AnsiStyle = AnsiStyle.Reset): Unit

    Prints out an object to the default output, followed by a newline character.

    Prints out an object to the default output, followed by a newline character.

    input

    the object to print

    style

    the style for the object to be printed in

    Definition Classes
    StylePrintModule
  47. implicit final def shortToRendering(value: Short): Rendering

    Definition Classes
    HumanRenderingModule
  48. final lazy val spellsConfig: Config

    Definition Classes
    LocationAwareConfigModule
  49. final def styled(input: Any)(implicit style: AnsiStyle = AnsiStyle.Reset): String

    Styled an object in a given style.

    Styled an object in a given style. Involves deep (already existing styles will be preserved) styling.

    styled("green" + "yellow".yellow + "green")(Green) // yellow is preserved
    input

    the object to print

    style

    the style for the object to be printed in

    returns

    the styled object as String

    Definition Classes
    StylePrintModule
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  51. implicit final def toAvailableWidthInCharacters(value: Int): AvailableWidthInCharacters

    A wrapper for Ints, provided so that it can be used as an implicit parameter, which Ints are not ideal for.

    A wrapper for Ints, provided so that it can be used as an implicit parameter, which Ints are not ideal for.

    value

    the Int to be wrapped.

    Definition Classes
    StringOpsModule
  52. def toString(): String

    Definition Classes
    AnyRef → Any
  53. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def xrayed[T](expression: ⇒ T, description: Description = Xray.Defaults.Description, increaseStackTraceDepthBy: Int = 0)(implicit typeTag: scala.reflect.api.JavaUniverse.TypeTag[T], style: AnsiStyle = AnsiStyle.Reset, rendering: (T) ⇒ CustomRendering = CustomRendering.Defaults.Any): XrayReport[T]

    Creates an instance of XrayReport.

    Creates an instance of XrayReport. Primarily useful for library authors.

    T

    the type, your expression evaluates to

    expression

    the expression to be evaluated

    description

    an optional description

    increaseStackTraceDepthBy

    the depth can be used in certain cases when you want to write your own library and have issues with line numberes jumping around

    typeTag

    the typeTag injected by the compiler

    style

    outer style for the report

    rendering

    custom rendering for T

    returns

    an instance of XrayReport, which can be rendered or written to a database etc etc

    Definition Classes
    XrayModule
  57. final def xrayedWeak[T](expression: ⇒ T, description: Description = Xray.Defaults.Description, increaseStackTraceDepthBy: Int = 0)(implicit style: AnsiStyle = AnsiStyle.Reset): XrayReport[T]

    Creates an instance of XrayReport.

    Creates an instance of XrayReport. Primarily useful for library authors.

    T

    the type, your expression evaluates to

    expression

    the expression to be evaluated

    description

    an optional description

    increaseStackTraceDepthBy

    the depth can be used in certain cases when you want to write your own library and have issues with line numberes jumping around

    style

    outer style for the report

    returns

    an instance of XrayReport, which can be rendered or written to a database etc etc

    Definition Classes
    XrayModule

Inherited from XrayModule

Inherited from Tuple2OpsModule

Inherited from TraversableOpsModule

Inherited from ThrowableOpsModule

Inherited from StylePrintModule

Inherited from StringOpsModule

Inherited from StackTraceElementModule

Inherited from SpellsConfigModule

Inherited from LocationAwarePropertyModule

Inherited from LocationAwareConfigModule

Inherited from MiscModule

Inherited from HumanRenderingModule

Inherited from FunctionNOpsModule

Inherited from DurationOpsModule

Inherited from DateOpsModule

Inherited from CustomRenderingModule

Inherited from ClipboardModule

Inherited from ClearPrintModule

Inherited from CalendarOpsModule

Inherited from AnyOpsModule

Inherited from AnsiModule

Inherited from AnyRef

Inherited from Any

Ungrouped