Struct Stream 

pub struct Stream<T> { /* private fields */ }

A list of T kept written: its body in the binary form, its strings its own.

A stream that was built here (collect, From<Vec<T>>, a StreamWriter) always reads. A decoded one has had its framing checked and nothing more, so an item can fail when it is read: see Stream::iter.

Two streams are equal when they have the same count and the same bytes, not when their items are equal: the same items written by another encoder (a different but valid spelling of an int, say) are not equal, and a stream with an unreadable item equals only a copy of itself. Compare Stream::to_vec to compare items.

Implementations

impl<T> Stream<T>

pub fn len(&self) -> usize

How many items it says it has (a decoded stream’s are not read yet).

pub fn is_empty(&self) -> bool

Whether it says it has none.

pub fn bytes_len(&self) -> usize

How many bytes it takes.

impl<T: Schema> Stream<T>

pub fn writer() -> StreamWriter<T>

Writes items one by one (StreamWriter::push).

pub fn iter(&self) -> Items<'_, T>

The items, each read as it’s asked for.

An item that cannot be read (a newer item type, a corrupt byte) is an Err naming its index and byte, and the iterator ends there; so does a stream with bytes left after its counted items, with an Err at index len. iter().collect::<Result<Vec<_>, _>>() reads them all or stops at the first bad one.

pub fn to_vec(&self) -> Result<Vec<T>, ItemError>

Every item, read now: the first that cannot be read is the error.

Errors

An ItemError for the first unreadable item.

pub fn validate(&self) -> Result<(), ItemError>

Reads every item and drops it: whether the whole stream reads.

Errors

An ItemError for the first unreadable item.

Trait Implementations

impl<T> Clone for Stream<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Stream<T>

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

Formats the value using the given formatter.

impl<T> Default for Stream<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Schema> From<Vec<T>> for Stream<T>

fn from(items: Vec<T>) -> Self

Converts to this type from the input type.

impl<T: Schema> FromIterator<T> for Stream<T>

fn from_iter<I: IntoIterator<Item = T>>(items: I) -> Self

Creates a value from an iterator.

impl<'a, T: Schema> IntoIterator for &'a Stream<T>

type Item = Result<T, ItemError>

The type of the elements being iterated over.

type IntoIter = Items<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Items<'a, T>

Creates an iterator from a value.

impl<T> PartialEq for Stream<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: Schema> Schema for Stream<T>

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<Self>

The slow way (a text file, a value): read whole, then written.

fn write(&self) -> Value

The items that read, up to the first that does not: a Value has no place for an error, so check a decoded stream with Stream::validate.

fn decode(d: &mut Decoder<'_>) -> Option<Self>

Checks the framing only: the byte length, and that the count fits the bytes (each item takes one at least, so a hostile count allocates nothing). The items are read by Stream::iter.

fn pack(&self, p: &mut Packer)

In a frame it’s a list, as its shape says (the items that read, as in Stream::write).

fn shape() -> Shape

What the format looks like.

fn encode(&self, w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn unpack(u: &mut Unpacker<'_>) -> Option<Self>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn write_text(&self, w: &mut Writer)

Writes itself as text, straight (crate::text::Writer) — Schema::write’s value as text, unless the type knows better (derived ones do): no value tree is built on the way.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.