`lib-io` 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793554370/FIN+5.3.1+lib-io 中文整理基于 FIN 5.3.1

导读： 输入/输出函数库

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读）

lib
meta
docs
funcs
Overview
IO Handles
- FTP Handles
Examples
- def
ioAppend(handle)
- supertypes
ioCharset(handle, charset)
ioCopy(from, to, opts: {})
ioCrc(handle, algorithm)
ioCreate(handle)
ioDelete(handle)
ioDigest(handle, algorithm)
ioDir(handle)
ioEachCsv(handle, opts, fn)
ioEachLine(handle, fn)
ioExport(req, handle)
ioFromBase64(s)
ioGzip(handle)
ioHmac(handle, algorithm, key)
ioInfo(handle)
ioMove(from, to)
ioPbk(algorithm, password, salt, iterations, keyLen)
ioRandom(size)
ioReadCsv(handle, opts: null)
ioReadJson(handle, opts: null)
ioReadJsonGrid(handle, opts: null)
ioReadLines(handle, opts: null)
ioReadStr(handle)
ioReadTrio(handle)
ioReadXeto(handle, opts: null)
ioReadZinc(handle)
ioSkip(handle, opts)
ioStreamCsv(handle, opts: null)
ioStreamLines(handle)
ioToBase64(handle, opts: null)
ioToHex(handle)
ioWriteCsv(val, handle, opts: null)
ioWriteExcel(val, handle)
ioWriteHtml(val, handle, opts: {})
ioWriteJson(val, handle, opts: null)
ioWriteJsonLd(val, handle)
ioWriteLines(lines, handle)
ioWritePdf(val, handle, opts: {})
ioWriteStr(str, handle)
ioWriteSvg(val, handle, opts: {})
ioWriteTrio(val, handle, opts: null)
ioWriteTurtle(val, handle)
ioWriteXeto(val, handle, opts: null)
ioWriteXml(val, handle)
ioWriteZinc(val, handle)
ioZipDir(handle)
ioZipEntry(handle, path)

概述（中译）

输入/输出函数库

API 正文（英文）

docs

Overview • IO Handles • Examples

funcs


ioAppend	Convert a handle to append mode
ioCharset	Configure an I/O handle to use the specified charset
ioCopy	Copy a file or directory to the new specified location
ioCrc	Generate a cycle reduancy check code as a Number
ioCreate	Create a directory or empty file with the given I/O handle
ioDelete	Delete a file or a directory as mapped by the given I/O handle
ioDigest	Generate a one-way hash of the given I/O handle
ioDir	Read a directory listing, return a grid with cols
ioEachCsv	Iterate the rows of a CSV file (comma separated values) and callback the given function with two parameters
ioEachLine	For each line of the given source stream call the given function with two parameters
ioExport	Export a view to the given file handle - see Export
ioFromBase64	Return an I/O handle to decode from a base64 string
ioGzip	Wrap an I/O handle to GZIP compress/uncompress
ioHmac	Generate an HMAC message authentication as specified by RFC 2104
ioInfo	Get information about a file handle and return a Dict with the same tags as `ioDir()`
ioMove	Move or rename a file or directory
ioPbk	Generate a password based cryptographic key
ioRandom	Generate randomized series of bytes which can be used as an input I/O handle
ioReadCsv	Read a CSV (comma separated values) file into memory as a Grid
ioReadJson	Read a JSON file into memory
ioReadJsonGrid	Read a JSON file formatted as a standardized Haystack grid into memory
ioReadLines	Read an I/O handle into memory as a list of string lines
ioReadStr	Read an I/O handle into memory as a string
ioReadTrio	Read a Trio file into memory as a list of Dicts
ioReadXeto	Read a Xeto data file into memory as a Haystack data type
ioReadZinc	Read a Zinc file into memory as a Haystack data type
ioSkip	Apply a skipping operation to an input I/O handle
ioStreamCsv	Read a stream of dicts from a comma separated value file
ioStreamLines	Read a stream of lines
ioToBase64	Encode an I/O handle into a base64 string
ioToHex	Encode an I/O handle into hexidecimal string
ioWriteCsv	Write a grid to a CSV (comma separated values) file
ioWriteExcel	Write an Excel XLS file, where `val` may be
ioWriteHtml	Write an Axon data structure to HTML
ioWriteJson	Write an Axon data structure to JSON
ioWriteJsonLd	Write an Axon data structure to RDF JSON-LD format
ioWriteLines	Write a list of string lines separated with "\n" character
ioWritePdf	Render data to a PDF file
ioWriteStr	Write a string to an I/O handle
ioWriteSvg	Render data to an SVG file
ioWriteTrio	Write dicts to a Trio file
ioWriteTurtle	Write an Axon data structure to RDF Turtle format
ioWriteXeto	Write value to a Xeto text format file
ioWriteXml	Write a grid to an XML file
ioWriteZinc	Write a Grid to the Zinc format
ioZipDir	Read a zip file's entry listing, return a grid with cols
ioZipEntry	Return a I/O handle which may be used to read from a zip entry within a zip file

lib io

Overview

The ioExt is used to read/write data via a variety of formats:

Text strings: ioReadStr(), ioWriteStr()
Text lines: ioReadLines(), ioWriteLines()
Zinc: ioReadZinc(), ioWriteZinc()
Trio: ioReadTrio(), ioWriteTrio()
CSV: ioReadCsv(), ioWriteCsv(), ioEachCsv(), ioStreamCsv()
JSON: ioReadJson(), ioWriteJson()
XML: ioWriteXml(), xmlRead()
PDF: ioWritePdf()
SVG: ioWriteSvg()
HTML: ioWriteHtml()
RDF: ioWriteTurtle(), ioWriteJsonLd()

IO Handles

All the read/write functions take an IO handle which is one of the following:

any string can be used by the the read functions; if used for a write function then the output is concatenated to the end of the string and returned as the result of the write function
Uri which starts with "io/" which read/writes relative to the project's io directory
Uri with fan:// scheme will read files bundled in pods
Uri with http:// or https:// scheme will read using HTTP GET request (readonly)
Uri with ftp:// or ftps:// scheme will retreive using FTP
any Dict can be used as an IOHandle. Data will be stored in Folio keyed off the id of the rec. The data will be removed when the rec is deleted from folio.

The default charset used by all I/O handles is "UTF-8". You can wrap any of the handles above with the ioCharset() function to specify an alternate charset.

FTP Handles

You may read and write files to a FTP server via a ftp:// or ftps:// Uri. Using ioDir() is supported if Uri ends with a slash, but returns name only (not dir, size, or mod). By default the "anonymous" user account is used. But you can customize this by creating a key/value the password manager where the key is the base URI and the value is a string formatted as "user:pass". For example given:

uri:  ftp://somehost/somefile.csv
user: bob
pass: secret

You can setup the password for all FTP request to "ftp://somehost/" like this:

passwordSet("ftp://somehost/", "bob:secret")

Note that the URI key must end with a slash and match the scheme (ftp or ftps).

In newer versions of Java, you may see the following warning in the console the first time an FTPS connection is made:

WARNING: An illegal reflective access operation has occurred
WARNING: Illegal reflective access by fan.ftp.FtpClientPeer (file:) to field sun.security.ssl.SSLSessionContextImpl.sessionHostPortCache
WARNING: Please consider reporting this to the maintainers of fan.ftp.FtpClientPeer
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
WARNING: All illegal access operations will be denied in a future release

If you see this, then you need to edit your etc/sys/config.props and add the following options to the java.options along with any other options you have set (e.g. heap configuration).

java.options=--add-opens java.base/sun.security.ssl=ALL-UNNAMED --add-opens java.base/sun.security.util=ALL-UNNAMED

Examples

Here are some basic examples:

// export your sites to a trio file: {proj}/io/sites.trio
readAll(site).ioWriteTrio(`io/sites.trio`)

// export your sites to a trio string literal
readAll(site).ioWriteTrio("")

// export point to CSV file
read(weatherTemp).hisRead(pastMonth).ioWriteCsv(`io/point.csv`)

// import history data from CSV file where timestamps
// are formatted as 2010-10-02T13:00
ioReadCsv(`io/his.csv`)
  .map(row => {ts: parseDateTime(row->ts, "YYYY-MM-DD'T'hh:mm", "New_York"),
               val: parseNumber(row->val)})
  .hisWrite(hisId)

// parse an oBIX XML document and map into name/value pairs
xmlRead(`http://obix.acme.com/obix/about`).xmlElems
  .map(x => {name:x.xmlAttr("name").xmlVal, val:x.xmlAttr("val").xmlVal})


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

lib-io 库参考 ​

目录（导读） ​

概述（中译） ​

API 正文（英文） ​

docs ​

funcs ​

lib io ​

Overview ​

IO Handles ​

FTP Handles ​

Examples ​

func:ioAppend ​

ioAppend(handle) ​

func:ioCharset ​

ioCharset(handle, charset) ​

func:ioCopy ​

ioCopy(from, to, opts: {}) ​

func:ioCrc ​

ioCrc(handle, algorithm) ​

func:ioCreate ​

ioCreate(handle) ​

func:ioDelete ​

ioDelete(handle) ​

func:ioDigest ​

ioDigest(handle, algorithm) ​

func:ioDir ​

ioDir(handle) ​

func:ioEachCsv ​

ioEachCsv(handle, opts, fn) ​

func:ioEachLine ​

ioEachLine(handle, fn) ​

func:ioExport ​

ioExport(req, handle) ​

func:ioFromBase64 ​

ioFromBase64(s) ​

func:ioGzip ​

ioGzip(handle) ​

func:ioHmac ​

ioHmac(handle, algorithm, key) ​

func:ioInfo ​

ioInfo(handle) ​

func:ioMove ​

ioMove(from, to) ​

func:ioPbk ​

ioPbk(algorithm, password, salt, iterations, keyLen) ​

func:ioRandom ​

ioRandom(size) ​

func:ioReadCsv ​

ioReadCsv(handle, opts: null) ​

func:ioReadJson ​

ioReadJson(handle, opts: null) ​

func:ioReadJsonGrid ​

ioReadJsonGrid(handle, opts: null) ​

func:ioReadLines ​

ioReadLines(handle, opts: null) ​

func:ioReadStr ​

ioReadStr(handle) ​

func:ioReadTrio ​

ioReadTrio(handle) ​

func:ioReadXeto ​

ioReadXeto(handle, opts: null) ​

func:ioReadZinc ​

ioReadZinc(handle) ​

`lib-io` 库参考

目录（导读）

概述（中译）

API 正文（英文）

docs

funcs

lib io

Overview

IO Handles

FTP Handles

Examples

func:ioAppend

ioAppend(handle)

func:ioCharset

ioCharset(handle, charset)

func:ioCopy

ioCopy(from, to, opts: {})

func:ioCrc

ioCrc(handle, algorithm)

func:ioCreate

ioCreate(handle)

func:ioDelete

ioDelete(handle)

func:ioDigest

ioDigest(handle, algorithm)

func:ioDir

ioDir(handle)

func:ioEachCsv

ioEachCsv(handle, opts, fn)

func:ioEachLine

ioEachLine(handle, fn)

func:ioExport

ioExport(req, handle)

func:ioFromBase64

ioFromBase64(s)

func:ioGzip

ioGzip(handle)

func:ioHmac

ioHmac(handle, algorithm, key)

func:ioInfo

ioInfo(handle)

func:ioMove

ioMove(from, to)

func:ioPbk

ioPbk(algorithm, password, salt, iterations, keyLen)

func:ioRandom

ioRandom(size)

func:ioReadCsv

ioReadCsv(handle, opts: null)

func:ioReadJson

ioReadJson(handle, opts: null)

func:ioReadJsonGrid

ioReadJsonGrid(handle, opts: null)

func:ioReadLines

ioReadLines(handle, opts: null)

func:ioReadStr

ioReadStr(handle)

func:ioReadTrio

ioReadTrio(handle)

func:ioReadXeto

ioReadXeto(handle, opts: null)

func:ioReadZinc

ioReadZinc(handle)