Show / Hide Table of Contents

Struct DecodingContext

Represents text decoding context.

Implements
ICloneable
Inherited Members
ValueType.Equals(Object)
ValueType.GetHashCode()
ValueType.ToString()
Object.Equals(Object, Object)
Object.GetType()
Object.ReferenceEquals(Object, Object)
Namespace: DotNext.Text
Assembly: DotNext.IO.dll
Syntax
public struct DecodingContext : ICloneable
Remarks

The context represents a decoding cache to avoid memory allocations for each round of string decoding caused by methods of StreamExtensions class. It cannot be shared across parallel flows or threads. However, you can call Copy() method to create an independent copy of this context for separated async flow or thread.

Constructors

| Improve this Doc View Source

DecodingContext(Encoding, Boolean)

Initializes a new decoding context.

Declaration
public DecodingContext(Encoding encoding, bool reuseDecoder = false)
Parameters
Type Name Description
Encoding encoding

The encoding to be used for converting bytes into string.

Boolean reuseDecoder

true to reuse the decoder between decoding operations; false to create separated encoder for each encoding operation.

Exceptions
Type Condition
ArgumentNullException

encoding is null.

Properties

| Improve this Doc View Source

Encoding

Gets encoding associated with this context.

Declaration
public Encoding Encoding { get; }
Property Value
Type Description
Encoding

Methods

| Improve this Doc View Source

Copy()

Creates independent copy of this context that can be used in separated async flow or thread.

Declaration
public DecodingContext Copy()
Returns
Type Description
DecodingContext

The independent copy of this context.

| Improve this Doc View Source

Reset()

Sets the encapsulated decoder to its initial state.

Declaration
public void Reset()

Operators

| Improve this Doc View Source

Implicit(Encoding to DecodingContext)

Creates decoding context.

Declaration
public static implicit operator DecodingContext(Encoding encoding)
Parameters
Type Name Description
Encoding encoding

The text encoding.

Returns
Type Description
DecodingContext

Explicit Interface Implementations

| Improve this Doc View Source

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
Object

Implements

System.ICloneable

Extension Methods

Sequence.Skip<TEnumerator, T>(ref TEnumerator, Int32)
ExpressionBuilder.Const<T>(T)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX