view release on metacpan or  search on metacpan

lib/Parse/CPAN/Meta.pm  view on Meta::CPAN

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
and C<load_yaml_string>.  These will read and deserialize CPAN metafiles, and
are described below in detail.
 
B<Parse::CPAN::Meta> provides a legacy API of only two functions,
based on the YAML functions of the same name. Wherever possible,
identical calling semantics are used.  These may only be used with YAML sources.
 
All error reporting is done with exceptions (die'ing).
 
Note that META files are expected to be in UTF-8 encoding, only.  When
converted string data, it must first be decoded from UTF-8.
 
=begin Pod::Coverage
 
 
 
 
=end Pod::Coverage
 
=head1 METHODS

lib/Parse/CPAN/Meta.pm  view on Meta::CPAN

231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
This method will read the named file and deserialize it to a data structure,
determining whether it should be JSON or YAML based on the filename.
The file will be read using the ":utf8" IO layer.
 
=head2 load_yaml_string
 
  my $metadata_structure = Parse::CPAN::Meta->load_yaml_string($yaml_string);
 
This method deserializes the given string of YAML and returns the first
document in it.  (CPAN metadata files should always have only one document.)
If the source was UTF-8 encoded, the string must be decoded before calling
C<load_yaml_string>.
 
=head2 load_json_string
 
  my $metadata_structure = Parse::CPAN::Meta->load_json_string($json_string);
 
This method deserializes the given string of JSON and the result.
If the source was UTF-8 encoded, the string must be decoded before calling
C<load_json_string>.
 
=head2 load_string
 
  my $metadata_structure = Parse::CPAN::Meta->load_string($some_string);
 
If you don't know whether a string contains YAML or JSON data, this method
will use some heuristics and guess.  If it can't tell, it assumes YAML.
 
=head2 yaml_backend