Skip to main content

IPipelineDebugSerializer

Namespace: Meshmakers.Octo.Sdk.Common.EtlDataPipeline.Debugger

Interface for pipeline debug serializer

public interface IPipelineDebugSerializer

Methods​

SerializeAsync(DebugInformationRoot)​

Serializes the debug information root to a string

Task<string> SerializeAsync(DebugInformationRoot debugInformationRoot)

Parameters​

debugInformationRoot DebugInformationRoot
Debug information root to serialize

Returns​

Task<String>

SerializeAsync(StreamWriter, DebugInformationRoot)​

Serializes the debug information root to a stream

Task SerializeAsync(StreamWriter streamWriter, DebugInformationRoot debugInformationRoot)

Parameters​

streamWriter StreamWriter
A stream ready to write used for serialization

debugInformationRoot DebugInformationRoot
Debug information root to serialize

Returns​

Task

DeserializeAsync(String)​

Deserializes the debug information root from a string

Task<DebugInformationRoot> DeserializeAsync(string formattedText)

Parameters​

formattedText String
Formatted text to deserialize

Returns​

Task<DebugInformationRoot>
Deserialized debug information root

DeserializeAsync(Stream, Nullable<CancellationToken>)​

Deserializes the debug information root from a stream

Task<DebugInformationRoot> DeserializeAsync(Stream stream, Nullable<CancellationToken> cancellationToken)

Parameters​

stream Stream
The stream to read

cancellationToken Nullable<CancellationToken>
Token to cancel the operation

Returns​

Task<DebugInformationRoot>
Deserialized debug information root