# bookclerk_library::entities::users

SeaORM entity for the `users` table entity — first-party identity principal (#117).

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | Row shape for this table (`DeriveEntityModel`). |
| [`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 id: i64,
    pub role: String,
    pub status: String,
    pub display_name: Option<String>,
    pub login_name: Option<String>,
    pub email: Option<String>,
    pub password_hash: Option<String>,
    pub security_version: i64,
    pub created_at: String,
    pub updated_at: String,
    pub last_seen_at: Option<String>,
    pub avatar_source: Option<String>,
    pub totp_enabled: i64,
}
```

Row shape for this table (`DeriveEntityModel`).

**Fields**

- `id`: Surrogate primary key assigned by the database.
- `role`: First-party role (`owner`, `administrator`, or `member`).
- `status`: Lifecycle status for the row (user, request, …).
- `display_name`: Human-readable name shown in the UI.
- `login_name`: Local username for password login, when set.
- `email`: Optional contact email for invites / notifications.
- `password_hash`: Argon2id PHC hash for local login; never plaintext.
- `security_version`: Incremented to invalidate existing sessions after security changes.
- `created_at`: RFC 3339 timestamp when the row was inserted.
- `updated_at`: RFC 3339 timestamp when the row was last modified.
- `last_seen_at`: RFC 3339 time of the last authenticated portal use; survives logout.
- `avatar_source`: Selected picture source (`monogram`, `gravatar`, `upload`, `sso:{id}`); `NULL` is auto.
- `totp_enabled`: `1` when a TOTP authenticator has been confirmed for this user.

#### 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 id: ActiveValue<i64>,
    pub role: ActiveValue<String>,
    pub status: ActiveValue<String>,
    pub display_name: ActiveValue<Option<String>>,
    pub login_name: ActiveValue<Option<String>>,
    pub email: ActiveValue<Option<String>>,
    pub password_hash: ActiveValue<Option<String>>,
    pub security_version: ActiveValue<i64>,
    pub created_at: ActiveValue<String>,
    pub updated_at: ActiveValue<String>,
    pub last_seen_at: ActiveValue<Option<String>>,
    pub avatar_source: ActiveValue<Option<String>>,
    pub totp_enabled: ActiveValue<i64>,
}
```

Generated by sea-orm-macros

**Fields**

- `id`: Generated by sea-orm-macros
- `role`: Generated by sea-orm-macros
- `status`: Generated by sea-orm-macros
- `display_name`: Generated by sea-orm-macros
- `login_name`: Generated by sea-orm-macros
- `email`: Generated by sea-orm-macros
- `password_hash`: Generated by sea-orm-macros
- `security_version`: Generated by sea-orm-macros
- `created_at`: Generated by sea-orm-macros
- `updated_at`: Generated by sea-orm-macros
- `last_seen_at`: Generated by sea-orm-macros
- `avatar_source`: Generated by sea-orm-macros
- `totp_enabled`: 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 {
    Id,
    Role,
    Status,
    DisplayName,
    LoginName,
    Email,
    PasswordHash,
    SecurityVersion,
    CreatedAt,
    UpdatedAt,
    LastSeenAt,
    AvatarSource,
    TotpEnabled,
}
```

Generated by sea-orm-macros

**Variants**

- `Id`: Generated by sea-orm-macros
- `Role`: Generated by sea-orm-macros
- `Status`: Generated by sea-orm-macros
- `DisplayName`: Generated by sea-orm-macros
- `LoginName`: Generated by sea-orm-macros
- `Email`: Generated by sea-orm-macros
- `PasswordHash`: Generated by sea-orm-macros
- `SecurityVersion`: Generated by sea-orm-macros
- `CreatedAt`: Generated by sea-orm-macros
- `UpdatedAt`: Generated by sea-orm-macros
- `LastSeenAt`: Generated by sea-orm-macros
- `AvatarSource`: Generated by sea-orm-macros
- `TotpEnabled`: Generated by sea-orm-macros

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

### PrimaryKey

```rust
pub enum PrimaryKey {
    Id,
}
```

Generated by sea-orm-macros

**Variants**

- `Id`: 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`
