Index

Modules: openparser, openparser/csv, openparser/feed, openparser/json, openparser/private/types, openparser/rss, openparser/yaml.

API symbols

`$`:

• csv: proc `$`(f: CsvFieldSlice): string
• yaml: proc `$`(yamlObject: YAMLObject): string

advance:

• json: proc advance(parser: var JsonParser): JsonToken

AnyTable:

• types: type AnyTable

arrayToJson:

• json: proc arrayToJson(v, valImpl: NimNode; opts: JsonOptions = nil): NimNode

asChars:

• csv: proc asChars(mfile: MemFile): ptr UncheckedArray[char]

AtomCategory:

• feed: object AtomCategory

AtomContent:

• feed: object AtomContent

AtomEntry:

• feed: object AtomEntry

AtomFeed:

• feed: object AtomFeed

AtomGenerator:

• feed: object AtomGenerator

AtomLink:

• feed: object AtomLink

AtomNs:

• feed: const AtomNs

AtomParsingError:

• feed: object AtomParsingError

AtomPerson:

• feed: object AtomPerson

AtomText:

• feed: object AtomText

AtomValidationError:

• feed: object AtomValidationError

CsvFieldSlice:

• csv: object CsvFieldSlice

CsvOptions:

• csv: object CsvOptions

CsvParseError:

• csv: object CsvParseError

CsvRowCallback:

• csv: type CsvRowCallback

defaultCsvOptions:

• csv: proc defaultCsvOptions(): CsvOptions

dumpHook:

• json: proc dumpHook(s: var string; val: float32 | float64)
• json: proc dumpHook(s: var string; val: tuple)
• json: proc dumpHook(s: var string; val: object)
• json: proc dumpHook(s: var string; v: enum)
• json: proc dumpHook[K: string; V](s: var string; val: AnyTable[K, V])
• json: proc dumpHook[N, T](s: var string; v: array[N, t[T]])
• json: proc dumpHook[N, T](s: var string; v: array[N, T])
• json: proc dumpHook(s: var string; val: bool)
• json: proc dumpHook(s: var string; v: char)
• json: proc dumpHook[T](s: var string; v: CritBitTree[T])
• json: proc dumpHook(s: var string; val: Integers)
• json: proc dumpHook(s: var string; v: JsonNode)
• json: proc dumpHook[T](s: var string; v: Option[T])
• json: proc dumpHook(s: var string; val: pointer)
• json: proc dumpHook[T](s: var string; val: ref T)
• json: proc dumpHook[T](s: var string; arr: seq[T])
• json: proc dumpHook[T](s: var string; val: set[T])
• json: proc dumpHook(s: var string; val: string)
• json: proc dumpHook[T: distinct](s: var string; v: T)
• yaml: proc dumpHook(s: var string; v: YamlNode)

fetchAtom:

• feed: proc fetchAtom(url: string): AtomFeed

fetchRss:

• rss: proc fetchRss(url: string): RssFeed

fromJson:

• json: proc fromJson(mapped: MemFile): JsonNode
• json: proc fromJson(str: string): JsonNode
• json: proc fromJson[T](s: string; x: typedesc[T]): T

fromJsonFile:

• json: proc fromJsonFile(filename: string): JsonNode

fromJsonL:

• json: proc fromJsonL(mapped: MemFile): JsonNode
• json: proc fromJsonL(str: string): JsonNode

fromJsonLFile:

• json: proc fromJsonLFile(filename: string): JsonNode

get:

• yaml: proc get(n: YamlNode; key: string): YamlNode
• yaml: proc get(obj: YAMLObject; key: string): YamlNode

getArray:

• yaml: proc getArray(n: YamlNode): seq[YamlNode]

getBool:

• yaml: proc getBool(n: YamlNode): bool

getFloat:

• yaml: proc getFloat(n: YamlNode): float64

getInt:

• yaml: proc getInt(n: YamlNode): int64

getObject:

• yaml: proc getObject(n: YamlNode): OrderedTableRef[string, YamlNode]

getStr:

• yaml: proc getStr(n: YamlNode): string

getValue:

• yaml: proc getValue(v: YamlNode): string

Integers:

• types: type Integers

isMapped:

• json: proc isMapped(m: MemFile): bool

JsonOptions:

• json: type JsonOptions

JsonParser:

• json: object JsonParser

JsonToken:

• json: type JsonToken

JsonTokenKind:

• json: enum JsonTokenKind

jtkColon:

• json: JsonTokenKind.jtkColon

jtkComma:

• json: JsonTokenKind.jtkComma

jtkEof:

• json: JsonTokenKind.jtkEof

jtkFalse:

• json: JsonTokenKind.jtkFalse

jtkLBrace:

• json: JsonTokenKind.jtkLBrace

jtkLBracket:

• json: JsonTokenKind.jtkLBracket

jtkNull:

• json: JsonTokenKind.jtkNull

jtkNumber:

• json: JsonTokenKind.jtkNumber

jtkRBrace:

• json: JsonTokenKind.jtkRBrace

jtkRBracket:

• json: JsonTokenKind.jtkRBracket

jtkString:

• json: JsonTokenKind.jtkString

jtkTrue:

• json: JsonTokenKind.jtkTrue

newYamlArray:

• yaml: proc newYamlArray(): YamlNode

newYamlBoolean:

• yaml: proc newYamlBoolean(b: bool): YamlNode

newYamlFloat:

• yaml: proc newYamlFloat(f: float64): YamlNode

newYamlInteger:

• yaml: proc newYamlInteger(i: int64): YamlNode

newYamlLexer:

• yaml: proc newYamlLexer(input: string): YamlLexer

newYamlNull:

• yaml: proc newYamlNull(): YamlNode

newYamlObject:

• yaml: proc newYamlObject(): YamlNode

newYamlString:

• yaml: proc newYamlString(s: string): YamlNode

nextToken:

• yaml: proc nextToken(p: var YamlParser): YamlToken

objectToJson:

• json: proc objectToJson(v, valImpl: NimNode; opts: JsonOptions = nil): NimNode

OpenLexer:

• types: object OpenLexer

OpenParserJsonError:

• json: object OpenParserJsonError

OpenParserYamlError:

• yaml: object OpenParserYamlError

openReadOnly:

• json: proc openReadOnly(filename: string; allowRemap = false; mapFlags = cint(-1)): MemFile

OpenToken:

• types: object OpenToken

parseAtom:

• feed: proc parseAtom(xml: string): AtomFeed

parseCsv:

• csv: proc parseCsv(mfile: MemFile; onRow: CsvRowCallback; options: CsvOptions = defaultCsvOptions())

parseFile:

• csv: proc parseFile(filename: string; onRow: CsvRowCallback; options: CsvOptions = defaultCsvOptions())

parseHook:

• json: proc parseHook[K: string; V](parser: var JsonParser; v: var AnyTable[K, V])
• json: proc parseHook(parser: var JsonParser; v: var bool)
• json: proc parseHook(parser: var JsonParser; v: var JsonNode)
• json: proc parseHook[T](parser: var JsonParser; v: var Option[T])
• json: proc parseHook[T](parser: var JsonParser; v: var seq[T])
• json: proc parseHook[T](parser: var JsonParser; v: var set[T])
• json: proc parseHook(parser: var JsonParser; v: var string)
• json: proc parseHook[T: float | float32 | float64](parser: var JsonParser; v: var T)
• json: proc parseHook[T: object](parser: var JsonParser; v: var T)
• json: proc parseHook[T: enum](parser: var JsonParser; v: var T)
• json: proc parseHook[T: Integers](parser: var JsonParser; v: var T)
• json: proc parseHook[T: tuple](parser: var JsonParser; v: var T)
• json: proc parseHook[T: distinct](parser: var JsonParser; v: var T)
• json: proc parseHook[T: ref object](parser: var JsonParser; v: var T)
• yaml: proc parseHook(parser: var YamlParser; v: var bool)
• yaml: proc parseHook[T](parser: var YamlParser; v: var set[T])
• yaml: proc parseHook(parser: var YamlParser; v: var string)
• yaml: proc parseHook[T: float | float32 | float64](parser: var YamlParser; v: var T)
• yaml: proc parseHook[T: Integers](parser: var YamlParser; v: var T)
• yaml: proc parseHook[T: enum](parser: var YamlParser; v: var T)

parseRss:

• rss: proc parseRss(xml: string): RssFeed

parseYAML:

• yaml: proc parseYAML(input: YAML): YAMLObject
• yaml: proc parseYAML[T](input: YAML; t: typedesc[T]): T
• yaml: proc parseYAML[T: object | ref object](parser: var YamlParser; v: var T)

put:

• yaml: proc put(obj: YAMLObject; key: string; value: YamlNode)

readAtom:

• feed: proc readAtom(filePath: string): AtomFeed

readRss:

• rss: proc readRss(filePath: string): RssFeed

RssFeed:

• rss: object RssFeed

RssImage:

• rss: object RssImage

RssItem:

• rss: object RssItem

RssMediaContent:

• rss: object RssMediaContent

RSSParsingError:

• rss: object RSSParsingError

skippable:

• json: template skippable()

skipValue:

• json: proc skipValue(parser: var JsonParser)

toAtomXml:

• feed: proc toAtomXml(feed: AtomFeed): string

toJson:

• json: proc toJson[T](v: T; opts: JsonOptions = nil): string

toRssXml:

• rss: proc toRssXml(feed: RssFeed): string

toStaticJson:

• json: macro toStaticJson(v: typed; opts: static JsonOptions = nil): untyped

toString:

• csv: proc toString(f: CsvFieldSlice): string

YAML:

• yaml: type YAML

yamlArray:

• yaml: YamlValueKind.yamlArray

yamlBoolean:

• yaml: YamlValueKind.yamlBoolean

yamlFloat:

• yaml: YamlValueKind.yamlFloat

yamlInteger:

• yaml: YamlValueKind.yamlInteger

YamlLexer:

• yaml: object YamlLexer

YamlNode:

• yaml: type YamlNode

yamlNull:

• yaml: YamlValueKind.yamlNull

yamlObject:

• yaml: YamlValueKind.yamlObject

YAMLObject:

• yaml: type YAMLObject

YamlParser:

• yaml: object YamlParser

yamlString:

• yaml: YamlValueKind.yamlString

YamlToken:

• yaml: type YamlToken

YamlTokenKind:

• yaml: enum YamlTokenKind

YamlValueKind:

• yaml: enum YamlValueKind

ytkBoolean:

• yaml: YamlTokenKind.ytkBoolean

ytkColon:

• yaml: YamlTokenKind.ytkColon

ytkComma:

• yaml: YamlTokenKind.ytkComma

ytkComment:

• yaml: YamlTokenKind.ytkComment

ytkDash:

• yaml: YamlTokenKind.ytkDash

ytkEOF:

• yaml: YamlTokenKind.ytkEOF

ytkFloat:

• yaml: YamlTokenKind.ytkFloat

ytkGT:

• yaml: YamlTokenKind.ytkGT

ytkIdentifier:

• yaml: YamlTokenKind.ytkIdentifier

ytkInteger:

• yaml: YamlTokenKind.ytkInteger

ytkLB:

• yaml: YamlTokenKind.ytkLB

ytkLC:

• yaml: YamlTokenKind.ytkLC

ytkPipe:

• yaml: YamlTokenKind.ytkPipe

ytkQuote:

• yaml: YamlTokenKind.ytkQuote

ytkRB:

• yaml: YamlTokenKind.ytkRB

ytkRC:

• yaml: YamlTokenKind.ytkRC

ytkSingleQuote:

• yaml: YamlTokenKind.ytkSingleQuote

ytkString:

• yaml: YamlTokenKind.ytkString

ytkUnknown:

• yaml: YamlTokenKind.ytkUnknown