use-document-path 0.1.0

Document path primitives for RustUse NoSQL data modeling
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

# use-document-path

Document path primitives for `RustUse` NoSQL-style data modeling.

## Experimental

`use-document-path` is experimental while `use-nosql` remains below `0.3.0`.

## Example

```rust
use use_document_path::{DocumentPath, PathParseError};

let path = DocumentPath::try_new("profile.display_name")?;
let segments = path.segments()?;

assert_eq!(path.as_str(), "profile.display_name");
assert_eq!(segments.len(), 2);
# Ok::<(), PathParseError>(())
```

## Scope

- Dot-path strings such as `profile.display_name`.
- Path segment and field selector labels.
- Conservative path parsing errors.

## Non-goals

- JSON Pointer implementation.
- JSON document parsing.
- Database-specific path syntax.

## License

Licensed under either Apache-2.0 or MIT.