Struct StringConverter

Namespace

DynaSharp.Serialization

Assembly

DynaSharp.dll

Converts string to and from a string value (S).

public readonly struct StringConverter : IDynamoDbConverter<string>

Implements

IDynamoDbConverter<string>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

A null string cannot be written as a value: a converter of a nullable type writes {"NULL":true} instead, see NullableReferenceConverter<T, TConverter>. The empty string is a valid value, except in key attributes, which DynamoDB validates.

Explicit Interface Implementations

Read(ref DynamoDbReader, AttributeType)

Reads the attribute value the reader is positioned on.

static string 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

string

The value.

Exceptions

JsonException

type is not String.

Write(DynamoDbWriter, string)

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

static void Write(DynamoDbWriter writer, string 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 string

The value.

Exceptions

ArgumentNullException

value is null.