目录

类

class Console

public class Console

功能：此类提供标准输入、标准输出和标准错误流的获取接口。

[h2]static prop stdErr

public static prop stdErr: ConsoleWriter

功能：该成员属性为 ConsoleWriter 类型，它提供标准错误的获取功能。

类型：ConsoleWriter

[h2]static prop stdIn

public static prop stdIn: ConsoleReader

功能：该成员属性为 ConsoleReader 类型，它提供标准输入的获取功能。

类型：ConsoleReader

[h2]static prop stdOut

public static prop stdOut: ConsoleWriter

功能：该成员属性为 ConsoleWriter 类型，它提供标准输出的获取功能。

类型：ConsoleWriter

class ConsoleReader

public class ConsoleReader <: InputStream

功能：提供从控制台读出数据并转换成字符或字符串的功能。

该类型无法构造实例，只能通过 Console.stdIn 获取实例。

读操作是同步的，内部设有缓存区来保存控制台输入的内容，当到达控制台输入流的结尾时，控制台读取函数将返回None。

ConsoleReader 只有一个实例，所有方法共享同一个缓存区，相关read方法返回None的情形有：

  • 将标准输入重定向到文件时，读取到文件结尾EOF。
  • Linux 环境，按下 Ctrl+D。
  • Windows 环境，按下 Ctrl+Z 后加回车。

ConsoleReader 只支持 UTF-8 编码，Windows 环境需手动执行 chcp 65001（将 Windows 终端的编码更改为 UTF-8 ），当系统编码和 API 所需编码不一致时，可能产生乱码，从而导致读取 Rune 时发生异常，抛出 IllegalArgumentException。

[h2]func read()

public func read(): ?Rune

功能：从标准输入中读取下一个字符。

返回值：

异常：

[h2]func read(Array<Byte>)

public func read(arr: Array<Byte>): Int64

功能：从标准输入中读取并放入 arr 中。

该函数存在风险，可能读取出来的结果恰好把 UTF-8 code point 从中截断，如果发生截断，将导致该 Array<Byte> 转换成字符串的结果不正确或抛出异常。

参数：

返回值：

[h2]func readToEnd()

public func readToEnd(): ?String

功能：从标准输入中读取所有字符。

直到读取到文件结束符EOF，或者在 Linux 上键入 Ctrl+D 或在 Windows 上键入 Ctrl+Z + 回车结束。读取到字符，返回 ?String，否则返回 None。读取失败时会返回 None，该接口不会抛出异常，即使输入不符合 UTF-8 编码的字符串，也会构造出一个 String 并返回，其行为等同于 String.fromUtf8Uncheck(Array<Byte>)。

返回值：

[h2]func readUntil((Rune) -> Bool)

public func readUntil(predicate: (Rune) -> Bool): ?String

功能：从标准输入中读取数据直到读取到的字符满足predicate条件结束。

满足 predicate: (Rune) -> Bool 条件的字符包含在结果中，读取失败时会返回None。

参数：

返回值：

[h2]func readUntil(Rune)

public func readUntil(ch: Rune): ?String

功能：从标准输入中读取数据直到读取到字符 ch 结束。

ch包含在结果中，如果读取到文件结束符 EOF，将返回读取到的所有信息，读取失败时会返回 None。

返回值：

[h2]func readln()

public func readln(): ?String

功能：从标准输入中读取一行字符串。

读取到字符，返回 ?String，结果不包含末尾换行符。该接口不会抛出异常，即使输入不符合UTF-8编码的字符串，也会构造出一个 String 并返回，其行为等同于 String.fromUtf8Uncheck(Array<Byte>)。

返回值：

class ConsoleWriter

public class ConsoleWriter <: OutputStream

功能：此类提供保证线程安全的标准输出功能。

每次 write 调用写到控制台的结果是完整的，不同的 write 函数调用的结果不会混合到一起。

该类型无法构造实例，只能通过 Console.stdOut 获取标准输出实例或者 Console.stdErr 获取标准错误的实例。

[h2]func flush()

public func flush(): Unit

功能：刷新输出流。

[h2]func write(Array<Byte>)

public func write(buffer: Array<Byte>): Unit

功能：指定的将字节数组 buffer 写入标准输出或标准错误流中。

参数：

[h2]func write(Bool)

public func write(value: Bool): Unit

功能：将指定的布尔值的文本表示形式写入标准输出或标准错误流中。

参数：

[h2]func write(Float16)

public func write(value: Float16): Unit

功能：将指定的 16 位浮点数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Float32)

public func write(value: Float32): Unit

功能：将指定的 32 位浮点数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Float64)

public func write(value: Float64): Unit

功能：将指定的 64 位浮点数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Int16)

public func write(value: Int16): Unit

功能：将指定的 16 位有符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Int32)

public func write(value: Int32): Unit

功能：将指定的 32 位有符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Int64)

public func write(value: Int64): Unit

功能：将指定的 64 位有符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Int8)

public func write(value: Int8): Unit

功能：将指定的 8 位有符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(Rune)

public func write(value: Rune): Unit

功能：将指定的 Rune 的 Unicode 字符值写入标准输出或标准错误流中。

参数：

[h2]func write(String)

public func write(value: String): Unit

功能：将指定的字符串值写入标准输出或标准错误流中。

参数：

[h2]func write(UInt16)

public func write(value: UInt16): Unit

功能：将指定的 16 位无符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(UInt32)

public func write(value: UInt32): Unit

功能：将指定的 32 位无符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(UInt64)

public func write(value: UInt64): Unit

功能：将指定的 64 位无符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write(UInt8)

public func write(value: UInt8): Unit

功能：将指定的 8 位无符号整数值的文本表示写入标准输出或标准错误流中。

参数：

[h2]func write<T>(T): Unit where T <: ToString

public func write<T>(value: T): Unit where T <: ToString

功能：将实现了 ToString 接口的数据类型写入标准输出或标准错误流中。

参数：

[h2]func writeln(Array<Byte>)

public func writeln(buffer: Array<Byte>): Unit

功能：指定的将字节数组 buffer （后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Bool)

public func writeln(value: Bool): Unit

功能：将指定的布尔值的文本表示形式（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Float16)

public func writeln(value: Float16): Unit

功能：将指定的 16 位浮点数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Float32)

public func writeln(value: Float32): Unit

功能：将指定的 32 位浮点数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Float64)

public func writeln(value: Float64): Unit

功能：将指定的 64 位浮点数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Int16)

public func writeln(value: Int16): Unit

功能：将指定的 16 位有符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Int32)

public func writeln(value: Int32): Unit

功能：将指定的 32 位有符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Int64)

public func writeln(value: Int64): Unit

功能：将指定的 64 位有符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Int8)

public func writeln(value: Int8): Unit

功能：将指定的 8 位有符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(Rune)

public func writeln(value: Rune): Unit

功能：将指定的 Unicode 字符值（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(String)

public func writeln(value: String): Unit

功能：将指定的字符串值（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(UInt16)

public func writeln(value: UInt16): Unit

功能：将指定的 16 位无符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(UInt32)

public func writeln(value: UInt32): Unit

功能：将指定的 32 位无符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(UInt64)

public func writeln(value: UInt64): Unit

功能：将指定的 64 位无符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln(UInt8)

public func writeln(value: UInt8): Unit

功能：将指定的 8 位无符号整数值的文本表示（后跟换行符）写入标准输出或标准错误流中。

参数：

[h2]func writeln<T>(T): Unit where T <: ToString

public func writeln<T>(value: T): Unit where T <: ToString

功能：将实现了 ToString 接口的数据类型转换成的字符串（后跟换行符）写入标准输出或标准错误流中。

参数：