JsonEncodedText.Encode Method

Definition

Namespace: Corvus.Text.Json
Assembly: Corvus.Text.Json.dll

Method	Description
Encode(string, JavaScriptEncoder)	Encodes the string text value as a JSON string.
Encode(ReadOnlySpan<char>, JavaScriptEncoder)	Encodes the text value as a JSON string.
Encode(ReadOnlySpan<byte>, JavaScriptEncoder)	Encodes the UTF-8 text value as a JSON string.

Source: JsonEncodedText.cs

Encodes the string text value as a JSON string.

public static JsonEncodedText Encode(string value, JavaScriptEncoder encoder)

Name	Type	Description
`value`	`string`	The value to be transformed as JSON encoded text.
`encoder`	`JavaScriptEncoder`	The encoder to use when escaping the string, or `null` to use the default encoder. (optional)

Exception	Description
`ArgumentNullException`	Thrown if value is null.
`ArgumentException`	Thrown when the specified value is too large or if it contains invalid UTF-16 characters.

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

Source: JsonEncodedText.cs

Encodes the text value as a JSON string.

public static JsonEncodedText Encode(ReadOnlySpan<char> value, JavaScriptEncoder encoder)

Name	Type	Description
`value`	`ReadOnlySpan<char>`	The value to be transformed as JSON encoded text.
`encoder`	`JavaScriptEncoder`	The encoder to use when escaping the string, or `null` to use the default encoder. (optional)

Exception	Description
`ArgumentException`	Thrown when the specified value is too large or if it contains invalid UTF-16 characters.

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

Source: JsonEncodedText.cs

Encodes the UTF-8 text value as a JSON string.

public static JsonEncodedText Encode(ReadOnlySpan<byte> utf8Value, JavaScriptEncoder encoder)

Name	Type	Description
`utf8Value`	`ReadOnlySpan<byte>`	The UTF-8 encoded value to be transformed as JSON encoded text.
`encoder`	`JavaScriptEncoder`	The encoder to use when escaping the string, or `null` to use the default encoder. (optional)

Exception	Description
`ArgumentException`	Thrown when the specified value is too large or if it contains invalid UTF-8 bytes.

Product	Versions
.NET	9, 10
.NET Standard	2.0, 2.1

The source for this content can be found on GitHub, where you can also create and review issues and pull requests.