Expand description
§aidoku
The aidoku crate contains everything necessary to create a source for Aidoku.
§Crate Features
Default features:
talc: Enables the talc allocator when building for wasm.imports: Enables the API functions provided to Aidoku sources.helpers: Enables some helpful additions for source development.
Optional features:
json: Enables deserialization of JSON network responses and default values via serde_json.test: Disables the panic handler for use in tests.
§Usage
To use this library to create a source for Aidoku, you need to implement the Source trait and register it with the register_source! macro.
struct TestSource;
impl Source for TestSource {
// implement Source trait methods here
}
// register the source to export wasm functions
register_source!(TestSource, Home);Re-exports§
pub use crate::imports::error::AidokuError;pub use crate::imports::error::Result;pub use postcard;pub use serde;
Modules§
- alloc
- Re-export of
alloccrate. - canvas
- Structs and enums used for drawing on a canvas.
- helpers
- Utilities for commonly used functions when creating Aidoku sources.
- imports
- Wrapper around imported source API functions.
- prelude
- The prelude macros.
Macros§
- bail
- Returns early with an error.
- debug
- Prints to Aidoku logs if debug assertions are enabled.
- error
- Constructs an error with a message.
- println
- Prints to Aidoku logs.
- register_
source - Registers a source for use with Aidoku.
Structs§
- Button
Setting - A button that notifies the source when pressed.
- Chapter
- A chapter of a manga.
- Check
Filter - A checkbox.
- Editable
List Setting - A list that can be edited by the user.
- Filter
- A filter that can be used in a source search.
- Filter
Item - A link to a listing that uses the provided filters.
- Group
Setting - A group of settings.
- HashMap
- A hash map implemented with quadratic probing and SIMD lookup.
- Home
Component - A component for a home layout.
- Home
Layout - A home layout for a source.
- Image
Request - The details of a HTTP request.
- Image
Response - A response from a network image request.
- Link
- A link used in home components.
- Link
Setting - A link to a URL.
- Listing
- A listing of manga.
- Login
Setting - A login control.
- Manga
- A manga, comic, webtoon, or other type of content for Aidoku to read.
- Manga
Page Result - A page of manga entries.
- Manga
With Chapter - A paired manga and chapter.
- Multi
Select Filter - A list of values that allows multiple selections.
- Multi
Select Setting - A page that allows selection of multiple values.
- Page
- A page for a chapter.
- Page
Setting - A page of settings.
- Range
Filter - A range filter.
- Segment
Setting - A segmented control.
- Select
Filter - A list of values that allows a single selection.
- Select
Setting - A page that allows selection of a single value.
- Setting
- A setting that is shown in the source settings page.
- Sort
Filter - A list of sort options.
- Sort
Filter Default - A default value for a sort filter.
- Stepper
Setting - A numeric stepper control.
- Text
Filter - A text field.
- Text
Setting - A text input field.
- Toggle
Setting - A toggle switch.
Enums§
- Content
Rating - The content rating of a manga.
- Deep
Link Result - A result of a deep link handling.
- Filter
Kind - The kind of filter.
- Filter
Value - A configured filter value.
- Home
Component Value - The value of a component for a home layout.
- Home
Partial Result - A partial result for the home page.
- Link
Value - A link value that can be opened by the Aidoku app.
- Listing
Kind - The display type of a listing.
- Login
Method - A login method.
- Manga
Status - The publishing status of a manga.
- Page
Content - The content of a page.
- Page
Icon - Setting
Value - The kind of setting.
- Update
Strategy - The preferred update strategy for a manga.
- Viewer
- The proper reading viewer for a manga.
Traits§
- Alternate
Cover Provider - A source that provides multiple cover images.
- Base
UrlProvider - A source that provides a programmatic base url.
- Basic
Login Handler - A source that handles basic login with username and password.
- Deep
Link Handler - A source that handles deep links.
- Dynamic
Filters - A source that provides dynamic filters.
- Dynamic
Listings - A source that provides dynamic listings.
- Dynamic
Settings - A source that provides dynamic settings.
- Home
- A source that provides a home layout.
- Image
Request Provider - A source that provides requests for images.
- Listing
Provider - A source that provides listings.
- Migration
Handler - A source that handles key migration.
- Notification
Handler - A source that handles notification callbacks.
- Page
Description Provider - A source that provides dynamic descriptions for pages.
- Page
Image Processor - A source that processes page image data after being fetched.
- Source
- The required functions an Aidoku source must implement.
- WebLogin
Handler - A source that handles custom webview login.
Type Aliases§
- Page
Context - Context associated with a page.