displaydoc 0.2.7: displaydoc

# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 4

[[package]]
name = "displaydoc"
version = "0.2.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8"
dependencies = [
 "proc-macro2",
 "quote",
 "syn",
]

[[package]]
name = "proc-macro2"
version = "1.0.107"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
dependencies = [
 "unicode-ident",
]

[[package]]
name = "quote"
version = "1.0.47"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
dependencies = [
 "proc-macro2",
]

[[package]]
name = "sample-displaydoc"
version = "1.0.0"
dependencies = [
 "displaydoc",
]

[[package]]
name = "syn"
version = "3.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8593e8e72159ed2257d083c7a454a85cbf854f37a0966d8d483aff8c8a3ebcee"
dependencies = [
 "proc-macro2",
 "quote",
 "unicode-ident",
]

[[package]]
name = "unicode-ident"
version = "1.0.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954"

[package]
name = "sample-displaydoc"
version = "1.0.0"
edition = "2021"
publish = false

[dependencies]
displaydoc = "=0.2.7"

[[bin]]
name = "contract"
path = "test/contract.rs"

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify displaydoc in pkg:cargo/displaydoc@0.2.7
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:cargo/displaydoc@0.2.7
Demonstrate these symbols/APIs:
  - displaydoc

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:0d690b96dc43103a50639ff2575681ce611dd039e10ea870d7e9289a97557cb1","contract":["displaydoc derive macro generates Display implementation using doc comments on enums","displaydoc supports interpolation of named fields and tuple index fields with format specifiers","displaydoc derive macro generates Display implementation for structs with doc comments","displaydoc prefix_enum_doc_attributes combines enum doc comment with variant doc comments","displaydoc displaydoc attribute overrides doc comments for custom display messages"],"goal":"verify displaydoc in pkg:cargo/displaydoc@0.2.7","kind":"HOW","packages":["pkg:cargo/displaydoc@0.2.7"],"schemaVersion":1,"symbols":["displaydoc"]},"contractCommand":["cargo","run","--offline"],"environment":{"arch":"x64","distro":"alpine","ecosystem":"cargo","libc":"musl","os":"linux","packageManager":"cargo","schemaVersion":1},"license":"MIT-0","packages":["pkg:cargo/displaydoc@0.2.7"],"schemaVersion":1,"subject":"pkg:cargo/displaydoc@0.2.7","symbols":["displaydoc"],"verifierAdapter":"cargo@1"}

{
  "schemaVersion": 1,
  "goal": "verify displaydoc in pkg:cargo/displaydoc@0.2.7",
  "kind": "HOW",
  "packages": [
    "pkg:cargo/displaydoc@0.2.7"
  ],
  "symbols": [
    "displaydoc"
  ]
}

//! Clean-room verification sample for displaydoc.

pub use displaydoc::*;

use displaydoc::Display;

// 1. displaydoc derive macro generates Display implementation using doc comments on enums
#[derive(Display, Debug, PartialEq)]
enum StatusMessage {
    /// service is running normally
    Running,
    /// service paused
    Paused,
}

// 2. displaydoc supports interpolation of named fields and tuple index fields with format specifiers
#[derive(Display, Debug, PartialEq)]
enum DataEvent {
    /// event id {id}: status {code:#x}
    Named { id: u32, code: u16 },
    /// message "{0}" with retry count {1}
    Positional(String, usize),
    /// item debug view: {item:?}
    DebugFormatted { item: Option<u32> },
}

// 3. displaydoc derive macro generates Display implementation for structs with doc comments
/// record key: {key}
#[derive(Display, Debug, PartialEq)]
struct Record {
    key: String,
}

/// wrapper payload: {0}
#[derive(Display, Debug, PartialEq)]
struct Wrapper<T>(T);

// 4. displaydoc prefix_enum_doc_attributes combines enum doc comment with variant doc comments
/// storage failure
#[derive(Display, Debug, PartialEq)]
#[prefix_enum_doc_attributes]
enum StorageError {
    /// disk is full
    DiskFull,
    /// device unreachable: {0}
    DeviceUnreachable(String),
}

// 5. displaydoc displaydoc attribute overrides doc comments for custom display messages
#[derive(Display, Debug, PartialEq)]
enum ConfigError {
    /// default doc comment to ignore
    #[displaydoc("overridden error message: missing key '{0}'")]
    MissingKey(String),
}

fn main() {
    // 1. Enum variants with doc comments
    assert_eq!(StatusMessage::Running.to_string(), "service is running normally");
    assert_eq!(StatusMessage::Paused.to_string(), "service paused");

    // 2. Interpolation of named fields, positional fields, and debug format specifiers
    let named = DataEvent::Named { id: 101, code: 0x2a };
    assert_eq!(named.to_string(), "event id 101: status 0x2a");

    let pos = DataEvent::Positional("connecting".to_string(), 3);
    assert_eq!(pos.to_string(), "message \"connecting\" with retry count 3");

    let debug_fmt = DataEvent::DebugFormatted { item: Some(42) };
    assert_eq!(debug_fmt.to_string(), "item debug view: Some(42)");

    // 3. Structs with doc comments
    let rec = Record { key: "alpha".to_string() };
    assert_eq!(rec.to_string(), "record key: alpha");

    let wrap = Wrapper(999);
    assert_eq!(wrap.to_string(), "wrapper payload: 999");

    // 4. prefix_enum_doc_attributes combining enum doc with variant doc
    let disk_err = StorageError::DiskFull;
    assert_eq!(disk_err.to_string(), "storage failure: disk is full");

    let dev_err = StorageError::DeviceUnreachable("sda1".to_string());
    assert_eq!(dev_err.to_string(), "storage failure: device unreachable: sda1");

    // 5. displaydoc attribute override
    let cfg_err = ConfigError::MissingKey("port".to_string());
    assert_eq!(cfg_err.to_string(), "overridden error message: missing key 'port'");

    println!("All displaydoc contract assertions passed successfully.");
}