Class: Oj::StringWriter

Inherits:
Object
  • Object
show all
Defined in:
ext/oj/string_writer.c,
ext/oj/string_writer.c

Overview

Supports building a JSON document one element at a time. Build the document by pushing values into the document. Pushing an array or an object will create that element in the JSON document and subsequent pushes will add the elements to that array or object until a pop() is called. When complete calling to_s() will return the JSON document. Note that calling to_s() before construction is complete will return the document in it’s current state.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.new(io, options) ⇒ Object

Creates a new StringWriter. Options are supported according the the specified mode or the mode in the default options. Note that if mimic_JSON or Oj.optimize_rails has not been called then the behavior of the modes may not be the same as if they were.

In addition to the regular dump options for the various modes a :buffer_size option is available. It should be set to a positive integer. It is considered a hint of how large the initial internal buffer should be.

  • io [IO] stream to write to

  • options [Hash] formatting options



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'ext/oj/string_writer.c', line 275

static VALUE str_writer_new(int argc, VALUE *argv, VALUE self) {
    StrWriter sw = OJ_R_ALLOC(struct _strWriter);

    oj_str_writer_init(sw, 0);
    if (1 == argc) {
        oj_parse_options(argv[0], &sw->opts);
    }
    sw->out.argc   = argc - 1;
    sw->out.argv   = argv + 1;
    sw->out.indent = sw->opts.indent;

    return TypedData_Wrap_Struct(oj_string_writer_class, &oj_string_writer_type, sw);
}

Instance Method Details

#as_json ⇒ Object

Returns the contents of the writer as a JSON element. If called from inside an array or hash by Oj the raw buffer will be used othersize a more inefficient parse of the contents and a return of the result is completed. The parse uses the strict mode.

return [Hash|Array|String|Integer|Float|True|False|_nil|)



487
488
489
490
491
492
 
# File 'ext/oj/string_writer.c', line 487

static VALUE str_writer_as_json(VALUE self) {
    if (string_writer_optimized) {
        return self;
    }
    return rb_hash_new();
}

#pop ⇒ Object

Pops up a level in the JSON document closing the array or object that is currently open.



421
422
423
424
425
426
427
 
# File 'ext/oj/string_writer.c', line 421

static VALUE str_writer_pop(VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    oj_str_writer_pop(sw);
    return Qnil;
}

#pop_all ⇒ Object

Pops all level in the JSON document closing all the array or object that is currently open.



435
436
437
438
439
440
441
442
 
# File 'ext/oj/string_writer.c', line 435

static VALUE str_writer_pop_all(VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    oj_str_writer_pop_all(sw);

    return Qnil;
}

#push_array(key = nil) ⇒ Object

Pushes an array onto the JSON document. Future pushes will be to this object until a pop() is called.

  • key [String] the key if adding to an object in the JSON document



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'ext/oj/string_writer.c', line 342

static VALUE str_writer_push_array(int argc, VALUE *argv, VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    switch (argc) {
    case 0: oj_str_writer_push_array(sw, 0); break;
    case 1:
        if (Qnil == argv[0]) {
            oj_str_writer_push_array(sw, 0);
        } else {
            oj_str_writer_push_array(sw, StringValuePtr(argv[0]));
        }
        break;
    default: rb_raise(rb_eArgError, "Wrong number of argument to 'push_object'."); break;
    }
    if (rb_block_given_p()) {
        rb_yield(Qnil);
        oj_str_writer_pop(sw);
    }
    return Qnil;
}

#push_json(value, key = nil) ⇒ Object

Pushes a string onto the JSON document. The String must be a valid JSON encoded string. No additional checking is done to verify the validity of the string.

  • value [Object] value to add to the JSON document

  • key [String] the key if adding to an object in the JSON document



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'ext/oj/string_writer.c', line 398

static VALUE str_writer_push_json(int argc, VALUE *argv, VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    switch (argc) {
    case 1: oj_str_writer_push_json(sw, StringValuePtr(*argv), 0); break;
    case 2:
        if (Qnil == argv[1]) {
            oj_str_writer_push_json(sw, StringValuePtr(*argv), 0);
        } else {
            oj_str_writer_push_json(sw, StringValuePtr(*argv), StringValuePtr(argv[1]));
        }
        break;
    default: rb_raise(rb_eArgError, "Wrong number of argument to 'push_json'."); break;
    }
    return Qnil;
}

#push_key(key) ⇒ Object

Pushes a key onto the JSON document. The key will be used for the next push if currently in a JSON object and ignored otherwise. If a key is provided on the next push then that new key will be ignored.

  • key [String] the key pending for the next push



297
298
299
300
301
302
303
304
 
# File 'ext/oj/string_writer.c', line 297

static VALUE str_writer_push_key(VALUE self, VALUE key) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    oj_str_writer_push_key(sw, StringValuePtr(key));

    return Qnil;
}

#push_object(key = nil) ⇒ Object

Pushes an object onto the JSON document. Future pushes will be to this object until a pop() is called.

  • key [String] the key if adding to an object in the JSON document



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'ext/oj/string_writer.c', line 313

static VALUE str_writer_push_object(int argc, VALUE *argv, VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    switch (argc) {
    case 0: oj_str_writer_push_object(sw, 0); break;
    case 1:
        if (Qnil == argv[0]) {
            oj_str_writer_push_object(sw, 0);
        } else {
            oj_str_writer_push_object(sw, StringValuePtr(argv[0]));
        }
        break;
    default: rb_raise(rb_eArgError, "Wrong number of argument to 'push_object'."); break;
    }
    if (rb_block_given_p()) {
        rb_yield(Qnil);
        oj_str_writer_pop(sw);
    }
    return Qnil;
}

#push_value(value, key = nil) ⇒ Object

Pushes a value onto the JSON document.

  • value [Object] value to add to the JSON document

  • key [String] the key if adding to an object in the JSON document



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'ext/oj/string_writer.c', line 371

static VALUE str_writer_push_value(int argc, VALUE *argv, VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    switch (argc) {
    case 1: oj_str_writer_push_value(sw, *argv, 0); break;
    case 2:
        if (Qnil == argv[1]) {
            oj_str_writer_push_value(sw, *argv, 0);
        } else {
            oj_str_writer_push_value(sw, *argv, StringValuePtr(argv[1]));
        }
        break;
    default: rb_raise(rb_eArgError, "Wrong number of argument to 'push_value'."); break;
    }
    return Qnil;
}

#to_s ⇒ Object

Returns the JSON document string in what ever state the construction is at.

return [String]



469
470
471
472
473
474
475
 
# File 'ext/oj/string_writer.c', line 469

static VALUE str_writer_to_s(VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);
    VALUE rstr = rb_str_new(sw->out.buf, sw->out.cur - sw->out.buf);

    return oj_encode(rstr);
}

#reset ⇒ Object

Reset the writer back to the empty state.



449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'ext/oj/string_writer.c', line 449

static VALUE str_writer_reset(VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);

    sw->depth      = 0;
    *sw->types     = '\0';
    sw->keyWritten = 0;
    sw->out.cur    = sw->out.buf;
    *sw->out.cur   = '\0';

    return Qnil;
}

#to_s ⇒ Object

Returns the JSON document string in what ever state the construction is at.

return [String]



469
470
471
472
473
474
475
 
# File 'ext/oj/string_writer.c', line 469

static VALUE str_writer_to_s(VALUE self) {
    StrWriter sw;
    TypedData_Get_Struct(self, struct _strWriter, &oj_string_writer_type, sw);
    VALUE rstr = rb_str_new(sw->out.buf, sw->out.cur - sw->out.buf);

    return oj_encode(rstr);
}