Skip to main content

Crate use_document_path

Crate use_document_path 

Source
Expand description

§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

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);

§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.

Structs§

DocumentPath
A validated or raw document path such as profile.display_name.
FieldSelector
A field selector label for extracting document fields.
PathSegment
One segment inside a dot-separated document path.

Enums§

PathParseError
Error returned when a document dot-path is invalid.