pulith-resource 0.1.0

Composable resource description types for Pulith
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

# pulith-resource

Semantic resource description types.

## Role

`pulith-resource` defines what a managed thing is.

It owns:

- resource identity
- locators
- version selectors
- trust/provenance-facing metadata types

## Main APIs

- `ResourceId`
- `ResourceSpec`
- `RequestedResource`
- `ResolvedResource`
- `VersionSelector`
- `ValidUrl`

## Basic Usage

```rust
use pulith_resource::{RequestedResource, ResourceId, ResourceLocator, ResourceSpec, VersionSelector, ValidUrl};

let requested = RequestedResource::new(
    ResourceSpec::new(
        ResourceId::parse("example/runtime")?,
        ResourceLocator::Url(ValidUrl::parse("https://example.com/runtime.zip")?),
    )
    .version(VersionSelector::alias("stable")?),
);
# Ok::<(), pulith_resource::ResourceError>(())
```

## How To Use It

Most composed flows begin here.

Use this crate to define the semantic identity and version intent that later crates will preserve across planning, storage, install, and state.

See `docs/design/resource.md`.