terminus-docs
0.3
API
Generated with
terminus-docs/terminus

terminus

package terminus

Members list

Packages

package terminus.effect

Type members

Classlikes

trait AlternateScreenMode

Attributes

Source
AlternateScreenMode.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
trait ApplicationMode

Attributes

Source
ApplicationMode.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
trait Color

Attributes

Source
Color.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
trait Cursor

Attributes

Source
Cursor.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
trait Display

Attributes

Source
Display.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
trait Erase

Attributes

Source
Erase.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
class JLineTerminal(terminal: Terminal) extends Terminal

Attributes

Companion
object
Source
JLineTerminal.scala
Supertypes
trait Terminal
trait Reader
trait RawMode[Terminal]
trait Erase
trait Display[Terminal]
trait Cursor
trait Writer
trait Effect
trait Color[Terminal]
class Object
trait Matchable
class Any
Show all
object JLineTerminal extends Color, Cursor, Display, Erase, AlternateScreenMode, ApplicationMode, RawMode, Reader, Writer

Attributes

Companion
class
Source
JLineTerminal.scala
Supertypes
trait Writer
trait Reader
trait RawMode
trait Erase
trait Display
trait Cursor
trait Color
class Object
trait Matchable
class Any
Show all
Self type
enum KeyCode

Attributes

Source
Prompt.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LinuxTermios extends Termios

The Scala Native implementation of termios.h assumes certain types are implemented as CLong. This is correct on macOS, but not on Linux. This alternative implementation works on Linux.

The Scala Native implementation of termios.h assumes certain types are implemented as CLong. This is correct on macOS, but not on Linux. This alternative implementation works on Linux.

Attributes

Source
LinuxTermios.scala
Supertypes
trait Termios
class Object
trait Matchable
class Any
Self type
object MacOsTermios extends Termios

macOS implementation of Termios, which just uses the Scala Native implementation

macOS implementation of Termios, which just uses the Scala Native implementation

Attributes

Source
MacOsTermios.scala
Supertypes
trait Termios
class Object
trait Matchable
class Any
Self type
object NativeTerminal extends Terminal, WithEffect[Terminal]

A Terminal implementation for Scala Native.

A Terminal implementation for Scala Native.

Attributes

Source
NativeTerminal.scala
Supertypes
trait Terminal
trait Reader
trait RawMode[Terminal]
trait Erase
trait Display[Terminal]
trait Cursor
trait Writer
trait Effect
trait Color[Terminal]
class Object
trait Matchable
class Any
Show all
Self type
trait RawMode

Attributes

Source
RawMode.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
trait Reader

Attributes

Source
Reader.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
final class StringBuilderTerminal() extends Color[StringBuilderTerminal], Cursor, Display[StringBuilderTerminal], Erase, Writer

Attributes

Companion
object
Source
StringBuilderTerminal.scala
Supertypes
trait Erase
trait Cursor
trait Writer
trait Effect
class Object
trait Matchable
class Any
Show all
object StringBuilderTerminal

Attributes

Companion
class
Source
StringBuilderTerminal.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait Terminal extends Color[Terminal], Cursor, Display[Terminal], Erase, AlternateScreenMode[Terminal], ApplicationMode[Terminal], RawMode[Terminal], Reader, Writer

Attributes

Companion
object
Source
Terminal.scala
Supertypes
trait Reader
trait RawMode[Terminal]
trait Erase
trait Display[Terminal]
trait Cursor
trait Writer
trait Effect
trait Color[Terminal]
class Object
trait Matchable
class Any
Show all
Known subtypes
object Terminal extends Color, Cursor, Display, Erase, AlternateScreenMode, ApplicationMode, RawMode, Reader, Writer

Attributes

Companion
trait
Source
Terminal.scala
Supertypes
trait Writer
trait Reader
trait RawMode
trait Erase
trait Display
trait Cursor
trait Color
class Object
trait Matchable
class Any
Show all
Self type
Terminal.type
trait Termios

An abstraction of the termios library that only exposes the functionality we need

An abstraction of the termios library that only exposes the functionality we need

Attributes

Source
Termios.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object LinuxTermios
object MacOsTermios
trait Writer

Interface for writing to a console.

Interface for writing to a console.

Attributes

Source
Writer.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object JLineTerminal
object Terminal
final class prompt

Attributes

Source
Prompt.scala
Supertypes
class Object
trait Matchable
class Any

Types

type Program[A] = Terminal ?=> A

Attributes

Source
Terminal.scala

Value members

Concrete methods

def clear(): () ?=> Unit

Attributes

Source
Prompt.scala
def loop(idx: Int): () ?=> Int

Attributes

Source
Prompt.scala
def prompt(): Unit

Attributes

Source
Prompt.scala
def read(): () ?=> KeyCode

Attributes

Source
Prompt.scala
def write(selected: Int): () ?=> Unit

Attributes

Source
Prompt.scala
def writeChoice(description: String, selected: Boolean): () ?=> Unit

Attributes

Source
Prompt.scala
Generated with