serverpod_serialization library

Classes

Namespace
ProtocolSerialization
The ProtocolSerialization defines a toJsonForProtocol method which makes it possible to limit what fields are serialized
SerializableEntity
DEPRECATED: This class is deprecated and will be removed in version 2.1. Please implement the SerializableModel interface instead for creating serializable models.
SerializableModel
The SerializableModel is the base interface for all serializable objects in Serverpod, except primitives.
SerializationManager
The SerializationManager is responsible for creating objects from a serialization, but also for serializing objects. This class is typically extended by generated code.
Uuid
uuid for Dart Author: Yulian Kuncheff Released under MIT License.
UuidValue

Enums

ValidationMode
The options for UUID Validation strictness

Extensions

Base64Dec on String
Extension for decoding ByteData in protocol.
Base64Enc on ByteData
Extension for encoding ByteData in the protocol.
ByteDataJsonExtension on ByteData
Expose toJson on ByteData Expose static fromJson builder
CloneByteData on ByteData
Adds clone method that create a deep copy of a ByteData.
CloneList on List
Adds clone method that create a deep copy of a list.
CloneMap on Map
Adds clone method that create a deep copy of a map.
DateTimeJsonExtension on DateTime
Expose toJson on DateTime Expose static fromJson builder
DurationJsonExtension on Duration
Expose toJson on Duration Expose static fromJson builder
ListJsonExtension on List<T>
Expose toJson on List
MapJsonExtension on Map<K, V>
Expose toJson on Map
UuidValueJsonExtension on UuidValue
Expose toJson on UuidValue Expose static fromJson builder

Constants

autoSerializedTypes → const List<String>
All datatypes that are serialized by default. Used internally in Serverpod code generation.
clonableTypeNames → const List<String>
List of types that has a clone method extension and therefore can be copied by calling clone().
extensionSerializedTypes → const List<String>
All datatypes that has extensions to support serialization. Used internally in Serverpod code generation.

Properties

noneMutableTypeNames List<String>
List of types that are not mutable and therefore do not need to be copied or handled in a copyWith method.
final

Functions

getType<T>() Type
Get the type provided as an generic. Useful for getting a nullable type.

Exceptions / Errors

DeserializationTypeNotFoundException
Exception thrown when no deserialization type was found during protocol deserialization
SerializableException
This is SerializableException that can be used to pass Domain exceptions from the Server to the Client