Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class BaseTranscoder

Inheritance
object
BaseTranscoder
JsonTranscoder
LegacyTranscoder
RawBinaryTranscoder
RawJsonTranscoder
RawStringTranscoder
Implements
ITypeTranscoder
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Couchbase.Core.IO.Transcoders
Assembly: Couchbase.NetClient.dll
Syntax
public abstract class BaseTranscoder : ITypeTranscoder

Constructors

View Source

BaseTranscoder()

Declaration
protected BaseTranscoder()

Properties

View Source

Serializer

Gets or sets the serializer used by the ITypeTranscoder implementation.

Declaration
public ITypeSerializer? Serializer { get; set; }
Property Value
Type Description
ITypeSerializer

Methods

View Source

DecodeBinary(ReadOnlySpan<byte>)

Decodes the binary.

Declaration
protected byte[] DecodeBinary(ReadOnlySpan<byte> buffer)
Parameters
Type Name Description
ReadOnlySpan<byte> buffer

The buffer.

Returns
Type Description
byte[]
View Source

DecodeChar(ReadOnlySpan<byte>)

Decodes the specified buffer as char.

Declaration
protected char DecodeChar(ReadOnlySpan<byte> buffer)
Parameters
Type Name Description
ReadOnlySpan<byte> buffer

The buffer.

Returns
Type Description
char
View Source

DecodeString(ReadOnlySpan<byte>)

Decodes the specified buffer as string.

Declaration
protected string? DecodeString(ReadOnlySpan<byte> buffer)
Parameters
Type Name Description
ReadOnlySpan<byte> buffer

The buffer.

Returns
Type Description
string
View Source

Decode<T>(ReadOnlyMemory<byte>, Flags, OpCode)

Decodes the specified buffer.

Declaration
public abstract T? Decode<T>(ReadOnlyMemory<byte> buffer, Flags flags, OpCode opcode)
Parameters
Type Name Description
ReadOnlyMemory<byte> buffer

The buffer representing the value of the key to decode.

Flags flags

The flags used to encode the payload.

OpCode opcode
Returns
Type Description
T
Type Parameters
Name Description
T
View Source

DeserializeAsJson<T>(ReadOnlyMemory<byte>)

Deserializes as json.

Declaration
public virtual T? DeserializeAsJson<T>(ReadOnlyMemory<byte> buffer)
Parameters
Type Name Description
ReadOnlyMemory<byte> buffer

The buffer.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

Encode<T>(Stream, T, Flags, OpCode)

Encodes the specified value.

Declaration
public abstract void Encode<T>(Stream stream, T value, Flags flags, OpCode opcode)
Parameters
Type Name Description
Stream stream

The stream to receive the encoded value.

T value

The value of the key to encode.

Flags flags

The flags used for decoding the response.

OpCode opcode
Type Parameters
Name Description
T
View Source

GetFormat<T>(T)

Get data formatting based on the generic type and/or the actual value.

Declaration
public abstract Flags GetFormat<T>(T value)
Parameters
Type Name Description
T value

Value to be formatted.

Returns
Type Description
Flags

Flags used to format value written to operation payload.

Type Parameters
Name Description
T
View Source

SerializeAsJson(Stream, object?)

Serializes as json.

Declaration
public void SerializeAsJson(Stream stream, object? value)
Parameters
Type Name Description
Stream stream

The stream to receive the encoded value.

object value

The value.

View Source

SerializeAsJson<T>(Stream, T)

Serializes as json.

Declaration
public void SerializeAsJson<T>(Stream stream, T value)
Parameters
Type Name Description
Stream stream

The stream to receive the encoded value.

T value

The value.

Type Parameters
Name Description
T

Type of value to serialize.

View Source

WriteHelper(Stream, ReadOnlySpan<byte>)

Declaration
protected void WriteHelper(Stream stream, ReadOnlySpan<byte> buffer)
Parameters
Type Name Description
Stream stream
ReadOnlySpan<byte> buffer

Implements

ITypeTranscoder
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.