### ----------------------------------------------------
### -- Serialise::Map
### -- Licenses: Artistic-2.0
### -- Authors: Sam Gillespie
### -- File: README.md
### ----------------------------------------------------
[![Build Status](https://travis-ci.org/samgwise/p6-mappable.svg?branch=master)](https://travis-ci.org/samgwise/p6-mappable)

Serialise::Map
==============

Serialise::Map - a composable interface for serialising objects

SYNOPSIS
========

    use Serialise::Map;
    use Test;

    class Foo does Serialise::Map {
      has $.value;

      to-map( --> Map) {
        %(
          :$!value
        )
      }

      from-map(Map $map --> Foo) {
        self.new(|$map)
      }
    }

    my $obj = Foo.new( :value('Bar') );

    # Test your implementations!
    is-deeply $obj.to-map, $obj.from-map($obj.to-map), "";

DESCRIPTION
===========

Serialise::Map is a simple interface that specifies a simple contract. I can give you a map, which represents my current state and consume a map to recreate my current state. Although round trip safe behaviour is not guaranteed it is probably expected so it is recommended for your users to keep this in mind.

AUTHOR
======

Sam Gillespie <samgwise@gmail.com>

COPYRIGHT AND LICENSE
=====================

Copyright 2017 Sam Gillespie

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.



