aboutsummaryrefslogtreecommitdiff
path: root/Plugins.Essentials/src/Extensions/IJsonSerializerBuffer.cs
blob: 34811f47aac9db78b992544bf9b147b53123bc1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Essentials
* File: IJsonSerializerBuffer.cs 
*
* IJsonSerializerBuffer.cs is part of VNLib.Plugins.Essentials which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Essentials is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

using System.IO;

#nullable enable

namespace VNLib.Plugins.Essentials.Extensions
{
    /// <summary>
    /// Interface for a buffer that can be used to serialize objects to JSON
    /// </summary>
    interface IJsonSerializerBuffer
    {
        /// <summary>
        /// Gets a stream used for writing serialzation data to
        /// </summary>
        /// <returns>The stream to write JSON data to</returns>
        Stream GetSerialzingStream();

        /// <summary>
        /// Called when serialization is complete.
        /// The stream may be inspected for the serialized data.
        /// </summary>
        void SerializationComplete();
    }
}