Samples.SerializeObjectGraph

Serializing an object graph

Shows how to convert an object to its YAML representation.

Code

using System;
using YamlDotNet.Serialization;
using YamlDotNet.Samples.Helpers;
using Xunit.Abstractions;

namespace YamlDotNet.Samples
{
    public class SerializeObjectGraph
    {
        private readonly ITestOutputHelper output;

        public SerializeObjectGraph(ITestOutputHelper output)
        {
            this.output = output;
        }

        [Sample(
            DisplayName = "Serializing an object graph",
            Description = "Shows how to convert an object to its YAML representation."
        )]
        public void Main()
        {
            var address = new Address
            {
                street = "123 Tornado Alley\nSuite 16",
                city = "East Westville",
                state = "KS"
            };

            var receipt = new Receipt
            {
                receipt = "Oz-Ware Purchase Invoice",
                date = new DateTime(2007, 8, 6),
                customer = new Customer
                {
                    given = "Dorothy",
                    family = "Gale"
                },
                items = new Item[]
                {
                    new Item
                    {
                        part_no = "A4786",
                        descrip = "Water Bucket (Filled)",
                        price = 1.47M,
                        quantity = 4
                    },
                    new Item
                    {
                        part_no = "E1628",
                        descrip = "High Heeled \"Ruby\" Slippers",
                        price = 100.27M,
                        quantity = 1
                    }
                },
                bill_to = address,
                ship_to = address,
                specialDelivery = "Follow the Yellow Brick\n" +
                                  "Road to the Emerald City.\n" +
                                  "Pay no attention to the\n" +
                                  "man behind the curtain."
            };

            var serializer = new SerializerBuilder().Build();
            var yaml = serializer.Serialize(receipt);
            output.WriteLine(yaml);
        }
    }

    public class Address {
        public string street { get; set; }
        public string city   { get; set; }
        public string state  { get; set; }
    }

    public class Receipt {
        public string   receipt         { get; set; }
        public DateTime date            { get; set; }
        public Customer customer        { get; set; }
        public Item[]   items           { get; set; }
        public Address  bill_to         { get; set; }
        public Address  ship_to         { get; set; }
        public string   specialDelivery { get; set; }
    }

    public class Customer {
        public string given  { get; set; }
        public string family { get; set; }
    }

    public class Item {
        public string  part_no  { get; set; }
        public string  descrip  { get; set; }
        public decimal price    { get; set; }
        public int     quantity { get; set; }
    }
}

Output

receipt: Oz-Ware Purchase Invoice
date: 2007-08-06T00:00:00.0000000
customer:
  given: Dorothy
  family: Gale
items:
- part_no: A4786
  descrip: Water Bucket (Filled)
  price: 1.47
  quantity: 4
- part_no: E1628
  descrip: High Heeled "Ruby" Slippers
  price: 100.27
  quantity: 1
bill_to: &o0
  street: >-
    123 Tornado Alley

    Suite 16
  city: East Westville
  state: KS
ship_to: *o0
specialDelivery: >-
  Follow the Yellow Brick

  Road to the Emerald City.

  Pay no attention to the

  man behind the curtain.