Struct Builder 

pub struct Builder { /* private fields */ }

JsonBuilder provides an object for generating a JSON tree.

The root of the JSON tree can be either a Object or a Array. Thus the first call must necessarily be either BuilderExt::begin_object() or BuilderExt::begin_array().

For convenience to language bindings, most JsonBuilder method return the instance, making it easy to chain function calls.

Using JsonBuilder

⚠️ The following code is in c ⚠️

g_autoptr(JsonBuilder) builder = json_builder_new ();

json_builder_begin_object (builder);

json_builder_set_member_name (builder, "url");
json_builder_add_string_value (builder, "http://www.gnome.org/img/flash/two-thirty.png");

json_builder_set_member_name (builder, "size");
json_builder_begin_array (builder);
json_builder_add_int_value (builder, 652);
json_builder_add_int_value (builder, 242);
json_builder_end_array (builder);

json_builder_end_object (builder);

g_autoptr(JsonNode) root = json_builder_get_root (builder);

g_autoptr(JsonGenerator) gen = json_generator_new ();
json_generator_set_root (gen, root);
g_autofree char *str = json_generator_to_data (gen, NULL);

// str now contains the following JSON data
// { "url" : "http://www.gnome.org/img/flash/two-thirty.png", "size" : [ 652, 242 ] }

Properties

immutable

Whether the tree should be immutable when created.

Making the output immutable on creation avoids the expense of traversing it to make it immutable later.

Readable | Writeable | Construct Only

Implements

BuilderExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Builder

pub const NONE: Option<&'static Builder> = None

pub fn new() -> Builder

Creates a new JsonBuilder.

You can use this object to generate a JSON tree and obtain the root node.

Returns

the newly created builder instance

pub fn new_immutable() -> Builder

Available on crate feature v1_2 only.

Creates a new, immutable JsonBuilder instance.

It is equivalent to setting the immutable property set to TRUE at construction time.

Returns

the newly create builder instance

pub fn builder() -> BuilderBuilder

Creates a new builder-pattern struct instance to construct Builder objects.

This method returns an instance of BuilderBuilder which can be used to create Builder objects.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Builder

impl HasParamSpec for Builder

type ParamSpec = ParamSpecObject

type SetValue = Builder

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, Builder>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Builder

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Builder

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl ParentClassIs for Builder

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Builder

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

Inequality operator !=.

impl<OT: ObjectType> PartialOrd<OT> for Builder

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Builder

fn static_type() -> Type

Returns the type identifier of Self.