Skip to main content

TeaLeafBuilder

Struct TeaLeafBuilder 

Source
pub struct TeaLeafBuilder { /* private fields */ }
Expand description

Builder for constructing TeaLeaf documents from multiple DTOs.

§Example

use tealeaf::TeaLeafBuilder;

let doc = TeaLeafBuilder::new()
    .add("config", &config)
    .add_vec("users", &users)
    .build();

Implementations§

Source§

impl TeaLeafBuilder

Source

pub fn new() -> Self

Create a new empty builder.

Source

pub fn add<T: ToTeaLeaf>(self, key: &str, dto: &T) -> Self

Add a single DTO under the given key.

Source

pub fn add_value(self, key: &str, value: Value) -> Self

Add a raw Value under the given key (no schema collection).

Source

pub fn add_schema(self, schema: Schema) -> Self

Add a schema definition.

Source

pub fn add_union(self, union: Union) -> Self

Add a union definition.

Source

pub fn add_vec<T: ToTeaLeaf>(self, key: &str, items: &[T]) -> Self

Add a Vec of DTOs as an array under the given key.

Source

pub fn root_array(self) -> Self

Mark the document as a root array (for JSON round-trip fidelity).

Source

pub fn build(self) -> TeaLeaf

Build the TeaLeaf document.

Trait Implementations§

Source§

impl Default for TeaLeafBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> 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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.