DataStreamSerializer Protocol Reference

SerializedObject
Type produced from the serialized Data.
Declaration
Swift

associatedtype SerializedObject : Sendable


                    
                    
                    serialize(_:)

Serializes incoming Data into a SerializedObject value.

Throws

Any error produced during serialization.

Declaration

Swift

func serialize(_ data: Data) throws -> SerializedObject

Parameters


                                data

Data to be serialized.

Serialization


                    
                    
                    decodable(of:decoder:dataPreprocessor:)

Extension method

Creates a DecodableStreamSerializer instance with the provided DataDecoder and DataPreprocessor.

Declaration

Swift

public static func decodable<T: Decodable>(of type: T.Type,
                                           decoder: any DataDecoder = JSONDecoder(),
                                           dataPreprocessor: any DataPreprocessor = PassthroughPreprocessor()) -> Self where Self == DecodableStreamSerializer<T>

Parameters

`type`	`Decodable` type to decode from stream data.
`decoder`	`DataDecoder` used to decode incoming `Data`. `JSONDecoder()` by default.
`dataPreprocessor`	`DataPreprocessor` used to process incoming `Data` before it’s passed through the `decoder`. `PassthroughPreprocessor()` by default.

Available where `Self` == `PassthroughStreamSerializer`

passthrough Extension method
Provides a PassthroughStreamSerializer instance.
Declaration
Swift

public static var passthrough: PassthroughStreamSerializer { get }

Available where `Self` == `StringStreamSerializer`

string Extension method
Provides a StringStreamSerializer instance.
Declaration
Swift

public static var string: StringStreamSerializer { get }

DataStreamSerializer

Declaration

Declaration

Parameters

Serialization

Declaration

Parameters

Available where Self == PassthroughStreamSerializer

Declaration

Available where Self == StringStreamSerializer

Declaration

Available where `Self` == `PassthroughStreamSerializer`

Available where `Self` == `StringStreamSerializer`