Idris2Doc : IO.Async.Console

IO.Async.Console

(source)

Definitions

record ConsoleOut : (0 _ : Type) -> Type
  Record representing a console with
standard output and error output

Totality: total
Visibility: public export
Constructor: 
MkConsoleOut : Async e [] () -> (ByteString -> Async e [] ()) -> (ByteString -> Async e [] ()) -> ConsoleOut e

Projections:
.close_ : ConsoleOut e -> Async e [] ()
.putBytes_ : ConsoleOut e -> ByteString -> Async e [] ()
.putErrBytes_ : ConsoleOut e -> ByteString -> Async e [] ()

Hint: 
Resource (Async e) (ConsoleOut e)
.close_ : ConsoleOut e -> Async e [] ()
Totality: total
Visibility: public export
close_ : ConsoleOut e -> Async e [] ()
Totality: total
Visibility: public export
.putBytes_ : ConsoleOut e -> ByteString -> Async e [] ()
Totality: total
Visibility: public export
putBytes_ : ConsoleOut e -> ByteString -> Async e [] ()
Totality: total
Visibility: public export
.putErrBytes_ : ConsoleOut e -> ByteString -> Async e [] ()
Totality: total
Visibility: public export
putErrBytes_ : ConsoleOut e -> ByteString -> Async e [] ()
Totality: total
Visibility: public export
console : {default 100 _ : Nat} -> (ByteString -> Async e [] ()) -> (ByteString -> Async e [] ()) -> Async e es (ConsoleOut e)
  Creates a console for writing messages and errors to.

To make this available to many fibers, this is run as a service
in the background using an internal buffer that can hold up to
`capacity` messages.

Visibility: export
stdOut : {default 100 _ : Nat} -> Async e es (ConsoleOut e)
  The default console, printing to standard out and standard err.

Note: Since many fibers might be writing to the console at the same
this uses a bounded channel with a buffer of the given
capacity internally.

Visibility: export
cputBytes : ConsoleOut e => ByteString -> Async e es ()
  Put a bytestring to the console's standard output.

Totality: total
Visibility: export
cputStr : ConsoleOut e => String -> Async e es ()
  Put a string to the console's standard output.

Totality: total
Visibility: export
cputStrLn : ConsoleOut e => String -> Async e es ()
  Put a string plus trailing line break
to the console's standard output.

Totality: total
Visibility: export
cprint : ConsoleOut e => Show a => a -> Async e es ()
  Print a value to the console's standard output.

Totality: total
Visibility: export
cprintLn : ConsoleOut e => Show a => a -> Async e es ()
  Print a value plus trailing lne break
to the console's standard output.

Totality: total
Visibility: export
cputErrBytes : ConsoleOut e => ByteString -> Async e es ()
  Put a bytestring to the console's error output.

Totality: total
Visibility: export
cputErr : ConsoleOut e => String -> Async e es ()
  Put a string to the console's error output.

Totality: total
Visibility: export
cputErrLn : ConsoleOut e => String -> Async e es ()
  Put a string plus trailing line break
to the console's error output.

Totality: total
Visibility: export
cprintErr : ConsoleOut e => Show a => a -> Async e es ()
  Print a value to the console's error output.

Totality: total
Visibility: export
cprintErrLn : ConsoleOut e => Show a => a -> Async e es ()
  Print a value plus trailing lne break
to the console's error output.

Totality: total
Visibility: export
consoleLogger : ConsoleOut e -> (LogLevel -> List String -> List String) -> Logger e
Totality: total
Visibility: export
basicConsoleLogger : ConsoleOut e -> Logger e
Totality: total
Visibility: export
colorConsoleLogger : ConsoleOut e -> Logger e
  A console logger with colored log level tags

Totality: total
Visibility: export
syslogLogger : ConsoleOut e -> Logger e
  A logger using syslog priority codes. This can be used with
systemd services.

Totality: total
Visibility: export