display-types 0.4.0

Shared display capability types for display connection negotiation.
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

# display-types

[![CI](https://github.com/DracoWhitefire/display-types/actions/workflows/ci.yml/badge.svg)](https://github.com/DracoWhitefire/display-types/actions/workflows/ci.yml)
[![crates.io](https://img.shields.io/crates/v/display-types.svg)](https://crates.io/crates/display-types)
[![docs.rs](https://docs.rs/display-types/badge.svg)](https://docs.rs/display-types)
[![License: MPL-2.0](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)
[![Rust 1.85+](https://img.shields.io/badge/rustc-1.85+-orange.svg)](https://blog.rust-lang.org/2025/02/20/Rust-1.85.0.html)
[![SLSA Level 2](https://slsa.dev/images/gh-badge-level2.svg)](https://slsa.dev)

Shared display capability types for display connection negotiation.

This crate provides [`DisplayCapabilities`] and all its supporting types —
the stable, typed model that EDID/DisplayID parsers produce and negotiation
engines consume. It is the shared vocabulary between
[piaf](https://crates.io/crates/piaf) (the parser) and
[concordance](https://crates.io/crates/concordance) (the negotiation engine),
and is suitable for any crate that needs to describe display capabilities without
taking a dependency on a full parser.

## Feature flags

| Flag    | Default | Description                                                               |
|---------|---------|---------------------------------------------------------------------------|
| `std`   | yes     | Enables `std`-dependent types; implies `alloc`.                           |
| `alloc` | no      | Enables heap-allocated types (`Vec`, `Arc`, `String`) without full `std`. |
| `serde` | no      | Derives `Serialize`/`Deserialize` for all public types.                   |

With neither `std` nor `alloc` the crate compiles in bare `no_std` mode and
exposes only the scalar types (enums and copy structs).

## Usage

```sh
cargo add display-types
```

For `no_std` with heap allocation (e.g. embedded with an allocator):

```sh
cargo add display-types --no-default-features --features alloc
```

For bare `no_std` (scalars only):

```sh
cargo add display-types --no-default-features
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and [doc/setup.md](doc/setup.md)
for build and test instructions.

## Verifying releases

Each release is built on GitHub Actions and attested with
[SLSA Build Level 2](https://slsa.dev) provenance. To verify a release
`.crate` against its signed provenance, install the
[GitHub CLI](https://cli.github.com/) and run:

```sh
gh attestation verify display-types-X.Y.Z.crate --repo DracoWhitefire/display-types
```

The attested `.crate` is attached to each
[GitHub release](https://github.com/DracoWhitefire/display-types/releases).

## License

Licensed under the [Mozilla Public License 2.0](LICENSE).