[Variant] Add documentation, tests and cleaner api for Variant::get_path #7942
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,18 +16,77 @@ | |
| // under the License. | ||
| use std::{borrow::Cow, ops::Deref}; | ||
|
|
||
| /// Represents a qualified path to a potential subfield or index of a variant | ||
| /// value. | ||
| /// | ||
| /// Can be used with [`Variant::get_path`] to retrieve a specific subfield of | ||
| /// a variant value. | ||
| /// | ||
| /// [`Variant::get_path`]: crate::Variant::get_path | ||
| /// | ||
| /// Create a [`VariantPath`] from a vector of [`VariantPathElement`], or | ||
| /// from a single field name or index. | ||
| /// | ||
| /// # Example: Simple paths | ||
| /// ```rust | ||
| /// # use parquet_variant::{VariantPath, VariantPathElement}; | ||
| /// // access the field "foo" in a variant object value | ||
| /// let path = VariantPath::from("foo"); | ||
| /// // access the first element in a variant list vale | ||
| /// let path = VariantPath::from(0); | ||
| /// ``` | ||
| /// | ||
| /// # Example: Compound paths | ||
| /// ``` | ||
| /// # use parquet_variant::{VariantPath, VariantPathElement}; | ||
| /// /// You can also create a path by joining elements together: | ||
| /// // access the field "foo" and then the first element in a variant list value | ||
| /// let path = VariantPath::from("foo").join(0); | ||
| /// // this is the same as the previous one | ||
| /// let path2 = VariantPath::new(vec!["foo".into(), 0.into()]); | ||
| /// assert_eq!(path, path2); | ||
| /// // you can also create a path from a vector of `VariantPathElement` directly | ||
| /// let path3 = VariantPath::new(vec![ | ||
| /// VariantPathElement::field("foo"), | ||
| /// VariantPathElement::index(0) | ||
| /// ]); | ||
|
Comment on lines
+49
to
+52
Contributor
There was a problem hiding this comment. Should it also VariantPath::from_iter(["foo".into(), 0.into()])or ["foo".into(), 0.into()].into_iter().collect::<VariantPath>()
Contributor
Author
There was a problem hiding this comment.
|
||
| /// assert_eq!(path, path3); | ||
| /// ``` | ||
| /// | ||
| /// # Example: Accessing Compound paths | ||
| /// ``` | ||
| /// # use parquet_variant::{VariantPath, VariantPathElement}; | ||
| /// /// You can access the paths using slices | ||
| /// // access the field "foo" and then the first element in a variant list value | ||
| /// let path = VariantPath::from("foo") | ||
| /// .join("bar") | ||
| /// .join("baz"); | ||
| /// assert_eq!(path[1], VariantPathElement::field("bar")); | ||
| /// ``` | ||
| #[derive(Debug, Clone, PartialEq)] | ||
| pub struct VariantPath<'a>(Vec<VariantPathElement<'a>>); | ||
|
|
||
| impl<'a> VariantPath<'a> { | ||
| /// Create a new `VariantPath` from a vector of `VariantPathElement`. | ||
| pub fn new(path: Vec<VariantPathElement<'a>>) -> Self { | ||
| Self(path) | ||
| } | ||
|
|
||
| /// Return the inner path elements. | ||
| pub fn path(&self) -> &Vec<VariantPathElement> { | ||
| &self.0 | ||
| } | ||
|
|
||
| /// Return a new `VariantPath` with element appended | ||
| pub fn join(mut self, element: impl Into<VariantPathElement<'a>>) -> Self { | ||
| self.push(element); | ||
| self | ||
| } | ||
|
|
||
| /// Append a new element to the path | ||
| pub fn push(&mut self, element: impl Into<VariantPathElement<'a>>) { | ||
| self.0.push(element.into()); | ||
| } | ||
| } | ||
|
|
||
| impl<'a> From<Vec<VariantPathElement<'a>>> for VariantPath<'a> { | ||
|
|
@@ -36,6 +95,20 @@ impl<'a> From<Vec<VariantPathElement<'a>>> for VariantPath<'a> { | |
| } | ||
| } | ||
|
|
||
| /// Create from &str | ||
| impl<'a> From<&'a str> for VariantPath<'a> { | ||
| fn from(path: &'a str) -> Self { | ||
| VariantPath::new(vec![path.into()]) | ||
| } | ||
| } | ||
|
|
||
| /// Create from usize | ||
| impl<'a> From<usize> for VariantPath<'a> { | ||
| fn from(index: usize) -> Self { | ||
| VariantPath::new(vec![VariantPathElement::index(index)]) | ||
| } | ||
| } | ||
|
|
||
| impl<'a> Deref for VariantPath<'a> { | ||
| type Target = [VariantPathElement<'a>]; | ||
|
|
||
|
|
@@ -44,8 +117,10 @@ impl<'a> Deref for VariantPath<'a> { | |
| } | ||
| } | ||
|
|
||
| /// Element of a [`VariantPath`] that can be a field name or an index. | ||
| /// | ||
| /// See [`VariantPath`] for more details and examples. | ||
| #[derive(Debug, Clone, PartialEq)] | ||
| pub enum VariantPathElement<'a> { | ||
| /// Access field with name `name` | ||
| Field { name: Cow<'a, str> }, | ||
|
|
@@ -54,11 +129,43 @@ pub enum VariantPathElement<'a> { | |
| } | ||
|
|
||
| impl<'a> VariantPathElement<'a> { | ||
| pub fn field(name: impl Into<Cow<'a, str>>) -> VariantPathElement<'a> { | ||
| let name = name.into(); | ||
| VariantPathElement::Field { name } | ||
| } | ||
|
|
||
| pub fn index(index: usize) -> VariantPathElement<'a> { | ||
| VariantPathElement::Index { index } | ||
| } | ||
| } | ||
|
|
||
| // Conversion utilities for `VariantPathElement` from string types | ||
| impl<'a> From<Cow<'a, str>> for VariantPathElement<'a> { | ||
| fn from(name: Cow<'a, str>) -> Self { | ||
| VariantPathElement::field(name) | ||
| } | ||
| } | ||
|
|
||
| impl<'a> From<&'a str> for VariantPathElement<'a> { | ||
| fn from(name: &'a str) -> Self { | ||
| VariantPathElement::field(Cow::Borrowed(name)) | ||
| } | ||
| } | ||
|
|
||
| impl<'a> From<String> for VariantPathElement<'a> { | ||
| fn from(name: String) -> Self { | ||
| VariantPathElement::field(Cow::Owned(name)) | ||
| } | ||
| } | ||
|
|
||
| impl<'a> From<&'a String> for VariantPathElement<'a> { | ||
| fn from(name: &'a String) -> Self { | ||
| VariantPathElement::field(Cow::Borrowed(name.as_str())) | ||
| } | ||
| } | ||
|
|
||
| impl<'a> From<usize> for VariantPathElement<'a> { | ||
| fn from(index: usize) -> Self { | ||
| VariantPathElement::index(index) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I re-exported the paths at the same top level