analytics-dotnet-client/src/Couchbase.Core/Json/IJsonToken.cs at d6368508449487c16e191f676e5cea8a8e01468c · couchbaselabs/analytics-dotnet-client · GitHub

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
#region License
/* ************************************************************
 *
 *    @author Couchbase <info@couchbase.com>
 *    @copyright 2025 Couchbase, Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 *
 * ************************************************************/
#endregion

namespace Couchbase.Core.Json;

/// <summary>
/// Used to support dynamic object reading during streaming JSON deserialization.
/// </summary>
/// <seealso cref="IJsonStreamReader" />
public interface IJsonToken
{
    /// <summary>
    /// Gets the value of a particular attribute of this token.
    /// Returns null if the attribute is not found.
    /// </summary>
    /// <param name="key">Name of the attribute.</param>
    IJsonToken? this[string key] { get; }

    /// <summary>
    /// Deserializes the token to an object.
    /// </summary>
    /// <typeparam name="T">Type of object.</typeparam>
    /// <returns>The object.</returns>
    T ToObject<T>();

    /// <summary>
    /// Returns the token cast as a particular type, such as a string or integer.
    /// </summary>
    /// <typeparam name="T">Type to cast.</typeparam>
    /// <returns>The value.</returns>
    T Value<T>();

    /// <summary>
    /// Returns a dynamic object representing the current token.
    /// </summary>
    /// <returns>The dynamic object.</returns>
    dynamic ToDynamic();

    /// <summary>
    /// Returns the raw UTF-8 JSON bytes for this token.
    /// </summary>
    /// <returns>UTF-8 encoded JSON bytes.</returns>
    byte[] ToUtf8Bytes();
}


#region License
/* ************************************************************
 *
 *    @author Couchbase <info@couchbase.com>
 *    @copyright 2025 Couchbase, Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 *
 * ************************************************************/
#endregion