Struct jupiter::ig::builder::ListBuilder

source ·
pub struct ListBuilder { /* private fields */ }
Expand description

Builds an inner list within a Doc or another element.

A builder can be obtained via DocBuilder::root_list_builder.

Implementations§

source§

impl ListBuilder

source

pub fn append_int(&mut self, value: i64)

Appends an integer value to the list being built.

§Example
let builder = DocBuilder::new();
let mut list_builder = builder.list();

list_builder.append_int(42);

let doc = builder.build_list(list_builder);
assert_eq!(doc.root().at(0).as_int().unwrap(), 42);
source

pub fn append_string(&mut self, value: impl AsRef<str>)

Appends a string to the list being built.

§Example
let builder = DocBuilder::new();
let mut list_builder = builder.list();

list_builder.append_string("Test");

let doc = builder.build_list(list_builder);
assert_eq!(doc.root().at(0).as_str().unwrap(), "Test");
source

pub fn append_bool(&mut self, value: bool)

Appends a bool value to the list being built.

§Example
let builder = DocBuilder::new();
let mut list_builder = builder.list();

list_builder.append_bool(true);

let doc = builder.build_list(list_builder);
assert_eq!(doc.root().at(0).as_bool(), true);    
source

pub fn append_list(&mut self, list: ListBuilder)

Appends a child-list to the list being built. Returns the builder used to populate the list.

Note that this will not join two lists but rather construct a list as child element and append further items to this child list.

§Example
let builder = DocBuilder::new();
let mut list_builder = builder.list();

let mut child_list_builder = builder.list();
child_list_builder.append_int(42);
list_builder.append_list(child_list_builder);

let doc = builder.build_list(list_builder);
assert_eq!(doc.root().len(), 1);    
assert_eq!(doc.root().at(0).len(), 1);    
assert_eq!(doc.root().at(0).at(0).as_int().unwrap(), 42);
source

pub fn append_object(&mut self, obj: ObjectBuilder<'_>)

Appends a child object to the list being built. Returns the builder used to populate the object.

§Example
let builder = DocBuilder::new();
let mut list_builder = builder.list();

let mut obj_builder = builder.obj();
obj_builder.put_string("Foo", "Bar").unwrap();
list_builder.append_object(obj_builder);

let doc = builder.build_list(list_builder);
assert_eq!(doc.root().len(), 1);    
assert_eq!(doc.root().at(0).query("Foo").as_str().unwrap(), "Bar");

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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more