Struct DocumentConverter<T>

Namespace

DynaSharp.Serialization

Assembly

DynaSharp.dll

Converts a mapped document or entity to and from a map value (M), which is how a type nests in another: an address in a customer, or the lines of an order through ListConverter<T, TConverter>. The attributes are the ones T writes as an item of its own.

public readonly struct DocumentConverter<T> : IDynamoDbConverter<T> where T : IDynamoDbDocument<T>

Type Parameters

T

The document.

Implements

IDynamoDbConverter<T>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

Infrastructure: compatible only within a package version, because generated code comes from the generator of the same package.

Explicit Interface Implementations

Read(ref DynamoDbReader, AttributeType)

Reads the attribute value the reader is positioned on.

static T Read(ref DynamoDbReader reader, AttributeType type)

Parameters

reader DynamoDbReader

The reader, positioned on the value after ReadStartAttribute() or TryReadStartAttribute(out AttributeType). The caller reads the closing brace afterwards, so the converter must read the value completely (all elements of a list, map or set) and nothing more.

type AttributeType

The DynamoDB type of the value. Check it with Expect(AttributeType, AttributeType), which throws JsonException for types the converter does not support. Null is passed to the converter too, so it can map it to null where that makes sense.

Returns

T

The value.

Exceptions

JsonException

type is not Map.

DynamoDbMappingException

The map cannot be read as T.

Write(DynamoDbWriter, T)

Writes a value as one complete attribute value, for example with WriteNumber<T>(T).

static void Write(DynamoDbWriter writer, T value)

Parameters

writer DynamoDbWriter

The writer, positioned where a value is expected (after an attribute name, or inside a list). It is a ref struct, so it is never null and needs no check.

value T

The value.

Exceptions

ArgumentNullException

value is null.