Struct RenderedChunks 

pub struct RenderedChunks<V>(/* private fields */);

Outcome of rendering the individual chunks of a template. This is an intermediate output type that can be resolved into a variety of final output types.

Implementations

impl<V: RenderValue> RenderedChunks<V>

pub fn into_chunks(self) -> Vec<RenderedChunk<V>>

Get the inner list of chunks

pub fn chunks(&self) -> &[RenderedChunk<V>]

Get the inner chunks as a slice

pub fn iter(&self) -> impl Iterator<Item = &RenderedChunk<V>>

Get an iterator over references to the chunks

pub fn unpack(self) -> Result<V, Self>

Unpack this output into a single value

If the output is a single dynamic chunk, unpack it into a scalar value. Otherwise, return Err(self).

impl RenderedChunks<Value>

pub fn try_into_value(self) -> Result<Value, RenderError>

Collect the rendered chunks into a Value by these rules:

• If the template is a single dynamic chunk, return the output of that chunk, which may be any type of Value
• Any other template will be rendered to a string by stringifying each dynamic chunk and concatenating them all together
• If rendering to a string fails because the bytes are not valid UTF-8, concatenate into a bytes object instead

pub fn try_into_bytes(self) -> Result<Bytes, RenderError>

Collect the rendered chunks into a byte string

If any chunk is an error, return an error.

impl RenderedChunks<ValueStream>

pub fn stream_source(&self) -> Option<&StreamSource>

If this output is a single chunk and that chunk is a stream, get the source of the stream

pub fn has_stream(&self) -> bool

Does this output contain any stream chunks?

pub async fn try_collect_value(self) -> Result<Value, RenderError>

Collect the rendered chunks into a Value by these rules:

• If the template is a single dynamic chunk, return the output of that chunk, which may be any type of Value
• If there are any streams, resolve them to bytes
• Any other template will be rendered to a string by stringifying each dynamic chunk and concatenating them all together
• If rendering to a string fails because the bytes are not valid UTF-8, concatenate into a bytes object instead

pub fn try_into_stream( self, ) -> Result<impl Stream<Item = Result<Bytes, RenderError>> + Send, RenderError>

Convert this output into a byte stream. Each chunk will be yielded as a separate Bytes output from the stream, except for inner stream chunks, which can yield any number of values based on their implementation. Return Err if any of the rendered chunks are errors.

Trait Implementations

impl<V: Debug> Debug for RenderedChunks<V>

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

Formats the value using the given formatter.

impl<V: From<Value>> From<Result<Value, RenderError>> for RenderedChunks<V>

Create render output of a single chunk that may have failed

fn from(result: Result<Value, RenderError>) -> Self

Converts to this type from the input type.

impl<V: From<Value>> From<Value> for RenderedChunks<V>

Create render output of a single chunk with a value

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<'a, V> IntoIterator for &'a RenderedChunks<V>

Get an iterator over references to chunks of this output

type Item = &'a RenderedChunk<V>

The type of the elements being iterated over.

type IntoIter = Iter<'a, RenderedChunk<V>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V> IntoIterator for RenderedChunks<V>

Get an iterator over the chunks of this output

type Item = RenderedChunk<V>

The type of the elements being iterated over.

type IntoIter = IntoIter<<RenderedChunks<V> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.