# bookclerk_library::entities::user_title_state

SeaORM entity for the `user_title_state` table.

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | One user's own state for one work: finished flag, ratings and tags. |
| [`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 unless FK edges are modeled). |

## Structs

### Model

```rust
pub struct Model {
    pub user_id: i64,
    pub work_id: String,
    pub is_finished: i64,
    pub rating_overall: Option<f64>,
    pub rating_performance: Option<f64>,
    pub rating_story: Option<f64>,
    pub tags: Option<String>,
    pub updated_at: String,
}
```

One user's own state for one work: finished flag, ratings and tags.

**Fields**

- `user_id`: The user (`users.id`) the state belongs to.
- `work_id`: The work (`works.id`) the state is about.
- `is_finished`: `1` once the user finished the work, else `0`.
- `rating_overall`: The user's overall rating (storefront scale, 0 to 5), when given.
- `rating_performance`: The user's narration rating (0 to 5), when given.
- `rating_story`: The user's story rating (0 to 5), when given.
- `tags`: The user's tags, as one serialized string, when any.
- `updated_at`: RFC 3339 time of the last write.

#### Model::into_ex

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

Generated by sea-orm-macros

Implements: `Clone`, `Debug`, `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 work_id: ActiveValue<String>,
    pub is_finished: ActiveValue<i64>,
    pub rating_overall: ActiveValue<Option<f64>>,
    pub rating_performance: ActiveValue<Option<f64>>,
    pub rating_story: ActiveValue<Option<f64>>,
    pub tags: ActiveValue<Option<String>>,
    pub updated_at: ActiveValue<String>,
}
```

Generated by sea-orm-macros

**Fields**

- `user_id`: Generated by sea-orm-macros
- `work_id`: Generated by sea-orm-macros
- `is_finished`: Generated by sea-orm-macros
- `rating_overall`: Generated by sea-orm-macros
- `rating_performance`: Generated by sea-orm-macros
- `rating_story`: Generated by sea-orm-macros
- `tags`: 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,
    WorkId,
    IsFinished,
    RatingOverall,
    RatingPerformance,
    RatingStory,
    Tags,
    UpdatedAt,
}
```

Generated by sea-orm-macros

**Variants**

- `UserId`: Generated by sea-orm-macros
- `WorkId`: Generated by sea-orm-macros
- `IsFinished`: Generated by sea-orm-macros
- `RatingOverall`: Generated by sea-orm-macros
- `RatingPerformance`: Generated by sea-orm-macros
- `RatingStory`: Generated by sea-orm-macros
- `Tags`: 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,
    WorkId,
}
```

Generated by sea-orm-macros

**Variants**

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

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

### Relation

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

Declared SeaORM relations (none unless FK edges are modeled).

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