Crate endjine 

endjine

A Rust crate for accessing the Engine DJ library database.

Development

Getting Started

1. Install Rust
2. Install Python as a prerequisite for pre-commit
3. cargo install just
4. git clone --origin upstream git@github.com:uklotzde/endjine.git
5. cd endjine
6. just setup
7. just

If you plan to contribute then fork this repo on GitHub and add your fork as a remote named origin.

Examples

See the examples/ directory for more usage examples.

Housekeeping

!!! ONLY USE THIS ON A COPY OF YOUR LIBRARY FILE !!!

RUST_LOG=info cargo run --release --example housekeeping /my-playground/Engine Library/Database2/m.db

Naming

A phonetic wordplay and merge of the two words “Engine” and “DJ”.

License

Licensed under the Mozilla Public License 2.0 (MPL-2.0) (see MPL-2.0.txt or https://www.mozilla.org/MPL/2.0/).

Permissions of this copyleft license are conditioned on making available source code of licensed files and modifications of those files under the same license (or in certain cases, one of the GNU licenses). Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. However, a larger work using the licensed work may be distributed under different terms and without source code for files added in the larger work.

Contribution

Any contribution intentionally submitted for inclusion in the work by you shall be licensed under the Mozilla Public License 2.0 (MPL-2.0).

It is required to add the following header with the corresponding SPDX short identifier to the top of each file:

// SPDX-License-Identifier: MPL-2.0

Re-exports

pub use self::batch::BatchOutcome;

Modules

batch

Macros

db_id

Macro for defining type-safe database ID wrappers for SQLx.

db_uuid

Macro for defining type-safe database UUID wrappers for SQLx.

Structs

AlbumArt

AlbumArtId

ChangeLog

ChangeLogId

DbUuid

Historylist

HistorylistEntity

Entry in a Historylist.

HistorylistEntityId

HistorylistId

Information

Database information.

InformationId

Pack

PackId

PackUuid

PerformanceData

PerformanceDataId

Playlist

PlaylistAllChildren

PlaylistAllChildrenId

PlaylistAllParent

PlaylistAllParentId

PlaylistEntity

Entry in a Playlist.

PlaylistEntityId

PlaylistId

PlaylistPath

PlaylistPathId

PreparelistEntity

Entry in the Preparelist.

PreparelistEntityId

Smartlist

SmartlistRules

SmartlistRulesItem

SmartlistUuid

Track

TrackId

UnixTimestamp

UNIX timestamp.

Enums

AlbumArtImageQuality

SmartlistRulesMatch

Constants

SCHEMA_VERSION_MAJOR

Latest schema major version.

SCHEMA_VERSION_MINOR

Latest schema minor version.

Functions

open_database

optimize_database