Emitter

---

Object Hierarchy:

Description:

Content:

Creation methods:

• public Emitter ()
  Initialize an emitter.

Methods:

• public int close ()
  Finish a YAML stream.
• public int dump (ref Document document)
  Emit a YAML document.
• public int emit (ref Event event)
  Emit an event.
• public int flush ()
  Flush the accumulated characters to the output.
• public int open ()
  Start a YAML stream.
• public void set_break (Break line_break)
  Set the preferred line break.
• public void set_canonical (int canonical)
  Set if the output should be in the "canonical" format as in the YAML specification.
• public void set_encoding (Encoding encoding)
  Set the output encoding.
• public void set_indent (int indent)
  Set the intendation increment.
• public void set_output (WriteHandler handler)
  Set a generic output handler.
• public void set_output_file (FileStream file)
  Set a file output.
• public void set_output_string (ref uint8[] output, out size_t size_written)
  Set a string output.
• public void set_unicode (int unicode)
  Set if unescaped non-ASCII characters are allowed.
• public void set_width (int width)
  Set the preferred line width. -1 means unlimited.

Fields:

• public ErrorType error
  Error type.
• public unowned string? problem
  Error description.
• public WriteHandler write_handler
  Write handler.
• public void* write_handler_data
  A pointer for passing to the write handler.
• public string? output_string_buffer
  The buffer pointer.
• public size_t output_string_size
  The buffer size.
• public size_t? output_string_size_written
  The number of written bytes.
• public FileStream? output_file
  File output data.
• public string? buffer_start
  The beginning of the working buffer.
• public string? buffer_end
  The end of the working buffer.
• public string? buffer_pointer
  The current position of the working buffer.
• public string? buffer_last
  The last filled position of the working buffer.
• public string? raw_buffer_start
  The beginning of the buffer.
• public string? raw_buffer_end
  The end of the buffer.
• public string? raw_buffer_pointer
  The current position of the buffer.
• public string? raw_buffer_last
  The last filled position of the buffer.
• public Encoding encoding
  The stream encoding.
• public int canonical
  If the output is in the canonical style?
• public int best_indent
  The number of indentation spaces.
• public int best_width
  The preferred width of the output lines.
• public int unicode
  Allow unescaped non-ASCII characters?
• public Break line_break
  The preferred line break.
• public EmitterState? states_start
  The beginning of the stack of states.
• public EmitterState? states_end
  The end of the stack of states.
• public EmitterState? states_top
  The top of the stack of states.
• public EmitterState state
  The current emitter state.
• public Event? events_start
  The beginning of the event queue.
• public Event? events_end
  The end of the event queue.
• public Event? events_head
  The head of the event queue.
• public Event? events_tail
  The tail of the event queue.
• public int? indents_start
  The beginning of the stack of indentation levels.
• public int? indents_end
  The end of the stack of indentation levels.
• public int? indents_top
  The top of the stack of indentation levels.
• public TagDirective? tag_directives_start
  The beginning of the list.
• public TagDirective? tag_directives_end
  The end of the list.
• public TagDirective? tag_directives_top
  The top of the list.
• public int indent
  The current indentation level.
• public int flow_level
  The current flow level.
• public int root_context
  Is it the document root context?
• public int sequence_context
  Is it a sequence context?
• public int mapping_context
  Is it a mapping context?
• public int simple_key_context
  Is it a simple mapping key context?
• public int line
  The current line.
• public int column
  The current column.
• public int whitespace
  If the last character was a whitespace?
• public int indention
  If the last character was an indentation character (' ', '-', '?', ':')?
• public int open_ended
  If an explicit document end is required?
• public string? anchor_data_anchor
  The anchor value.
• public size_t anchor_data_anchor_length
  The anchor length.
• public int anchor_data_alias
  Is it an alias?
• public string? tag_data_handle
  The tag handle.
• public size_t tag_data_handle_length
  The tag handle length.
• public string? tag_data_suffix
  The tag suffix.
• public size_t tag_data_suffix_length
  The tag suffix length.
• public string? scalar_data_value
  The scalar value.
• public size_t scalar_data_length
  The scalar length.
• public int scalar_data_multiline
  Does the scalar contain line breaks?
• public int scalar_data_flow_plain_allowed
  Can the scalar be expessed in the flow plain style?
• public int scalar_data_block_plain_allowed
  Can the scalar be expressed in the block plain style?
• public int scalar_data_single_quoted_allowed
  Can the scalar be expressed in the single quoted style?
• public int scalar_data_block_allowed
  Can the scalar be expressed in the literal or folded styles?
• public ScalarStyle scalar_data_style
  The output style.
• public int opened
  If the stream was already opened?
• public int closed
  If the stream was already closed?
• public EmitterDocumentAssociatedInfo? anchors
• public int last_anchor_id
  The last assigned anchor id.
• public Document? document
  The currently emitted document.