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
impl ListBuilder
sourcepub fn append_int(&mut self, value: i64)
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);
sourcepub fn append_string(&mut self, value: impl AsRef<str>)
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");
sourcepub fn append_bool(&mut self, value: bool)
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);
sourcepub fn append_list(&mut self, list: ListBuilder)
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);
sourcepub fn append_object(&mut self, obj: ObjectBuilder<'_>)
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§
impl Freeze for ListBuilder
impl RefUnwindSafe for ListBuilder
impl Send for ListBuilder
impl Sync for ListBuilder
impl Unpin for ListBuilder
impl UnwindSafe for ListBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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