Skip to main content

Reader

Struct Reader 

Source
pub struct Reader<'a> { /* private fields */ }
Expand description

A pull parser: reads a document one Event at a time, building nothing.

The reader is the layer every parse in this crate goes through: it checks the full RFC 8259 grammar and every budget in Limits as it goes, with the same errors and byte offsets as parse. Use it to pick a few fields out of a large document, to stream a document’s contents somewhere without holding a tree, or to keep part of a message as raw text to be read later (read_raw).

The reader works over a complete document held in memory, and borrows strings and numbers from it exactly as parse does. Reading is iterative: depth costs one bit of reader state per level, never stack. The reader’s own state for the first 64 levels, 8 open objects, and 16 of their keys is kept inline, so reading a message of ordinary shape allocates nothing but the strings it decodes.

Duplicate keys. Under DuplicateKeys::Error, the default, the reader refuses an object that repeats a key, whichever way it is read: event by event, through read_raw, or through read_value. The check happens when the object closes, so the } of an object with a repeated key is never returned as Event::EndObject: the reader returns ErrorKind::DuplicateKey at the repeat’s opening quote instead. A loop that collects members and acts only after the object ended (as below) can therefore never act on a smuggled second value. To check, the reader keeps, for each key of the objects still open, its offset and a one-word fingerprint of its decoded text; an object whose fingerprints may match, or with more than 16 keys, has its keys read again from the input (and decoded where escaped) when it closes, and compared as text. (A StreamReader, whose input’s front is dropped as it is read, keeps a decoded copy of each key instead.) Under the other policies the reader passes every member through as written; read_value applies First and Last to the values it builds.

After an error the reader is finished: every later call returns the same error.

§Examples

Read a JSON-RPC envelope, keeping params as raw text for later:

use jsonx_lib::{Event, Reader};

let message = r#"{"jsonrpc": "2.0", "id": 4, "method": "hover", "params": {"line": 3}}"#;
let mut reader = Reader::new(message);
let (mut method, mut params) = (None, None);
assert_eq!(reader.next_event()?, Some(Event::StartObject));
while let Some(Event::Key(key)) = reader.next_event()? {
    match &*key {
        "method" => method = reader.read_value()?,
        "params" => params = reader.read_raw()?,
        _ => { let _skipped = reader.read_raw()?; }
    }
}
reader.finish()?; // the rest of the document must be valid too
assert_eq!(method.as_ref().and_then(|m| m.as_str()), Some("hover"));
assert_eq!(params, Some(r#"{"line": 3}"#));

Implementations§

Source§

impl<'a> Reader<'a>

Source

pub fn decode<T: FromJson<'a>>(&mut self) -> Result<T, DecodeError>

Reads the next value as a T (FromJson).

§Errors

The DecodeError of T, or of the reader.

§Examples
use jsonx_lib::{Event, Reader};

let mut r = Reader::new(r#"{"id": 7, "tags": ["a", "b"]}"#);
r.next_event()?; // {
r.next_event()?; // "id"
assert_eq!(r.decode::<u64>()?, 7);
r.next_event()?; // "tags"
assert_eq!(r.decode::<Vec<&str>>()?, ["a", "b"]);
Source

pub fn read_object(&mut self) -> Result<ObjectReader<'_, 'a>, DecodeError>

Starts reading an object whose members are read one by one through the returned ObjectReader. Consumes the {.

§Errors

DecodeErrorKind::WrongType if the next value is not an object (nothing is consumed), or an error of the reader.

§Examples
let mut r = jsonx_lib::Reader::new(r#"{"a": 1, "b": [2]}"#);
let mut object = r.read_object()?;
let mut keys = Vec::new();
while let Some(key) = object.next_key()? {
    keys.push(key.into_owned()); // values not read are skipped
}
assert_eq!(keys, ["a", "b"]);
Source

pub fn read_array(&mut self) -> Result<ArrayReader<'_, 'a>, DecodeError>

Starts reading an array whose items are read one by one through the returned ArrayReader. Consumes the [.

§Errors

DecodeErrorKind::WrongType if the next value is not an array, or an error of the reader.

§Examples
let mut r = jsonx_lib::Reader::new("[1, 2, 3]");
let mut items = r.read_array()?;
let mut sum = 0u32;
while let Some(n) = items.next_item::<u32>()? {
    sum += n;
}
assert_eq!(sum, 6);
Source

pub fn read_raw_value(&mut self) -> Result<Option<RawValue<'a>>, Error>

Reads the next value as a RawValue: its exact source text, validated by this read and not scanned again. As read_raw, Ok(None) when no value comes next.

§Errors

As read_raw.

§Examples
let mut r = jsonx_lib::Reader::new(r#"{"params": {"line": 3}}"#);
r.next_event()?;
r.next_event()?;
let params = r.read_raw_value()?.unwrap();
assert_eq!(params.as_str(), r#"{"line": 3}"#);
Source§

impl<'a> Reader<'a>

Source

pub fn new(text: &'a str) -> Self

A reader over text with the default Limits.

§Examples
use jsonx_lib::{Event, Reader};

let mut r = Reader::new("  42 ");
assert_eq!(r.next_event()?.map(|e| e == Event::Number(42.into())), Some(true));
assert_eq!(r.next_event()?, None);
Source

pub fn documents(self) -> Self

Reads a sequence of documents instead of one: after a document’s value, another may follow, separated by any whitespace (or by nothing, where the grammar allows: [1][2]). This reads newline-delimited JSON (NDJSON, JSON Lines) and concatenated JSON. Each document has its own Limits::max_elements; the input size budget covers them all. Events run on from one document into the next; read_value and the other whole-value reads return one document each, and Ok(None) after the last.

§Examples
use jsonx_lib::Reader;

let lines = "{\"n\": 1}\n{\"n\": 2}\n";
let mut r = Reader::new(lines).documents();
let mut total = 0;
while let Some(doc) = r.read_value()? {
    total += doc["n"].as_i64().unwrap_or(0);
}
assert_eq!(total, 3);
Source

pub fn next_event(&mut self) -> Result<Option<Event<'a>>, Error>

Reads the next event, or Ok(None) once the document’s value is complete and nothing but whitespace follows it.

§Errors

The first syntax error or exceeded budget, at its byte offset (see Error). Once an error is returned, every later call returns it too.

§Examples
use jsonx_lib::{ErrorKind, Event, Reader};

let mut r = Reader::new("[1,]");
assert_eq!(r.next_event()?, Some(Event::StartArray));
assert!(r.next_event()?.is_some()); // 1
let err = r.next_event().unwrap_err();
assert_eq!((err.kind(), err.offset()), (ErrorKind::TrailingComma, 3));
Source

pub fn read_raw(&mut self) -> Result<Option<&'a str>, Error>

Reads the next value whole and returns its exact source text, without decoding or copying it.

Call it where a value comes next: at the start, after a Key, or between array items. The value is fully validated. If no value comes next (the current array or object ends, or the document already ended), returns Ok(None) and consumes nothing, so the next next_event returns the end event as usual. Calling it where a key comes next also returns Ok(None). After a single document’s value, Ok(None) is returned only if nothing but whitespace follows; anything else is ErrorKind::TrailingCharacters, as next_event and finish report it.

The text is a slice of the input: it can be stored, compared, or parsed later, as serde_json’s RawValue is used. Nothing of the value is allocated; the reader’s own state grows with the value’s nesting (a bit per level) and, under DuplicateKeys::Error, with the keys of its open objects, on the heap only past what it keeps inline (see Reader).

§Errors

As next_event, for any error inside the value, including a repeated key under DuplicateKeys::Error, and ErrorKind::TrailingCharacters after the document.

§Examples
use jsonx_lib::{Event, Reader};

let mut r = Reader::new(r#"[{"deep": [1, 2]}, "x"]"#);
assert_eq!(r.next_event()?, Some(Event::StartArray));
assert_eq!(r.read_raw()?, Some(r#"{"deep": [1, 2]}"#));
assert_eq!(r.read_raw()?, Some(r#""x""#));
assert_eq!(r.read_raw()?, None); // the array ends here
assert_eq!(r.next_event()?, Some(Event::EndArray));
Source

pub fn read_value(&mut self) -> Result<Option<Value<'a>>, Error>

Reads the next value whole and builds it as a Value, applying the reader’s DuplicateKeys policy.

Positioning is as for read_raw: Ok(None), with nothing consumed, when no value comes next.

Each call has its own Limits::max_memory count: the tree it builds is bounded, and what earlier calls returned is not counted, so a large array read item by item is limited per item, not in total.

§Errors

As next_event, plus ErrorKind::DuplicateKey under DuplicateKeys::Error.

§Examples
use jsonx_lib::{Event, Reader};

let mut r = Reader::new(r#"{"skip": [0], "keep": {"a": 1}}"#);
r.next_event()?; // {
r.next_event()?; // "skip"
r.read_raw()?;
assert_eq!(r.next_event()?, Some(Event::Key("keep".into())));
let keep = r.read_value()?.unwrap_or_default();
assert_eq!(keep["a"], 1);
Source

pub fn peek_kind(&mut self) -> Result<Option<Kind>, Error>

The kind of the next value, without consuming anything: None when no value comes next (positioning as for read_raw), or when the next byte cannot start one (the next next_event reports why). Decided by the value’s first byte alone, so tru peeks as Kind::Bool.

Useful for a value that may be one of several shapes, such as LSP’s string | number ids.

§Errors

Any error the reader already stopped at.

§Examples
use jsonx_lib::{Kind, Reader};

let mut r = Reader::new(r#"[7, "seven"]"#);
r.next_event()?;
assert_eq!(r.peek_kind()?, Some(Kind::Number));
r.read_raw()?;
assert_eq!(r.peek_kind()?, Some(Kind::String));
r.read_raw()?;
assert_eq!(r.peek_kind()?, None); // the array ends
Source

pub fn find_pointer(&mut self, pointer: &str) -> Result<Option<&'a str>, Error>

Finds the value at an RFC 6901 JSON Pointer in the value that comes next, without building anything, and returns its exact source text: what Value::pointer would find, without the tree. Everything before the target is read and validated; members and items that are not on the way are skipped with read_raw.

Duplicate keys. Under DuplicateKeys::Error, the default, the answer is given only for a value with no repeated key anywhere in it: the reader reads the rest of the value it started on before returning (and, started at the top of a document, the rest of the document, as finish does), so {"method": "a", "method": "b"} is refused, as by parse, rather than answered with either member. The reader then stands past that value. Under DuplicateKeys::Last the member taken is the last one with the key, as parse and typed reads under that policy keep it: each object on the way is read to its end, and the reader stands past the value it started on. Under the other policies it stops just past the target, without reading the rest, and in an object the first member with the key is the one taken.

Ok(None) when the pointer is malformed or names nothing (as Value::pointer’s None).

§Errors

Any error of the reader on the way to the target, or inside it, and under DuplicateKeys::Error in the rest of the value (a repeated key included).

§Examples
use jsonx_lib::Reader;

let message = r#"{"jsonrpc": "2.0", "id": 9, "params": {"items": [{"label": "a"}, {"label": "b"}]}}"#;
assert_eq!(Reader::new(message).find_pointer("/params/items/1/label")?, Some(r#""b""#));
assert_eq!(Reader::new(message).find_pointer("/id")?, Some("9"));
assert_eq!(Reader::new(message).find_pointer("/params/missing")?, None);

// A repeated key anywhere is refused, as `parse` refuses it.
let smuggled = r#"{"method": "initialize", "method": "shutdown"}"#;
assert!(Reader::new(smuggled).find_pointer("/method").is_err());
Source

pub fn finish(self) -> Result<(), Error>

Reads to the end of the document, checking that the rest of it is valid and that nothing but whitespace follows its value.

§Errors

The first error in the rest of the document.

§Examples
use jsonx_lib::{ErrorKind, Event, Reader};

let mut r = Reader::new(r#"{"id": 1, "x": [} "#);
assert_eq!(r.next_event()?, Some(Event::StartObject));
let err = r.finish().unwrap_err();
assert_eq!((err.kind(), err.offset()), (ErrorKind::ExpectedValue, 16));
Source

pub fn depth(&self) -> usize

The number of arrays and objects open at this point.

§Examples
let mut r = jsonx_lib::Reader::new("[[]]");
r.next_event()?;
r.next_event()?;
assert_eq!(r.depth(), 2);
Source

pub fn offset(&self) -> usize

The byte offset just past the input consumed so far.

§Examples
let mut r = jsonx_lib::Reader::new("[10, 20]");
r.next_event()?;
r.next_event()?;
assert_eq!(r.offset(), 3);
Source

pub fn event_offset(&self) -> usize

The byte offset where the most recent event’s token began: the quote of a key or string, the first byte of a number or literal, the bracket or brace of a start or end event. Useful for pointing a diagnostic of your own at the value it is about.

§Examples
let mut r = jsonx_lib::Reader::new(r#"{ "a" : 1 }"#);
r.next_event()?;
r.next_event()?;
assert_eq!(r.event_offset(), 2); // the key's opening quote
r.next_event()?;
assert_eq!(r.event_offset(), 8); // the number

Trait Implementations§

Source§

impl<'a> Clone for Reader<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Reader<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FusedIterator for Reader<'_>

Source§

impl<'a> Iterator for Reader<'a>

Source§

fn next(&mut self) -> Option<Self::Item>

The next event; after the end or an error, None. An error is yielded once.

Source§

type Item = Result<Event<'a>, Error>

The type of the elements being iterated over.
Source§

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
1.0.0 (const: unstable) · Source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
1.0.0 (const: unstable) · Source§

fn count(self) -> usize
where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more
1.0.0 (const: unstable) · Source§

fn last(self) -> Option<Self::Item>
where Self: Sized,

Consumes the iterator, returning the last element. Read more
Source§

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
1.0.0 (const: unstable) · Source§

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator. Read more
1.28.0 (const: unstable) · Source§

fn step_by(self, step: usize) -> StepBy<Self> ⓘ
where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0 (const: unstable) · Source§

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> ⓘ
where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0 (const: unstable) · Source§

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> ⓘ
where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs. Read more
Source§

fn intersperse(self, separator: Self::Item) -> Intersperse<Self> ⓘ
where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places a copy of separator between items of the original iterator. Read more
Source§

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> ⓘ
where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between items of the original iterator. Read more
1.0.0 (const: unstable) · Source§

fn map<B, F>(self, f: F) -> Map<Self, F> ⓘ
where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element. Read more
1.21.0 (const: unstable) · Source§

fn for_each<F>(self, f: F)
where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more
1.0.0 (const: unstable) · Source§

fn filter<P>(self, predicate: P) -> Filter<Self, P> ⓘ
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded. Read more
1.0.0 (const: unstable) · Source§

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> ⓘ
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps. Read more
1.0.0 (const: unstable) · Source§

fn enumerate(self) -> Enumerate<Self> ⓘ
where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value. Read more
1.0.0 (const: unstable) · Source§

fn peekable(self) -> Peekable<Self> ⓘ
where Self: Sized,

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
1.0.0 (const: unstable) · Source§

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> ⓘ
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate. Read more
1.0.0 (const: unstable) · Source§

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> ⓘ
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate. Read more
1.57.0 (const: unstable) · Source§

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> ⓘ
where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps. Read more
1.0.0 (const: unstable) · Source§

fn skip(self, n: usize) -> Skip<Self> ⓘ
where Self: Sized,

Creates an iterator that skips the first n elements. Read more
1.0.0 (const: unstable) · Source§

fn take(self, n: usize) -> Take<Self> ⓘ
where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
1.0.0 (const: unstable) · Source§

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> ⓘ
where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator. Read more
1.0.0 (const: unstable) · Source§

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> ⓘ
where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure. Read more
1.29.0 (const: unstable) · Source§

fn flatten(self) -> Flatten<Self> ⓘ
where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure. Read more
Source§

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N> ⓘ
where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)
Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well. Read more
1.0.0 (const: unstable) · Source§

fn fuse(self) -> Fuse<Self> ⓘ
where Self: Sized,

Creates an iterator which ends after the first None. Read more
1.0.0 (const: unstable) · Source§

fn inspect<F>(self, f: F) -> Inspect<Self, F> ⓘ
where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on. Read more
1.0.0 (const: unstable) · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Iterator. Read more
1.0.0 (const: unstable) · Source§

fn collect<B>(self) -> B
where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection. Read more
Source§

fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
where Self: Sized, Self::Item: Try, <Self::Item as Try>::Residual: Residual<B>, B: FromIterator<<Self::Item as Try>::Output>,

🔬This is a nightly-only experimental API. (iterator_try_collect)
Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered. Read more
Source§

fn collect_into<E>(self, collection: &mut E) -> &mut E
where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
1.0.0 (const: unstable) · Source§

fn partition<B, F>(self, f: F) -> (B, B)
where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more
Source§

fn is_partitioned<P>(self, predicate: P) -> bool
where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬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
1.27.0 (const: unstable) · Source§

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
1.27.0 (const: unstable) · Source§

fn try_for_each<F, R>(&mut self, f: F) -> R
where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

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
1.0.0 (const: unstable) · Source§

fn fold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result. Read more
1.51.0 (const: unstable) · Source§

fn reduce<F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
Source§

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬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
1.0.0 (const: unstable) · Source§

fn all<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more
1.0.0 (const: unstable) · Source§

fn any<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more
1.0.0 (const: unstable) · Source§

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more
1.30.0 (const: unstable) · Source§

fn find_map<B, F>(&mut self, f: F) -> Option<B>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result. Read more
Source§

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬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
1.0.0 (const: unstable) · Source§

fn position<P>(&mut self, predicate: P) -> Option<usize>
where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more
1.0.0 (const: unstable) · Source§

fn max(self) -> Option<Self::Item>
where Self: Sized, Self::Item: Ord,

Returns the maximum element of an iterator. Read more
1.0.0 (const: unstable) · Source§

fn min(self) -> Option<Self::Item>
where Self: Sized, Self::Item: Ord,

Returns the minimum element of an iterator. Read more
1.6.0 (const: unstable) · Source§

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function. Read more
1.15.0 (const: unstable) · Source§

fn max_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function. Read more
1.6.0 (const: unstable) · Source§

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function. Read more
1.15.0 (const: unstable) · Source§

fn min_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function. Read more
1.0.0 (const: unstable) · Source§

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers. Read more
1.36.0 (const: unstable) · Source§

fn copied<'a, T>(self) -> Copied<Self> ⓘ
where T: Copy + 'a, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements. Read more
1.0.0 (const: unstable) · Source§

fn cloned<'a, T>(self) -> Cloned<Self> ⓘ
where T: Clone + 'a, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements. Read more
1.0.0 (const: unstable) · Source§

fn cycle(self) -> Cycle<Self> ⓘ
where Self: Sized + Clone,

Repeats an iterator endlessly. Read more
Source§

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N> ⓘ
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
1.11.0 (const: unstable) · Source§

fn sum<S>(self) -> S
where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator. Read more
1.11.0 (const: unstable) · Source§

fn product<P>(self) -> P
where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements. Read more
1.5.0 (const: unstable) · Source§

fn cmp<I>(self, other: I) -> Ordering
where I: IntoIterator<Item = Self::Item>, Self::Item: Ord, Self: Sized,

Lexicographically compares the elements of this Iterator with those of another. Read more
Source§

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬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
1.5.0 (const: unstable) · Source§

fn partial_cmp<I>(self, other: I) -> Option<Ordering>
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned. Read more
Source§

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬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
1.5.0 (const: unstable) · Source§

fn eq<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another. Read more
Source§

fn eq_by<I, F>(self, other: I, eq: F) -> bool
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬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
1.5.0 (const: unstable) · Source§

fn ne<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another. Read more
1.5.0 (const: unstable) · Source§

fn lt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another. Read more
1.5.0 (const: unstable) · Source§

fn le<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
1.5.0 (const: unstable) · Source§

fn gt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
1.5.0 (const: unstable) · Source§

fn ge<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
1.82.0 (const: unstable) · Source§

fn is_sorted(self) -> bool
where Self: Sized, Self::Item: PartialOrd,

Checks if the elements of this iterator are sorted. Read more
1.82.0 (const: unstable) · Source§

fn is_sorted_by<F>(self, compare: F) -> bool
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function. Read more
1.82.0 (const: unstable) · Source§

fn is_sorted_by_key<F, K>(self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

Auto Trait Implementations§

§

impl<'a> Forget for Reader<'a>

§

impl<'a> Freeze for Reader<'a>

§

impl<'a> Move for Reader<'a>

§

impl<'a> RefUnwindSafe for Reader<'a>

§

impl<'a> Send for Reader<'a>

§

impl<'a> Sync for Reader<'a>

§

impl<'a> Unpin for Reader<'a>

§

impl<'a> UnsafeUnpin for Reader<'a>

§

impl<'a> UnwindSafe for Reader<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<I> IntoIterator for I
where I: Iterator,

Source§

type Item = <I as Iterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = I

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> I

Creates an iterator from a value. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.