Struct yaml_split::DocumentIterator

source · [−]
pub struct DocumentIterator<R>where
    R: Read,{ /* private fields */ }
Expand description

DocumentIterator is an iterator over individual YAML documents in a file or stream.

For example, the following YAML file contains two separate documents:

hello: world
---
hello: rust

The first item in this iterator will be:

hello: world

The second item will be (the “header” / directives end marker “—” is considered part of the document):

---
hello: rust

Each item’s output will be suitable for passing to serde-yaml, yaml-rust or similar libraries for parsing. Each item can also be an error, letting you opt for safe handling of errors when dealing with lots of files.

use std::fs::File;
use yaml_split::DocumentIterator;
let mut file = File::options()
    .create(true)
    .write(true)
    .open("test.yaml")
    .unwrap()
    .write(b"hello: world");

let read_file = File::open("test.yaml").unwrap();
let doc_iter = DocumentIterator::new(read_file);

for doc in doc_iter {
    println!("{}", doc.unwrap());
}

This also correctly handles less common areas of the YAML spec including directives, comments and document end markers.

use yaml_split::DocumentIterator;

let input = r#"

# a header comment
%YAML 1.2
---
hello: world
...
---
hello: rust
---
# a body comment
hello: everyone
"#;

let mut doc_iter = DocumentIterator::new(input.as_bytes());

assert_eq!(r#"

# a header comment
%YAML 1.2
---
hello: world
"#, doc_iter.next().unwrap().unwrap());
assert_eq!(r#"---
hello: rust
"#, doc_iter.next().unwrap().unwrap());
assert_eq!(r#"---
# a body comment
hello: everyone
"#, doc_iter.next().unwrap().unwrap());

Implementations

new() creates a new DocumentIterator over a given reader’s contents.

This reader can be a reader for a file:

use std::fs::File;
use yaml_split::DocumentIterator;
let mut file = File::options()
    .create(true)
    .write(true)
    .open("test.yml")
    .unwrap()
    .write(b"hello: world");

let read_file = File::open("test.yml").unwrap();
let doc_iter = DocumentIterator::new(read_file);

for doc in doc_iter {
    println!("{}", doc.unwrap());
}

Or the reader can be a simple byte array (useful for strings):

use yaml_split::DocumentIterator;
let yaml = r#"
hello: world
---
hello: rust
"#;

let mut doc_iter = DocumentIterator::new(yaml.as_bytes());

assert_eq!(r#"
hello: world
"#, doc_iter.next().unwrap().unwrap());
assert_eq!(r#"---
hello: rust
"#, doc_iter.next().unwrap().unwrap());
assert_eq!(true, doc_iter.next().is_none());

// or in a loop:
for doc in doc_iter {
    println!("{}", doc.unwrap());
}

Trait Implementations

The type of the elements being iterated over.
Advances the iterator and returns the next value. Read more
🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
Returns the bounds on the remaining length of the iterator. Read more
Consumes the iterator, counting the number of iterations and returning it. Read more
Consumes the iterator, returning the last element. Read more
🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
Returns the nth element of the iterator. Read more
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
Takes two iterators and creates a new iterator over both in sequence. Read more
‘Zips up’ two iterators into a single iterator of pairs. Read more
🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more
Takes a closure and creates an iterator which calls that closure on each element. Read more
Calls a closure on each element of an iterator. Read more
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
Creates an iterator that both filters and maps. Read more
Creates an iterator which gives the current iteration count as well as the next value. Read more
Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
Creates an iterator that skips elements based on a predicate. Read more
Creates an iterator that yields elements based on a predicate. Read more
Creates an iterator that both yields elements based on a predicate and maps. Read more
Creates an iterator that skips the first n elements. Read more
Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
An iterator adapter similar to fold that holds internal state and produces a new iterator. Read more
Creates an iterator that works like map, but flattens nested structure. Read more
Creates an iterator which ends after the first None. Read more
Does something with each element of an iterator, passing the value on. Read more
Borrows an iterator, rather than consuming it. Read more
Transforms an iterator into a collection. Read more
🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
Consumes an iterator, creating two collections from it. Read more
🔬This is a nightly-only experimental API. (iter_is_partitioned)
Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false. Read more
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
Folds every element into an accumulator by applying an operation, returning the final result. Read more
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
🔬This is a nightly-only experimental API. (iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
Tests if every element of the iterator matches a predicate. Read more
Tests if any element of the iterator matches a predicate. Read more
Searches for an element of an iterator that satisfies a predicate. Read more
Applies function to the elements of iterator and returns the first non-none result. Read more
🔬This is a nightly-only experimental API. (try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
Searches for an element in an iterator, returning its index. Read more
Returns the element that gives the maximum value from the specified function. Read more
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
Returns the element that gives the minimum value from the specified function. Read more
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
Converts an iterator of pairs into a pair of containers. Read more
Creates an iterator which copies all of its elements. Read more
Creates an iterator which clones all of its elements. Read more
🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
Sums the elements of an iterator. Read more
Iterates over the entire iterator, multiplying all the elements Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
Lexicographically compares the elements of this Iterator with those of another. Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
Determines if the elements of this Iterator are equal to those of another. Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more
Determines if the elements of this Iterator are unequal to those of another. Read more
Determines if the elements of this Iterator are lexicographically less than those of another. Read more
Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
🔬This is a nightly-only experimental API. (is_sorted)
Checks if the elements of this iterator are sorted using the given comparator function. Read more
🔬This is a nightly-only experimental API. (is_sorted)
Checks if the elements of this iterator are sorted using the given key extraction function. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type of the elements being iterated over.
Which kind of iterator are we turning this into?
Creates an iterator from a value. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.