Struct Parser 

pub struct Parser { /* private fields */ }

JsonParser provides an object for parsing a JSON data stream, either inside a file or inside a static buffer.

Using JsonParser

The JsonParser API is fairly simple:

⚠️ The following code is in c ⚠️

gboolean
parse_json (const char *filename)
{
  g_autoptr(JsonParser) parser = json_parser_new ();
  g_autoptr(GError) error = NULL

  json_parser_load_from_file (parser, filename, &error);
  if (error != NULL)
    {
      g_critical ("Unable to parse '%s': %s", filename, error->message);
      return FALSE;
    }

  g_autoptr(JsonNode) root = json_parser_get_root (parser);

  // manipulate the object tree from the root node

  return TRUE
}

By default, the entire process of loading the data and parsing it is synchronous; the ParserExt::load_from_stream_async() API will load the data asynchronously, but parse it in the main context as the signals of the parser must be emitted in the same thread. If you do not use signals, and you wish to also parse the JSON data without blocking, you should use a GTask and the synchronous JsonParser API inside the task itself.

Properties

immutable

Whether the tree built by the parser 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

strict

Whether the parser should be strictly conforming to the JSON format, or allow custom extensions like comments.

Readable | Writeable

Signals

array-element

The ::array-element signal is emitted each time a parser has successfully parsed a single element of a JSON array.

array-end

The ::array-end signal is emitted each time a parser has successfully parsed an entire JSON array.

array-start

The ::array-start signal is emitted each time a parser starts parsing a JSON array.

error

The ::error signal is emitted each time a parser encounters an error in a JSON stream.

object-end

The ::object-end signal is emitted each time a parser has successfully parsed an entire JSON object.

object-member

The ::object-member signal is emitted each time a parser has successfully parsed a single member of a JSON object.

object-start

This signal is emitted each time a parser starts parsing a JSON object.

parse-end

This signal is emitted when a parser successfully finished parsing a JSON data stream.

parse-start

This signal is emitted when a parser starts parsing a JSON data stream.

Implements

ParserExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Parser

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

pub fn new() -> Parser

Creates a new JSON parser.

You can use the JsonParser to load a JSON stream from either a file or a buffer and then walk the hierarchy using the data types API.

Returns

the newly created parser

pub fn new_immutable() -> Parser

Available on crate feature v1_2 only.

Creates a new parser instance with its immutable property set to TRUE to create immutable output trees.

Returns

the newly created parser

pub fn builder() -> ParserBuilder

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

This method returns an instance of ParserBuilder which can be used to create Parser objects.

Trait Implementations

impl Clone for Parser

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 Parser

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

Formats the value using the given formatter.

impl Default for Parser

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Parser

impl HasParamSpec for Parser

type ParamSpec = ParamSpecObject

type SetValue = Parser

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Parser

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 Parser

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 Parser

type Parent = Object

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

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 Parser

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 Parser

fn static_type() -> Type

Returns the type identifier of Self.