streams

nimony/lib/std/streams.nim

• type Stream = ref StreamObj

  All procedures of this module use this type. Procedures don't directly use StreamObj.

• type StreamObj = object
    closeImpl: proc (s: ref StreamObj) {.nimcall, raises: ErrorCode, tags: [WriteIOEffect].}
    atEndImpl: proc (s: ref StreamObj): bool {.nimcall, raises: ErrorCode, tags: [].}
    setPositionImpl: proc (s: ref StreamObj, pos: int64) {.nimcall, raises: ErrorCode, tags: [].}
    getPositionImpl: proc (s: ref StreamObj): int64 {.nimcall, raises: ErrorCode, tags: [].}
    readDataStrImpl: proc (s: ref StreamObj, buffer: var string, slice: HSlice): int64 {.nimcall, raises: ErrorCode, tags: [ReadIOEffect].}
    readLineImpl: proc (s: ref StreamObj, line: var string): bool {.nimcall, raises: ErrorCode, tags: [ReadIOEffect].}
    readDataImpl: proc (s: ref StreamObj, buffer: pointer, bufLen: int64): int64 {.nimcall, raises: ErrorCode, tags: [ReadIOEffect].}
    peekDataImpl: proc (s: ref StreamObj, buffer: pointer, bufLen: int64): int64 {.nimcall, raises: ErrorCode, tags: [ReadIOEffect].}
    writeDataImpl: proc (s: ref StreamObj, buffer: pointer, bufLen: int64) {.nimcall, raises: ErrorCode, tags: [WriteIOEffect].}
    flushImpl: proc (s: ref StreamObj) {.nimcall, raises: ErrorCode, tags: [WriteIOEffect].}

• proc flush(s: ref StreamObj)

  Flushes the buffers that the stream s might use.

• proc close(s: ref StreamObj)

  Closes the stream s.

• proc atEnd(s: ref StreamObj): bool

  Checks if more data can be read from s. Returns true if all data has been read.

• proc setPosition(s: ref StreamObj; pos: int64)

  Sets the position pos of the stream s.

• proc getPosition(s: ref StreamObj): int64

  Retrieves the current position in the stream s.

• proc readData(s: ref StreamObj; buffer: pointer; bufLen: int64): int64

  Low level proc that reads data into an untyped buffer of bufLen size.

• proc readDataStr(s: ref StreamObj; buffer: var string; slice: HSlice): int64

  Low level proc that reads data into a string buffer at slice.

• proc readAll(s: ref StreamObj): string

  Reads all available data.

• proc peekData(s: ref StreamObj; buffer: pointer; bufLen: int64): int64

  Low level proc that reads data into an untyped buffer of bufLen size without moving stream position.

• proc writeData(s: ref StreamObj; buffer: pointer; bufLen: int64)

  Low level proc that writes an untyped buffer of bufLen size to the stream s.

• proc write(s: ref StreamObj; x: T)

  Generic write procedure. Writes x to the stream s.

• proc write(s: ref StreamObj; x: string)

  Writes the string x to the stream s. No length field or terminating zero is written.

• proc writeLine(s: ref StreamObj; x: string)

  Writes a string followed by a newline to the stream s.

• proc read(s: ref StreamObj; result: var T)

  Generic read procedure. Reads result from the stream s.

• proc peek(s: ref StreamObj; result: var T)

  Generic peek procedure. Peeks result from the stream s.

• proc readChar(s: ref StreamObj): char

  Reads a char from the stream s. Returns '\0' as an EOF marker.

• proc peekChar(s: ref StreamObj): char

  Peeks a char from the stream s. Returns '\0' as an EOF marker.

• proc readBool(s: ref StreamObj): bool

  Reads a bool from the stream s.

• proc peekBool(s: ref StreamObj): bool

  Peeks a bool from the stream s.

• proc readInt8(s: ref StreamObj): int8

  Reads an int8 from the stream s.

• proc peekInt8(s: ref StreamObj): int8

  Peeks an int8 from the stream s.

• proc readInt16(s: ref StreamObj): int16

  Reads an int16 from the stream s.

• proc peekInt16(s: ref StreamObj): int16

  Peeks an int16 from the stream s.

• proc readInt32(s: ref StreamObj): int32

  Reads an int32 from the stream s.

• proc peekInt32(s: ref StreamObj): int32

  Peeks an int32 from the stream s.

• proc readInt64(s: ref StreamObj): int64

  Reads an int64 from the stream s.

• proc peekInt64(s: ref StreamObj): int64

  Peeks an int64 from the stream s.

• proc readUint8(s: ref StreamObj): uint8

  Reads a uint8 from the stream s.

• proc peekUint8(s: ref StreamObj): uint8

  Peeks a uint8 from the stream s.

• proc readUint16(s: ref StreamObj): uint16

  Reads a uint16 from the stream s.

• proc peekUint16(s: ref StreamObj): uint16

  Peeks a uint16 from the stream s.

• proc readUint32(s: ref StreamObj): uint32

  Reads a uint32 from the stream s.

• proc peekUint32(s: ref StreamObj): uint32

  Peeks a uint32 from the stream s.

• proc readUint64(s: ref StreamObj): uint64

  Reads a uint64 from the stream s.

• proc peekUint64(s: ref StreamObj): uint64

  Peeks a uint64 from the stream s.

• proc readFloat32(s: ref StreamObj): float32

  Reads a float32 from the stream s.

• proc peekFloat32(s: ref StreamObj): float32

  Peeks a float32 from the stream s.

• proc readFloat64(s: ref StreamObj): float64

  Reads a float64 from the stream s.

• proc peekFloat64(s: ref StreamObj): float64

  Peeks a float64 from the stream s.

• proc readStr(s: ref StreamObj; length: int64; str: var string)

  Reads a string of length length from the stream s.

• proc readStr(s: ref StreamObj; length: int64): string

  Reads a string of length length from the stream s.

• proc peekStr(s: ref StreamObj; length: int64; str: var string)

  Peeks a string of length length from the stream s.

• proc peekStr(s: ref StreamObj; length: int64): string

  Peeks a string of length length from the stream s.

• proc readLine(s: ref StreamObj; line: var string): bool

  Reads a line of text from the stream s into line. A line of text may be delimited by LF or CRLF. The newline character(s) are not part of the returned string. Returns false if the end of the file has been reached, true otherwise.

• proc peekLine(s: ref StreamObj; line: var string): bool

  Peeks a line of text from the stream s into line.

• proc readLine(s: ref StreamObj): string

  Reads a line from a stream s.

• proc peekLine(s: ref StreamObj): string

  Peeks a line from a stream s.

• iterator lines(s: ref StreamObj): string

  Iterates over every line in the stream.

• type StringStream = ref StringStreamObj

  A stream that encapsulates a string.

• type StringStreamObj = object
    data: string
    pos: int64

• proc newStringStream(s: string): ref StringStreamObj

  Creates a new stream from the string s.

• type FileStream = ref FileStreamObj

  A stream that encapsulates a File.

• type FileStreamObj = object
    f: ref FileObj

• proc newFileStream(f: ref FileObj): ref FileStreamObj

  Creates a new stream from the file f.

• proc newFileStream(filename: string; mode: FileMode; bufSize: int64): ref FileStreamObj

  Creates a new stream from the file named filename with the mode mode. If the file cannot be opened, nil is returned.

• proc openFileStream(filename: string; mode: FileMode; bufSize: int64): ref FileStreamObj

  Creates a new stream from the file named filename with the mode mode. If the file cannot be opened, an IO error is raised.