using System;

namespace Framework.Storage.Containers {

  /// <summary>Serializer for a persistent state</summary>
  /// <typeparam name="TState">Type of state the serializer will persist</typeparam>
  public interface IPersistentStateSerializer<TState> where TState : class {

    /// <summary>Default filename that will be used for the serialized state</summary>
    string DefaultFilename { get; }

    /// <summary>Reads the persistent state from a file</summary>
    /// <param name="state">State into which the file will be saved</param>
    /// <param name="path">Path fo the file containing the saved state</param>
    /// <returns>True if the state is genuine, false if it was modified</returns>
    bool Load(TState state, string path);

    /// <summary>Saves the persistent state into a file</summary>
    /// <param name="state">State that will be saved into a file</param>
    /// <param name="path">Path of a file the state will be saved into</param>
    void Save(TState state, string path);

  }
  
} // namespace Framework.Storage.Containers