Directories
¶
| Path | Synopsis |
|---|---|
|
Package bookpreviews picks a few books to show as covers on each entry of a people, genre, tag, or publisher list.
|
Package bookpreviews picks a few books to show as covers on each entry of a people, genre, tag, or publisher list. |
|
Package covers centralizes cover-file selection and serving so that the books, series, ereader, and OPDS handlers don't drift independently.
|
Package covers centralizes cover-file selection and serving so that the books, series, ereader, and OPDS handlers don't drift independently. |
|
Package delivery holds Delivery Rules, which decide the File Type each of a book's Files reaches a reader as (ADR 0011), and the resolver that applies them.
|
Package delivery holds Delivery Rules, which decide the File Type each of a book's Files reaches a reader as (ADR 0011), and the resolver that applies them. |
|
Package ereader serves server-rendered HTML for stock Kobo and Kindle browsers that cannot use OPDS or the React app.
|
Package ereader serves server-rendered HTML for stock Kobo and Kindle browsers that cannot use OPDS or the React app. |
|
filegentest
Package filegentest holds the conformance suite every filegen.StreamGenerator must pass, and stand-in generators for tests of the download cache and the routes that serve it.
|
Package filegentest holds the conformance suite every filegen.StreamGenerator must pass, and stand-in generators for tests of the download cache and the routes that serve it. |
|
Package filenames makes text safe to use in the names of downloaded files.
|
Package filenames makes text safe to use in the names of downloaded files. |
|
Package fingerprint computes content fingerprints for files.
|
Package fingerprint computes content fingerprints for files. |
|
Package fingerprints provides CRUD operations on the file_fingerprints table.
|
Package fingerprints provides CRUD operations on the file_fingerprints table. |
|
Package fixedlayout writes a fixed-layout EPUB 3 from the pages of a CBZ: one XHTML page per image, each sized for e-reader screens.
|
Package fixedlayout writes a fixed-layout EPUB 3 from the pages of a CBZ: one XHTML page per image, each sized for e-reader screens. |
|
Package frontend serves the embedded web application.
|
Package frontend serves the embedded web application. |
|
Package httputil provides small HTTP helpers shared across handlers.
|
Package httputil provides small HTTP helpers shared across handlers. |
|
pkg/identifiers/identifiers.go
|
pkg/identifiers/identifiers.go |
|
Package kepub provides conversion utilities for creating KePub files compatible with Kobo e-readers.
|
Package kepub provides conversion utilities for creating KePub files compatible with Kobo e-readers. |
|
Package koreader serves KOReader's progress sync protocol, so KOReader keeps its place through Shisho as a custom sync server.
|
Package koreader serves KOReader's progress sync protocol, so KOReader keeps its place through Shisho as a custom sync server. |
|
Package lrufiles keeps a directory of cached files within a byte budget by removing the least recently used files first.
|
Package lrufiles keeps a directory of cached files within a byte budget by removing the least recently used files first. |
|
Package merge holds the input checks that every resource merge (People, Series, Genres, Tags, Publishers) runs before it writes anything.
|
Package merge holds the input checks that every resource merge (People, Series, Genres, Tags, Publishers) runs before it writes anything. |
|
Package mobi reads MOBI and AZW3 files: Mobipocket (MOBI6) books, KF8 books, and combo files that hold a MOBI6 book followed by a KF8 one.
|
Package mobi reads MOBI and AZW3 files: Mobipocket (MOBI6) books, KF8 books, and combo files that hold a MOBI6 book followed by a KF8 one. |
|
incremental
Package incremental reads just enough of a PDF to append an incremental update to it, and writes that update.
|
Package incremental reads just enough of a PDF to append an incremental update to it, and writes that update. |
|
Package reach decides what a reading app reaches through the channels that browse a library, OPDS and the eReader browser: the Delivery Rules that pick each book's Files, the Device's scope, and which entries (libraries, a library's series and authors, a list) have anything to deliver, so both channels show the same books and leave out the same empty entries.
|
Package reach decides what a reading app reaches through the channels that browse a library, OPDS and the eReader browser: the Delivery Rules that pick each book's Files, the Device's scope, and which entries (libraries, a library's series and authors, a list) have anything to deliver, so both channels show the same books and leave out the same empty entries. |
|
Package reflowable translates positions in reflowable books between the forms each reader keeps: the web reader's CFI, KOReader's XPointer, and Kobo's span.
|
Package reflowable translates positions in reflowable books between the forms each reader keeps: the web reader's CFI, KOReader's XPointer, and Kobo's span. |
|
Package seriesnum parses and formats single series numbers and contiguous ranges.
|
Package seriesnum parses and formats single series numbers and contiguous ranges. |
|
Package sharelinks holds the Share Link feature: anonymous, expiring links that grant access to one Book.
|
Package sharelinks holds the Share Link feature: anonymous, expiring links that grant access to one Book. |
|
Package sortname provides functions for generating bibliographic sort names following ALA/Library of Congress conventions.
|
Package sortname provides functions for generating bibliographic sort names following ALA/Library of Congress conventions. |
|
Package sortspec parses, validates, builds SQL for, and resolves multi-level sort specifications (e.g.
|
Package sortspec parses, validates, builds SQL for, and resolves multi-level sort specifications (e.g. |
|
Package sqliteconn opens SQLite connections that run a fixed set of statements, usually pragmas, on every connection the pool opens, and provides the bun dialect for them.
|
Package sqliteconn opens SQLite connections that run a fixed set of statements, usually pragmas, on every connection the pool opens, and provides the bun dialect for them. |
|
Package testutils provides test-only API endpoints.
|
Package testutils provides test-only API endpoints. |
|
goconsts
Package goconsts reads string constants out of Go source so a test can check that every constant of a family is handled, without a hand-kept list that goes stale the same way the code under test would.
|
Package goconsts reads string constants out of Go source so a test can check that every constant of a family is handled, without a hand-kept list that goes stale the same way the code under test would. |
|
testdb
Package testdb opens the database that package tests run against.
|
Package testdb opens the database that package tests run against. |
|
testumask
Package testumask sets the process umask for the length of a test.
|
Package testumask sets the process umask for the length of a test. |
|
Package ziputil writes zip entries without recompressing them, for generators that stream an archive built from another one.
|
Package ziputil writes zip entries without recompressing them, for generators that stream an archive built from another one. |
Click to show internal directories.
Click to hide internal directories.