odcs 0.5.0

Reference implementation of the Open Data Contract Standard (ODCS)
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

# Public API

Rust API reference for the `odcs` crate. Generated API docs: [docs.rs/odcs](https://docs.rs/odcs).

User guides: [../user/rust.md](../user/rust.md) · [API decision guide](../user/api-guide.md).

## Parse and validate

```rust
use odcs::{parse, parse_file, parse_and_validate, validate, DocumentFormat};

// From bytes
let result = parse(yaml_bytes, DocumentFormat::Yaml);

// From file path
let result = parse_file("contract.odcs.yaml")?;

// Parse + validate in one step
let report = parse_and_validate(yaml_bytes, DocumentFormat::Yaml);
assert!(report.is_valid());
```

## ParseResult

```rust
let result = parse(content, DocumentFormat::Yaml);

// Parsed contract (fails if parse or validation errors)
let contract = result.into_contract()?;

// Validation only (consumes result)
let report = result.validate();

// Parse report only
let parse_ok = result.report.is_valid();
```

`into_contract()` requires both successful parsing **and** validation.

## Validate a contract

```rust
use odcs::validate;

let report = validate(&contract);
if !report.is_valid() {
    for d in &report.diagnostics {
        eprintln!("{}: {}", d.id, d.message);
    }
}
```

## DataContract helpers

```rust
use odcs::DataContract;

let result = DataContract::from_yaml(yaml_text);
let result = DataContract::from_json(json_text);
let result = DataContract::from_file("contract.odcs.yaml")?;
```

## Key types

| Type | Purpose |
|------|---------|
| `DataContract` | Root canonical object model |
| `ParseResult` | `{ contract, report }` from parsing |
| `DiagnosticReport` | Collection of `Diagnostic` records |
| `Diagnostic` | Single error/warning with `id`, `severity`, `message`, … |
| `DocumentFormat` | `Yaml` or `Json` |

## Diagnostic codes

Exported as `odcs::codes::*`. See [../user/diagnostics.md](../user/diagnostics.md).

## Constants

```rust
use odcs::UPSTREAM_SPEC_VERSION; // "3.1.0"
```

## Features

| Feature | Default | Description |
|---------|---------|-------------|
| `cli` | yes | `odcs` binary |
| `python` | no | PyO3 bindings (used by maturin) |

```toml
odcs = { version = "0.5", default-features = false }
```

## Python equivalent

See [../user/python.md](../user/python.md).

Keep this API parallel to `dtcs` where practical.