# bookclerk_library::entities::playback_progress

SeaORM entity for `playback_progress`: how far one person has listened
to one edition. Written by [`crate::LibraryStore`](/docs/internals/crates/bookclerk_library/index.md#librarystore)'s playback methods
(`store::playback`).

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | Row shape for one person's position in one edition. |
| [`ColumnIter`](#columniter) | struct | An iterator over the variants of [Column] |
| [`Entity`](#entity) | struct | Generated by sea-orm-macros |
| [`PrimaryKeyIter`](#primarykeyiter) | struct | An iterator over the variants of [PrimaryKey] |
| [`ActiveModel`](#activemodel) | struct | Generated by sea-orm-macros |
| [`RelationIter`](#relationiter) | struct | An iterator over the variants of [Relation] |
| [`Column`](#column) | enum | Generated by sea-orm-macros |
| [`PrimaryKey`](#primarykey) | enum | Generated by sea-orm-macros |
| [`Relation`](#relation) | enum | Declared SeaORM relations (none). |

## Structs

### Model

```rust
pub struct Model {
    pub user_id: i64,
    pub edition_id: String,
    pub position_ms: i64,
    pub duration_ms: Option<i64>,
    pub is_finished: i64,
    pub started_at: String,
    pub finished_at: Option<String>,
    pub updated_at: String,
}
```

Row shape for one person's position in one edition.

**Fields**

- `user_id`: The listener (`users.id`).
- `edition_id`: The edition (`editions.id`) the position is in.
- `position_ms`: Position on the edition's timeline, in milliseconds from its start.
- `duration_ms`: The edition's whole runtime in milliseconds as the last player
  reported it; `None` until one has.
- `is_finished`: `1` once the person reached the end of this edition, else `0`.
- `started_at`: RFC 3339 time the person first played the edition.
- `finished_at`: RFC 3339 time the person last reached the end; `None` until then.
- `updated_at`: RFC 3339 time of the last write; orders Continue listening.

#### Model::into_ex

```rust
pub fn into_ex(self) -> Self
```

Generated by sea-orm-macros

Implements: `Clone`, `Debug`, `Eq`, `From<Model>`, `FromQueryResult`, `IntoActiveModel<ActiveModel>`, `ModelTrait`, `PartialEq`, `TryFrom<ActiveModel>`, `TryIntoModel<Model>`

### ColumnIter

```rust
pub struct ColumnIter {
    /* private fields */
}
```

An iterator over the variants of [Column](#column)

Implements: `Clone`, `Debug`, `DoubleEndedIterator`, `ExactSizeIterator`, `FusedIterator`, `Iterator`

### Entity

```rust
pub struct Entity;
```

Generated by sea-orm-macros

Implements: `Clone`, `Copy`, `Debug`, `Default`, `EntityName`, `EntityTrait`, `Iden`, `IdenStatic`

### PrimaryKeyIter

```rust
pub struct PrimaryKeyIter {
    /* private fields */
}
```

An iterator over the variants of [PrimaryKey](#primarykey)

Implements: `Clone`, `Debug`, `DoubleEndedIterator`, `ExactSizeIterator`, `FusedIterator`, `Iterator`

### ActiveModel

```rust
pub struct ActiveModel {
    pub user_id: ActiveValue<i64>,
    pub edition_id: ActiveValue<String>,
    pub position_ms: ActiveValue<i64>,
    pub duration_ms: ActiveValue<Option<i64>>,
    pub is_finished: ActiveValue<i64>,
    pub started_at: ActiveValue<String>,
    pub finished_at: ActiveValue<Option<String>>,
    pub updated_at: ActiveValue<String>,
}
```

Generated by sea-orm-macros

**Fields**

- `user_id`: Generated by sea-orm-macros
- `edition_id`: Generated by sea-orm-macros
- `position_ms`: Generated by sea-orm-macros
- `duration_ms`: Generated by sea-orm-macros
- `is_finished`: Generated by sea-orm-macros
- `started_at`: Generated by sea-orm-macros
- `finished_at`: Generated by sea-orm-macros
- `updated_at`: Generated by sea-orm-macros

Implements: `ActiveModelBehavior`, `ActiveModelTrait`, `Clone`, `Debug`, `Default`, `From<Model>`, `IntoActiveModel<ActiveModel>`, `PartialEq`, `TryFrom<ActiveModel>`, `TryIntoModel<Model>`

### RelationIter

```rust
pub struct RelationIter {
    /* private fields */
}
```

An iterator over the variants of [Relation](#relation)

Implements: `Clone`, `Debug`, `DoubleEndedIterator`, `ExactSizeIterator`, `FusedIterator`, `Iterator`

## Enums

### Column

```rust
pub enum Column {
    UserId,
    EditionId,
    PositionMs,
    DurationMs,
    IsFinished,
    StartedAt,
    FinishedAt,
    UpdatedAt,
}
```

Generated by sea-orm-macros

**Variants**

- `UserId`: Generated by sea-orm-macros
- `EditionId`: Generated by sea-orm-macros
- `PositionMs`: Generated by sea-orm-macros
- `DurationMs`: Generated by sea-orm-macros
- `IsFinished`: Generated by sea-orm-macros
- `StartedAt`: Generated by sea-orm-macros
- `FinishedAt`: Generated by sea-orm-macros
- `UpdatedAt`: Generated by sea-orm-macros

Implements: `Clone`, `ColumnTrait`, `Copy`, `Debug`, `FromStr`, `Iden`, `IdenStatic`, `IntoEnumIterator`

### PrimaryKey

```rust
pub enum PrimaryKey {
    UserId,
    EditionId,
}
```

Generated by sea-orm-macros

**Variants**

- `UserId`: Generated by sea-orm-macros
- `EditionId`: Generated by sea-orm-macros

Implements: `Clone`, `Copy`, `Debug`, `Iden`, `IdenStatic`, `IntoEnumIterator`, `PrimaryKeyToColumn`, `PrimaryKeyTrait`

### Relation

```rust
pub enum Relation {}
```

Declared SeaORM relations (none).

Implements: `Clone`, `Copy`, `Debug`, `IntoEnumIterator`, `RelationTrait`
