Struct Emitter 

pub struct Emitter<W: Write> { /* private fields */ }

A SIF document emitter.

Implementations

impl<W: Write> Emitter<W>

Extension methods for emitting streaming directives.

pub fn emit_stream_start( &mut self, id: Option<&str>, mode: StreamMode, ) -> Result<()>

Write #stream start with optional attributes.

pub fn emit_stream_end( &mut self, id: Option<&str>, records: Option<u64>, ) -> Result<()>

Write #stream end with optional attributes.

pub fn emit_heartbeat(&mut self, timestamp: Option<&str>) -> Result<()>

Write #heartbeat with optional timestamp.

pub fn emit_status(&mut self, level: StatusLevel, message: &str) -> Result<()>

Write #status <level> <message>.

pub fn emit_pause(&mut self) -> Result<()>

Write #pause.

pub fn emit_resume(&mut self) -> Result<()>

Write #resume.

pub fn emit_error(&mut self, message: &str) -> Result<()>

Write #error <message>.

impl<W: Write> Emitter<W>

pub fn new(out: W) -> Self

pub fn emit_document(&mut self, doc: &Document) -> Result<()>

Write a complete document.

pub fn emit_header(&mut self, header: &Header) -> Result<()>

Write the header line.

pub fn emit_section_break(&mut self) -> Result<()>

Write a section break.

pub fn emit_section_id(&mut self, id: &str) -> Result<()>

Write a section identifier.

pub fn emit_section(&mut self, section: &Section) -> Result<()>

Write a complete section.

pub fn emit_schema(&mut self, schema: &Schema) -> Result<()>

Write a #schema directive.

pub fn emit_record(&mut self, record: &Record) -> Result<()>

Write a data record.

pub fn emit_directive(&mut self, directive: &Directive) -> Result<()>

Write a directive.

pub fn emit_block(&mut self, block: &Block) -> Result<()>

Write a block.

pub fn emit_template(&mut self, template: &Template) -> Result<()>

Write a template.

pub fn emit_recall(&mut self) -> Result<()>

Write a #recall schema directive.

pub fn writer_mut(&mut self) -> &mut W

Get a mutable reference to the underlying writer.

pub fn into_inner(self) -> W

Consume the emitter and return the underlying writer.