YAML gem for mruby
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 1 commit behind hone:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
README.md
mrbgem.rake

README.md

mruby-yaml

YAML gem for mruby

mruby-yaml wraps libyaml and therefore complies with the YAML 1.1 standard. File IO is not supported, as this would create a dependency on other mruby gems.

Defines

Name Default Description
MRUBY_YAML_NULL true enables null, Null, NULL
MRUBY_YAML_BOOLEAN_ON true enables on, On, ON
MRUBY_YAML_BOOLEAN_YES true enables yes, Yes, YES
MRUBY_YAML_BOOLEAN_SHORTHAND_YES true enables y, Y
MRUBY_YAML_BOOLEAN_OFF true enables off, Off, OFF
MRUBY_YAML_BOOLEAN_NO true enables no, No, NO
MRUBY_YAML_BOOLEAN_SHORTHAND_NO true enables n, N

If you need to check if a feature is supported at runtime, replace MRUBY_YAML_ with SUPPORT_ for the runtime equivalent.

EG.

if YAML::SUPPORT_NULL
  YAML.load('null') == nil
else  
  YAML.load('null') == 'null'
end

Documentation

YAML.load(yaml_str)

Converts a YAML 1.1 string to a Ruby object containing hashes, arrays, and strings. YAML scalars (i.e. strings) are converted to Fixnum or Floats if possible.

YAML.dump(obj)

Converts a Ruby object to a YAML 1.1 string. Arrays, Hashes, and their subclasses are represented as YAML sequences and mapping nodes. Other objects are converted to strings and represented as scalars.