poka.sh

Docs

Shared parser crates

Generated by scripts/gen-shared-crates-reference.py from the //! headers, Cargo.toml files and public items of the shared crates. Do not edit by hand: change the source, then run the script.

Generated page. The library crates under parsers/ that parsers share: a crate with a src/lib.rs and no plugin.json. The summary is the first sentence of the crate's //! header; the header in the source is the full account. The public-item lists come from a text scan of column-0 pub declarations, so they omit re-exports and items inside inline modules or macros.

11 shared crates.

Crate Summary Used by
poka-bdl-common The BDL grammar, shared by DOE-2 input (.inp) and BDL listing (.bdl). 2
poka-bem-geometry Building-model geometry → Scene3DAst, shared by the BEM parsers (poka-parsers#241): EnergyPlus .idf, DesignBuilder .dsbxml (or an .xml with a <dsbXML … 7
poka-image-common A memory-budgeted image decode, shared by the parsers that decode a whole bitmap with the image crate and re-encode it as PNG for the viewer (poka-apng … 21
poka-iwork-common A reader for the IWA streams inside an iWork package — the part Numbers, Pages and Keynote all share. 3
poka-mesh-common Clean-up shared by the mesh parsers. 2
poka-parser-common Helpers that parser crates used to carry a private copy of (#158). 857
poka-pwfile-common Shared PWFILE parser for SANKOM Audytor family formats. 6
poka-raw-common Camera-raw previews from the JPEG the camera embedded in the file. 12
poka-series-common Downsampling shared by the parsers that emit a ChartAst (poka-eso, poka-epw, poka-wea). 3
poka-sheet-common A calamine workbook as a WorkbookAst, shared by poka-xls, poka-xlsx and poka-xlsm so the three draw a spreadsheet the same way on … 3
poka-xml-common Text helpers shared by the parsers that read XML with quick-xml. 21

poka-bdl-common

The BDL grammar, shared by DOE-2 input (.inp) and BDL listing (.bdl).

Public items: Counts (struct), build_scene (fn), geometry (mod), LEVELS (const), BARE_COMMANDS (const), decode (fn), windows_1252_char (fn), Value (enum), Object (struct), Bdl (struct), is_command_word (fn), strip_comment (fn), parse_value (fn), parse_lines (fn), parse_text (fn).

Used by 2: poka-bdl, poka-inp.

poka-bem-geometry

Building-model geometry → Scene3DAst, shared by the BEM parsers (poka-parsers#241): EnergyPlus .idf, DesignBuilder .dsbxml (or an .xml with a <dsbXML root), OpenStudio .osm, DOE-2 .inp/.bdl.

Public items: proto (mod), P3 (type), MAX_TRIANGLES (const), layer_colour (fn), SceneBuilder (struct), tabs (fn), rotate_clockwise (fn), newell_normal (fn).

Used by 7: poka-bdl, poka-bdl-common, poka-dsbxml, poka-idf, poka-inp, poka-osm, poka-rad.

poka-image-common

A memory-budgeted image decode, shared by the parsers that decode a whole bitmap with the image crate and re-encode it as PNG for the viewer (poka-apng, poka-bmp, poka-dds, poka-tga, poka-pgm, poka-ppm), and the same budget for the parsers that decode a bitmap by hand ([check_budget]: poka-cin, poka-dpx, poka-pcx, poka-ras, poka-wpg, poka-xpm).

Public items: MAX_DIM (const), budget_bytes (fn), planned_bytes (fn), Refusal (enum), check_budget (fn), decode_within_budget (fn), PREVIEW_BYTES (const), fit_preview (fn), rgba_factor (fn), rgba_bytes (fn), reduce_rgba (fn), reduce_by (fn), read_capped (fn), encode_png (fn), manifest_memory_mb (fn), FRAMES_BYTES (const), MIN_FRAME_BYTES (const), limits (fn), Still (struct), decode_still (fn), plan_still (fn), FramePlan (struct), plan_frames (fn), Animation (struct), decode_frames (fn), write_still (fn), write_frames (fn), Output (enum), Declared (struct), render (fn), render_still (fn), still_entries (fn), frame_entries (fn), reference (mod), CappedAlloc (struct).

Used by 21: poka-apng, poka-bmp, poka-cbz, poka-cin, poka-cur, poka-dds, poka-dpx, poka-gif, poka-ico, poka-jpeg, poka-jxl, poka-netpbm, poka-pcx, poka-pgm, poka-png, poka-ppm, poka-ras, poka-tga, poka-webp, poka-wpg, poka-xpm.

poka-iwork-common

A reader for the IWA streams inside an iWork package — the part Numbers, Pages and Keynote all share.

Public items: MAX_ROWS (const), MAX_COLUMNS (const), Table (struct), Sheet (struct), APPLE_ENCRYPTED_METHODS (const), encrypted_members (fn), read_streams (fn), Slide (struct), read_slides (fn), read_sheets (fn).

Used by 3: poka-key, poka-numbers, poka-pages.

poka-mesh-common

Clean-up shared by the mesh parsers.

Public items: drop_degenerate_triangles (fn).

Used by 2: poka-3dm, poka-bim.

poka-parser-common

Helpers that parser crates used to carry a private copy of (#158).

Public items: budget_bytes (fn), CappedRead (struct), read_capped (fn), cap_note (fn), human_bytes (fn), human_bytes_gib (fn), archive_facts (fn), archive_file_facts (fn), section (fn), write_error (fn), write_error_recoverable (fn), write_table_error (fn), tree_leaf (fn), tree_leaf_owned (fn), tree_leaf_str (fn), tree_leaf_into (fn), tree_leaf_name_into (fn), tree_leaf_info_into (fn), plural (fn), plural_suffix (fn), count_matches (fn), count_matches_u64 (fn), fmt_bytes_kb (fn), fmt_bytes_gb (fn), fmt_bytes_tb (fn), base64_decode (fn), days_to_ymd (fn), ascii_clean (fn), detect_magic (fn), truncate_ellipsis (fn), metadata_entry (fn), metadata_entry_into (fn), push_entry_if_nonempty (fn), table_column (fn), local_name (fn), le_u16 (fn), le_u32 (fn), le_u64 (fn), le_u32_opt (fn), le_i32_opt (fn), c_str (fn), or_unset (fn), count_section_keys (fn), dir_names (fn).

Used by 857: poka-3dm, poka-3ds, poka-3mf, poka-669, poka-7z, poka-aac, poka-aax, poka-abc, poka-abw, poka-ac3, poka-ace, poka-acsm, poka-ada, poka-adf, poka-aep, poka-afm, poka-agda, poka-ahk, poka-aiff, poka-alertmanager-yml, poka-alloy, poka-amf, poka-amr, poka-ams, poka-ani, poka-apache-conf, poka-ape, poka-apk, poka-apng, poka-appimage, poka-applescript, poka-appx, poka-ar, poka-arc, poka-arff, poka-arj, poka-arrow, poka-asciidoc, poka-asciinema, poka-asd, poka-ase, poka-asn1, poka-ass, poka-astc, poka-au, poka-audiometa, poka-avif, poka-avro, poka-aws-credentials, poka-azw3, poka-b18, poka-b3dm, poka-bai, poka-bam, poka-bashrc, poka-bazel, poka-bazel-build, poka-bcf, poka-bcfzip, poka-bdec, poka-bdf, poka-bdl, poka-beam, poka-bed, poka-bgen, poka-bib, poka-bif, poka-bigwig, poka-bim, poka-bind-zone, poka-bink, poka-blend, poka-blo, poka-blp, poka-bmfont, poka-bmml, poka-bmp, poka-bnd, poka-bochs, poka-bom, poka-bpg, poka-bplist, poka-bpmn, poka-br, poka-bsdiff, poka-bson, poka-bz3, poka-c64-prg, poka-cab, poka-cabal, poka-cablist, poka-caddyfile, poka-caf, poka-callgrind, poka-capnp, poka-car, poka-cargo-toml, poka-cargolock, poka-cat, poka-cb7, poka-cbor, poka-cbor-seq, poka-cbr, poka-cbt, poka-cbz, poka-cdf, poka-cdr, poka-cdx, poka-cfb, poka-cgm, poka-checksum, poka-chm, poka-cif, poka-cin, poka-citygml, poka-clang-format, poka-class, poka-clm, poka-cloudformation, poka-cmakecache, poka-cnt, poka-cobertura, poka-cobie, poka-cobol, poka-code, poka-codeowners, poka-coff, poka-compressed, poka-conda, poka-cookies, poka-coq, poka-coredump, poka-cpio, poka-cpuprofile, poka-cram, poka-criu, poka-crl, poka-cron, poka-crontab, poka-crystal, poka-csproj, poka-csr, poka-csv, poka-ctb, poka-cue, poka-cur, poka-cypher, poka-d-ts, poka-d2, poka-d64, poka-dae, poka-db, poka-dbf, poka-dck, poka-dds, poka-ddy, poka-deb, poka-deb-control, poka-dem, poka-dependabot, poka-desktop, poka-dff, poka-dgn, poka-dhall, poka-dicom, poka-dimacs, poka-dir, poka-djvu, poka-dll, poka-dmn, poka-doc, poka-dockerfile, poka-dockerignore, poka-docx, poka-dovecot-conf, poka-doxyfile, poka-doxygen, poka-dpx, poka-dsbxml, poka-dsf, poka-dsk, poka-dta, poka-dtb, poka-dts, poka-dvi, poka-dwfx, poka-dwg, poka-dwl, poka-dwl2, poka-dxb, poka-dxbc, poka-dxf, poka-dyf, poka-dyn, poka-eagle, poka-ebml, poka-ebnf, poka-edb, poka-edif, poka-editorconfig, poka-edn, poka-egg, poka-eio, poka-ekd, poka-elasticsearch-yml, poka-elf, poka-elm, poka-emf, poka-eml, poka-env, poka-eot, poka-epjson, poka-epub, poka-epw, poka-err, poka-eslintrc, poka-eso, poka-evt, poka-evtx, poka-exr, poka-ext4, poka-f06, poka-fail2ban-jail, poka-far, poka-fasta, poka-fastq, poka-fbs, poka-fbx, poka-fcpxml, poka-fcstd, poka-fdf, poka-fds, poka-fdx, poka-feather, poka-fen, poka-fennel, poka-fishrc, poka-fits, poka-fla, poka-flac, poka-flake, poka-flamegraph, poka-flp, poka-fluentd-conf, poka-flv, poka-fmp12, poka-fmt, poka-fmu, poka-fnt, poka-fon, poka-font, poka-fontforge, poka-fonts-conf, poka-fortran, poka-fountain, poka-fst, poka-fstab, poka-gameboy-rom, poka-gba, poka-gbs, poka-gcode, poka-gdl, poka-gem, poka-gemfile, poka-gemspec, poka-genesis-rom, poka-geojson, poka-gerber, poka-gff, poka-gfxmeta, poka-gh, poka-ghx, poka-gif, poka-gitattributes, poka-gitconfig, poka-githubactions, poka-gitlab-ci, poka-glb, poka-gltf, poka-gnumeric, poka-go-mod, poka-go-sum, poka-godot-tscn, poka-gomod, poka-gp, poka-gpkg, poka-gpt, poka-gpx, poka-grafana, poka-grafana-ini, poka-grain, poka-graphml, poka-graphviz, poka-grd, poka-gre, poka-grib, poka-group, poka-grr, poka-grub, poka-gsm, poka-gtf, poka-h5, poka-haproxy, poka-haproxy-cfg, poka-har, poka-haskell-cabal, poka-hbs, poka-hdf5, poka-hdr, poka-heapsnapshot, poka-heic, poka-helm, poka-helmfile, poka-hhc, poka-hlp, poka-hosts, poka-hprof, poka-htpasswd, poka-http, poka-hwp, poka-hyprland-config, poka-i3-config, poka-icc, poka-icns, poka-ico, poka-ics, poka-idd, poka-idf, poka-ids, poka-ies, poka-ifc, poka-ifcjson, poka-ifcxml, poka-ifczip, poka-iff, poka-iges, poka-imd, poka-imf, poka-inf, poka-ini, poka-inp, poka-ion, poka-iptables-save, poka-ipynb, poka-isb, poka-iso, poka-isproj, poka-it, poka-it-tracker, poka-jar, poka-jenkinsfile, poka-jfr, poka-jks, poka-jng, poka-jp2, poka-jpeg, poka-jsonl, poka-jsonld, poka-jsonnet, poka-jsonpatch, poka-jstack, poka-jt, poka-julia-toml, poka-jumplist, poka-junit, poka-jwks, poka-jwt, poka-jxl, poka-jxr, poka-k, poka-kar, poka-kdbx, poka-keepass, poka-key, poka-kicad-pcb, poka-kml, poka-kmz, poka-known-hosts, poka-ko, poka-koka, poka-kwd, poka-landxml, poka-las, poka-laz, poka-lcov, poka-ldt, poka-lean, poka-lha, poka-libsvm, poka-license, poka-lilypond, poka-lin, poka-lit, poka-llvm-ir, poka-lmdb, poka-lnk, poka-log, poka-lrc, poka-luac, poka-luks, poka-lvm, poka-lyx, poka-lz4, poka-lzh, poka-lzip, poka-lzma, poka-lzo, poka-m2ts, poka-m3u, poka-m4v, poka-mach-o, poka-macho, poka-magnet, poka-mailcap, poka-makefile, poka-mar, poka-mat, poka-mbox, poka-mbr, poka-mbtiles, poka-md, poka-mdd, poka-mdl, poka-mds, poka-mecab, poka-med, poka-mediawiki, poka-mermaid, poka-mft, poka-mht, poka-mid, poka-midi, poka-mif, poka-mime-types, poka-minidump, poka-mlir, poka-mlmodel, poka-mng, poka-mo, poka-mobi, poka-mod, poka-mod-tracker, poka-mojo, poka-mol, poka-mol2, poka-mosquitto-conf, poka-mov, poka-mp3, poka-mp4, poka-mpc, poka-mpd-conf, poka-mpq, poka-mpv-conf, poka-mrc, poka-mscz, poka-msg, poka-msgpack, poka-msi, poka-mst, poka-msu, poka-mt2, poka-mtd, poka-mtl, poka-mtm, poka-mtr, poka-mtx, poka-musicxml, poka-mvdxml, poka-mxf, poka-n64-rom, poka-named-conf, poka-nas, poka-nb, poka-nbt, poka-nc, poka-nes, poka-nes-rom, poka-netpbm, poka-netplan, poka-netrc, poka-newick, poka-nexus, poka-nftables, poka-nginx-conf, poka-nifti, poka-nim, poka-ninja, poka-nmap, poka-nomad-hcl, poka-nrg, poka-nrrd, poka-nsf, poka-nt, poka-nu, poka-numbers, poka-numpy, poka-nwf, poka-nzb, poka-obj, poka-oct, poka-odb, poka-odp, poka-ods, poka-odt, poka-off, poka-ofx, poka-ogv, poka-okt, poka-onnx, poka-openvpn, poka-openvpn-conf, poka-opf, poka-opml, poka-opus, poka-orc, poka-org, poka-osc, poka-osm, poka-osw, poka-otf, poka-ott, poka-ozd, poka-oze, poka-ozr, poka-p12, poka-p7b, poka-p7s, poka-package-json, poka-package-lock, poka-pacman-conf, poka-pacman-pkgbuild, poka-pages, poka-pak, poka-pal, poka-par2, poka-parquet, poka-pas, poka-passwd, poka-pat, poka-patch, poka-pbf, poka-pbf-osm, poka-pbix, poka-pc3, poka-pcap, poka-pcapng, poka-pcf, poka-pcx, poka-pdb, poka-pdb-debug, poka-pdf, poka-pdf-info, poka-pe, poka-pem, poka-perf, poka-perfetto, poka-pf, poka-pfa, poka-pfb, poka-pfm, poka-pgm, poka-pgn, poka-pgp-armored, poka-pgpass, poka-pico8, poka-pipfile, poka-pkgbuild, poka-pkpass, poka-plantuml, poka-pli, poka-plist, poka-plt, poka-ply, poka-pmd, poka-pmml, poka-png, poka-pnpm-lock, poka-po, poka-pod, poka-poetry-lock, poka-polybar, poka-pom, poka-pony, poka-postfix-main-cf, poka-postman, poka-postscript, poka-ppk, poka-ppm, poka-pprof, poka-pps, poka-ppt, poka-pptx, poka-prc, poka-pre-commit, poka-prettierrc, poka-prj, poka-procfile, poka-prolog, poka-prometheus-yml, poka-protobuf-wire, poka-prproj, poka-psb, poka-psd, poka-psf, poka-psm, poka-pst, poka-pts, poka-ptx, poka-pulumi, poka-puppetfile, poka-purescript, poka-pvr, poka-pyc, poka-pyi, poka-pyproject, poka-qif, poka-qm, poka-qoa, poka-qoi, poka-ra, poka-rad, poka-rar, poka-rar5, poka-ras, poka-raw-common, poka-rbs, poka-rclone, poka-rdb, poka-rdd, poka-rdf, poka-rdoc, poka-rds, poka-redis-conf, poka-reg, poka-rego, poka-renovate, poka-requirements, poka-res, poka-resolv-conf, poka-rest, poka-rfa, poka-rkt, poka-rmd, poka-roc, poka-rockspec, poka-ron, poka-rpm, poka-rpm-spec, poka-rpp, poka-rspec, poka-rss, poka-rst, poka-rtf, poka-rubocop, poka-rust-mir, poka-rvt, poka-s2k, poka-s3m, poka-safetensors, poka-sam, poka-sas7bdat, poka-sat, poka-sav, poka-sbml, poka-scad, poka-screenrc, poka-scrivx, poka-sdg, poka-sdp, poka-sdw, poka-services, poka-sf2, poka-sfc, poka-sgf, poka-shadow, poka-sheet-common, poka-shell-history, poka-shellcheckrc, poka-shn, poka-shp, poka-shx, poka-sid, poka-skp, poka-sln, poka-smk, poka-smt2, poka-snakemake, poka-snappy, poka-snd, poka-snes-rom, poka-snmp-mib, poka-snoop, poka-soe, poka-source-map, poka-sparql, poka-spc, poka-spdx, poka-spirv, poka-splat, poka-spv, poka-sqlite, poka-srl, poka-ssh-config, poka-sta, poka-stack-yaml, poka-stat, poka-step, poka-stl, poka-stm, poka-stockholm, poka-stp, poka-strace, poka-sty, poka-stylelintrc, poka-subtitle, poka-sudoers, poka-supervisord-conf, poka-svelte, poka-svg, poka-svgz, poka-sway-config, poka-swf, poka-symphonia, poka-syslog, poka-systemd, poka-systemd-unit, poka-syx, poka-t64, poka-tab, poka-tabix, poka-tap, poka-tar, poka-taskpaper, poka-tbd, poka-tcx, poka-tdb, poka-tdms, poka-tensorboard, poka-tex, poka-text, poka-tflite, poka-tfm, poka-tfrecord, poka-tga, poka-theme, poka-thmx, poka-thrift, poka-thumbs, poka-tileset, poka-tla, poka-tle, poka-tm2, poka-tmux-conf, poka-tmy3, poka-tool-versions, poka-trace-event, poka-traefik-yml, poka-trig, poka-troff, poka-tscn, poka-tsconfig, poka-tsm, poka-tta, poka-ttc, poka-ttl, poka-twb, poka-typst, poka-tzx, poka-u3d, poka-uci, poka-ult, poka-umx, poka-url, poka-usd, poka-usda, poka-usdc, poka-usdz, poka-uue, poka-vagrantfile, poka-vala, poka-vbs, poka-vcf, poka-vdi, poka-vega, poka-vgm, poka-vhd, poka-vhdx, poka-vimrc, poka-vlang, poka-vmdk, poka-vob, poka-vox, poka-vpk, poka-vrml, poka-vsd, poka-vsdx, poka-vst3, poka-vti, poka-vtt, poka-vue, poka-w64, poka-warc, poka-wasm, poka-wat, poka-wav, poka-wavpack, poka-waybar, poka-wea, poka-weba, poka-webloc, poka-webm, poka-webp, poka-wig, poka-wim, poka-wireguard, poka-wireguard-config, poka-wmf, poka-woff2, poka-wpd, poka-wpg, poka-wps, poka-wsq, poka-wv, poka-x-directx, poka-x3d, poka-xar, poka-xbe, poka-xcf, poka-xcu, poka-xdmf, poka-xer, poka-xex, poka-xls, poka-xlsb, poka-xlsm, poka-xlsx, poka-xm-tracker, poka-xml, poka-xpm, poka-xps, poka-xresources, poka-xyz, poka-y4m, poka-yang, poka-yara, poka-yarn-lock, poka-z, poka-z-compress, poka-z01, poka-z64, poka-zig, poka-zip, poka-zone, poka-zoo, poka-zpaq, poka-zpl, poka-zst.

poka-pwfile-common

Shared PWFILE parser for SANKOM Audytor family formats.

Public items: Meta (struct), is_pwfile (fn), parse (fn), find_path (fn), render_meta_html (fn).

Used by 6: poka-grd, poka-gre, poka-grr, poka-ozd, poka-oze, poka-ozr.

poka-raw-common

Camera-raw previews from the JPEG the camera embedded in the file.

Public items: Located (struct), raf (fn), x3f (fn), ciff (fn), cr3 (fn), JpegInfo (struct), probe (fn), with_orientation (fn), containers (mod), jpeg (mod), source (mod), tiff (mod), proto (mod), PREVIEW_BUDGET (const), MAX_THUMBNAIL_PIXELS (const), PLANNED_PEAK (const), Format (struct), Found (struct), inspect (fn), build_ast (fn), label_for_extension (fn), run (fn), MAX_READ (const), Bytes (trait), Seekable (struct), Slice (struct), NEW_SUBFILE_TYPE (const), WIDTH (const), HEIGHT (const), BITS_PER_SAMPLE (const), COMPRESSION (const), PHOTOMETRIC (const), MAKE (const), MODEL (const), STRIP_OFFSETS (const), ORIENTATION (const), SAMPLES_PER_PIXEL (const), STRIP_BYTE_COUNTS (const), PLANAR_CONFIG (const), DATE_TIME (const), SUB_IFDS (const), JPEG_OFFSET (const), JPEG_LENGTH (const), PANASONIC_JPEG (const), EXIF_IFD (const), EXPOSURE_TIME (const), F_NUMBER (const), ISO (const), DATE_ORIGINAL (const), FOCAL_LENGTH (const), LENS_MODEL (const), MAKER_NOTE (const), OLYMPUS_CAMERA_SETTINGS (const), OLYMPUS_PREVIEW_START (const), OLYMPUS_PREVIEW_LENGTH (const), OLYMPUS_THUMBNAIL (const), Value (enum), Ifd (struct), Order (enum), order (fn), walk (fn), walk_at (fn).

Used by 12: poka-arw, poka-cr2, poka-crw, poka-dcr, poka-dng, poka-nef, poka-orf, poka-raf, poka-raw, poka-rw2, poka-rwl, poka-x3f.

poka-series-common

Downsampling shared by the parsers that emit a ChartAst (poka-eso, poka-epw, poka-wea).

Public items: Series (struct), Downsampler (struct), MONTHS (const), MONTH_START_DAY (const).

Used by 3: poka-epw, poka-eso, poka-wea.

poka-sheet-common

A calamine workbook as a WorkbookAst, shared by poka-xls, poka-xlsx and poka-xlsm so the three draw a spreadsheet the same way on poka-workbook-viewer: a tab per sheet, the grid from A1 with column letters and row numbers, and the formula behind a value on hover.

Public items: SheetNotes (type), cell_ref (fn), read_ooxml_comments (fn), comments (mod), proto (mod), MAX_ROWS (const), MAX_COLS (const), MAX_CELLS (const), workbook_ast (fn), workbook_ast_with_notes (fn), column_letter (fn), cell_text (fn).

Used by 3: poka-xls, poka-xlsm, poka-xlsx.

poka-xml-common

Text helpers shared by the parsers that read XML with quick-xml.

Public items: DocFact (struct), ooxml_doc_facts (fn), odf_doc_facts (fn), doc_props (mod), attr_value (fn), general_ref_text (fn).

Used by 21: poka-cobertura, poka-docx, poka-dsbxml, poka-ifcxml, poka-iwork-common, poka-junit, poka-kwd, poka-nmap, poka-odb, poka-odp, poka-odt, poka-opml, poka-plist, poka-pptx, poka-rss, poka-sheet-common, poka-thmx, poka-vsdx, poka-vtk, poka-xml, poka-xps.