Struct ListStream

pub struct ListStream { /* private fields */ }

A potentially infinite, interruptible stream of Values.

In practice, a “stream” here means anything which can be iterated and produces Values. Like other iterators in Rust, observing values from this stream will drain the items as you view them and the stream cannot be replayed.

Implementations

impl ListStream

pub fn new( iter: impl Iterator<Item = Value> + Send + 'static, span: Span, signals: Signals, ) -> Self

Create a new ListStream from a Value Iterator.

pub fn span(&self) -> Span

Returns the Span associated with this ListStream.

pub fn with_span(self, span: Span) -> Self

Changes the Span associated with this ListStream.

pub fn into_inner(self) -> ValueIterator

Convert a ListStream into its inner Value Iterator.

pub fn next_value(&mut self) -> Option<Value>

Take a single value from the inner Iterator, modifying the stream.

pub fn into_string(self, separator: &str, config: &Config) -> String

Converts each value in a ListStream into a string and then joins the strings together using the given separator.

pub fn into_value(self) -> Value

Collect the values of a ListStream into a list Value.

pub fn drain(self) -> Result<(), ShellError>

Consume all values in the stream, returning an error if any of the values is a Value::Error.

pub fn modify<I>(self, f: impl FnOnce(ValueIterator) -> I) -> Self

where I: Iterator<Item = Value> + Send + 'static,

Modify the inner iterator of a ListStream using a function.

This can be used to call any number of standard iterator functions on the ListStream. E.g., take, filter, step_by, and more.

use nu_protocol::{ListStream, Signals, Span, Value};

let span = Span::unknown();
let stream = ListStream::new(std::iter::repeat(Value::int(0, span)), span, Signals::empty());
let new_stream = stream.modify(|iter| iter.take(100));

pub fn map(self, mapping: impl FnMut(Value) -> Value + Send + 'static) -> Self

Create a new ListStream whose values are the results of applying the given function to each of the values in the original ListStream.

Trait Implementations

impl Debug for ListStream

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

Formats the value using the given formatter.

impl From<ListStream> for PipelineData

fn from(stream: ListStream) -> Self

Converts to this type from the input type.

impl IntoIterator for ListStream

type Item = Value

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.