Struct DocumentPath 

pub struct DocumentPath(/* private fields */);

A validated or raw document path such as profile.display_name.

Implementations

impl DocumentPath

pub fn new(value: impl Into<String>) -> Self

Creates a new string-backed primitive.

pub fn as_str(&self) -> &str

Returns the stored string value.

impl DocumentPath

pub fn try_new(value: impl AsRef<str>) -> Result<Self, PathParseError>

Creates a document path after validating dot-path structure.

pub fn segments(&self) -> Result<Vec<PathSegment>, PathParseError>

Parses the path into individual segments.

Trait Implementations

impl AsRef<str> for DocumentPath

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DocumentPath

fn clone(&self) -> DocumentPath

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocumentPath

fn default() -> DocumentPath

Returns the “default value” for a type.

impl Display for DocumentPath

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for DocumentPath

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for DocumentPath

fn from(value: String) -> Self

Converts to this type from the input type.

impl FromStr for DocumentPath

type Err = PathParseError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DocumentPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DocumentPath

fn cmp(&self, other: &DocumentPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DocumentPath

fn eq(&self, other: &DocumentPath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DocumentPath

fn partial_cmp(&self, other: &DocumentPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for DocumentPath

impl StructuralPartialEq for DocumentPath