Skip to content

doc: make Stack and StackElement a little pretty #71767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 3, 2020
Merged

doc: make Stack and StackElement a little pretty #71767

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad46044
doc: make Stack and StackElement a little pretty
tshepang May 1, 2020
3406b53
Update src/libserialize/json.rs
tshepang May 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/libserialize/json.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1417,16 +1417,18 @@ enum ParserState {

/// A Stack represents the current position of the parser in the logical
/// structure of the JSON stream.
/// For example foo.bar[3].x
///
/// An example is `foo.bar[3].x`.
pub struct Stack {
stack: Vec<InternalStackElement>,
str_buffer: Vec<u8>,
}

/// StackElements compose a Stack.
/// For example, StackElement::Key("foo"), StackElement::Key("bar"),
/// StackElement::Index(3) and StackElement::Key("x") are the
/// StackElements compositing the stack that represents foo.bar[3].x
///
/// As an example, `StackElement::Key("foo")`, `StackElement::Key("bar")`,
/// `StackElement::Index(3)`, and `StackElement::Key("x")` are the
/// StackElements composing the stack that represents `foo.bar[3].x`.
#[derive(PartialEq, Clone, Debug)]
pub enum StackElement<'l> {
Index(u32),
Expand Down