moosicbox_scan_models 0.4.0

MoosicBox scan models package
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# MoosicBox Scan Models

Data models for music library scanning and indexing operations.

## Overview

The MoosicBox Scan Models package provides:

- **API Integration**: REST-compatible scan data models

## Features

Currently implemented:

- `ApiScanPath`: Model for representing scan paths in API requests

## Installation

Add this to your Cargo.toml:

```toml
[dependencies]
moosicbox_scan_models = { path = "../scan/models" }
```

Enable optional features:

```toml
[dependencies]
moosicbox_scan_models = { path = "../scan/models", features = ["openapi"] }
```

Available features:

- `api`: API models (enabled by default)
- `openapi`: OpenAPI schema support via utoipa (enabled by default)

## Usage

The primary API model is `ApiScanPath` in the `api` module:

```rust
use moosicbox_scan_models::api::ApiScanPath;

let scan_path = ApiScanPath {
    path: "/music".to_string(),
};
```

## Dependencies

- **Serde**: Serialization and deserialization
- **log**: Logging facade
- **moosicbox_assert**: Assertion utilities
- **utoipa**: OpenAPI schema generation (optional, enabled with `openapi` feature)