dogma 0.1.11

Provides `Named`, `MaybeNamed`, `Labeled`, `MaybeLabeled`, `Collection`, and `CollectionMut` traits.
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

# Dogma.rs

[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
[![Compatibility](https://img.shields.io/badge/rust-1.70%2B-blue)](https://rust-lang.org)
[![Package](https://img.shields.io/crates/v/dogma)](https://crates.io/crates/dogma)
[![Documentation](https://docs.rs/dogma/badge.svg)](https://docs.rs/dogma/)

Provides the `Named`, `MaybeNamed`, `Labeled`, `MaybeLabeled`, `Collection`,
and `CollectionMut` traits for Rust.

## ✨ Features

- Supports opting out of any feature using comprehensive [feature flags].
- Adheres to the Rust API Guidelines in its [naming conventions].
- 100% free and unencumbered public domain software.

## 🛠️ Prerequisites

- [Rust](https://rust-lang.org) 1.70+

## ⬇️ Installation

### Installation via Cargo

```bash
cargo add dogma
```

### Installation in `Cargo.toml` (with all features enabled)

```toml
[dependencies]
dogma = "0.1"
```

### Installation in `Cargo.toml` (with only specific features enabled)

```toml
[dependencies]
dogma = { version = "0.1", default-features = false, features = ["traits"] }
```

## 👉 Examples

### Importing the library

```rust
use dogma::*;
```

### Using the `Named` trait

```rust
use dogma::traits::Named;
use std::borrow::Cow;

struct Person {
    pub first_name: String,
    pub last_name: String,
}

impl Named for Person {
    fn name(&self) -> Cow<str> {
        format!("{} {}", self.first_name, self.last_name).into()
    }
}
```

### Using the `MaybeNamed` trait

```rust
use dogma::traits::MaybeNamed;
use std::borrow::Cow;

struct UserProfile {
    pub id: u64,
    pub display_name: Option<String>,
}

impl MaybeNamed for UserProfile {
    fn name(&self) -> Option<Cow<str>> {
        self.display_name.as_ref().map(Cow::from)
    }
}
```

## 📚 Reference

https://docs.rs/dogma/

### Traits

- [`Collection`], [`CollectionMut`]
- [`Countable`], [`MaybeCountable`]
- [`Named`], [`MaybeNamed`]
- [`Labeled`], [`MaybeLabeled`]

### Integrations

Crate (Feature) | Version | Usage | Summary
:--- | :--- | :--- | :---
[clap]] &nbsp;<sub>(`"clap"`)</sub> | 4.5 | [![clap](https://docs.rs/clap/badge.svg)](https://docs.rs/clap/) | Derives `clap::builder::TypedValueParser`
[miette] &nbsp;<sub>(`"miette"`)</sub> | 7.6 | [![miette](https://docs.rs/miette/badge.svg)](https://docs.rs/miette/) | Enhances `dogma::{IriError, UriError}`
[serde] &nbsp;<sub>(`"serde"`)</sub> | 1 | [![serde](https://docs.rs/serde/badge.svg)](https://docs.rs/serde/) | Derives `serde::{Serialize, Deserialize}`
<img width="220" height="1"/> | <img width="110" height="1"/> | <img width="100" height="1"/> | &nbsp;

## 👨‍💻 Development

```bash
git clone https://github.com/dogmatists/dogma.rs.git
```

---

[![Share on X](https://img.shields.io/badge/share%20on-x-03A9F4?logo=x)](https://x.com/intent/post?url=https://github.com/dogmatists/dogma.rs&text=Dogma.rs)
[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/dogmatists/dogma.rs&title=Dogma.rs)
[![Share on Hacker News](https://img.shields.io/badge/share%20on-hn-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/dogmatists/dogma.rs&t=Dogma.rs)
[![Share on Facebook](https://img.shields.io/badge/share%20on-fb-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/dogmatists/dogma.rs)
[![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/dogmatists/dogma.rs)

[feature flags]: https://github.com/dogmatists/dogma.rs/blob/master/lib/dogma/Cargo.toml
[naming conventions]: https://rust-lang.github.io/api-guidelines/naming.html

[clap]: https://crates.io/crates/clap
[miette]: https://crates.io/crates/miette
[serde]: https://crates.io/crates/serde

[`Collection`]: https://docs.rs/dogma/latest/dogma/traits/trait.Collection.html
[`CollectionMut`]: https://docs.rs/dogma/latest/dogma/traits/trait.CollectionMut.html
[`Countable`]: https://docs.rs/dogma/latest/dogma/traits/trait.Countable.html
[`Labeled`]: https://docs.rs/dogma/latest/dogma/traits/trait.Labeled.html
[`MaybeCountable`]: https://docs.rs/dogma/latest/dogma/traits/trait.MaybeCountable.html
[`MaybeLabeled`]: https://docs.rs/dogma/latest/dogma/traits/trait.MaybeLabeled.html
[`MaybeNamed`]: https://docs.rs/dogma/latest/dogma/traits/trait.MaybeNamed.html
[`Named`]: https://docs.rs/dogma/latest/dogma/traits/trait.Named.html