Idris2Doc : IO.Async.Console

IO.Async.Console

(source)

Definitions

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

Totality: total
Visibility: public export
Constructor: 
MkConsoleOut : Asynce [] () -> (ByteString->Asynce [] ()) -> (ByteString->Asynce [] ()) ->ConsoleOute

Projections:
.close_ : ConsoleOute->Asynce [] ()
.putBytes_ : ConsoleOute->ByteString->Asynce [] ()
.putErrBytes_ : ConsoleOute->ByteString->Asynce [] ()

Hint: 
Resource (Asynce) (ConsoleOute)
.close_ : ConsoleOute->Asynce [] ()
Totality: total
Visibility: public export
close_ : ConsoleOute->Asynce [] ()
Totality: total
Visibility: public export
.putBytes_ : ConsoleOute->ByteString->Asynce [] ()
Totality: total
Visibility: public export
putBytes_ : ConsoleOute->ByteString->Asynce [] ()
Totality: total
Visibility: public export
.putErrBytes_ : ConsoleOute->ByteString->Asynce [] ()
Totality: total
Visibility: public export
putErrBytes_ : ConsoleOute->ByteString->Asynce [] ()
Totality: total
Visibility: public export
console : {default100_ : Nat} -> (ByteString->Asynce [] ()) -> (ByteString->Asynce [] ()) ->Asyncees (ConsoleOute)
  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 : {default100_ : Nat} ->Asyncees (ConsoleOute)
  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 : ConsoleOute=>ByteString->Asyncees ()
  Put a bytestring to the console's standard output.

Totality: total
Visibility: export
cputStr : ConsoleOute=>String->Asyncees ()
  Put a string to the console's standard output.

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

Totality: total
Visibility: export
cprint : ConsoleOute=>Showa=>a->Asyncees ()
  Print a value to the console's standard output.

Totality: total
Visibility: export
cprintLn : ConsoleOute=>Showa=>a->Asyncees ()
  Print a value plus trailing lne break
to the console's standard output.

Totality: total
Visibility: export
cputErrBytes : ConsoleOute=>ByteString->Asyncees ()
  Put a bytestring to the console's error output.

Totality: total
Visibility: export
cputErr : ConsoleOute=>String->Asyncees ()
  Put a string to the console's error output.

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

Totality: total
Visibility: export
cprintErr : ConsoleOute=>Showa=>a->Asyncees ()
  Print a value to the console's error output.

Totality: total
Visibility: export
cprintErrLn : ConsoleOute=>Showa=>a->Asyncees ()
  Print a value plus trailing lne break
to the console's error output.

Totality: total
Visibility: export
consoleLogger : ConsoleOute-> (LogLevel->ListString->ListString) ->Loggere
Totality: total
Visibility: export
basicConsoleLogger : ConsoleOute->Loggere
Totality: total
Visibility: export
colorConsoleLogger : ConsoleOute->Loggere
  A console logger with colored log level tags

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

Totality: total
Visibility: export