NAME

DDC::Format::YAML - YAML::XS formatting for DDC hits

SYNOPSIS

 use DDC::Concordance;

 @hits = DDC::Client::Distributed->new()->query('foo&&bar'); ##-- get some hits

 $fmt = DDC::Format::YAML->new();
 $str = $fmt->toString(\@hits);        ##-- conversion to string
 $fmt->toFile(\@hits,$filename);       ##-- output to file
 $fmt->toFh(\@hits,$fh);               ##-- output to filehandle

DESCRIPTION

Class for formatting DDC::Hit objects as perl code using YAML::XS.

Globals

Variable: @ISA

DDC::Format::YAML inherits from DDC::Format.

Constructors, etc.

new
 $fmt = $CLASS_OR_OBJ->new(%args);

Accepted keywords in %args:

 (
  #level  => $bool,   ##-- pretty-print?  ##-- NOT USED
 )
reset
 $fmt = $fmt->reset();

Resets the formatting object.

Helper functions

hitString
 $hitStr = $fmt->hitString($hit);

Formats a single $hit as a string.

API

toString
 $str = $fmt->toString(\@hits);

Implements DDC::Format::toString().

AUTHOR

Bryan Jurish <moocow@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2011-2016 by Bryan Jurish

This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.2 or, at your option, any later version of Perl 5 you may have available.