Class Serializer

Contains all JSON serialization methods.

Inheritance
object
Serializer
Inherited Members
Namespace: CycloneDX.Json
Assembly: CycloneDX.Core.dll
Syntax
public static class Serializer

Methods

| Edit this page View Source

Deserialize(string)

Deserializes CycloneDX JSON document from a string.

Declaration
public static Bom Deserialize(string jsonString)
Parameters
Type Name Description
string jsonString
Returns
Type Description
Bom
| Edit this page View Source

DeserializeAsync(Stream)

Dserializes CycloneDX JSON document from a stream.

Declaration
public static Task<Bom> DeserializeAsync(Stream jsonStream)
Parameters
Type Name Description
Stream jsonStream
Returns
Type Description
Task<Bom>
| Edit this page View Source

Serialize(Bom)

Serializes a CycloneDX BOM returning the output as a string.

Declaration
public static string Serialize(Bom bom)
Parameters
Type Name Description
Bom bom
Returns
Type Description
string
| Edit this page View Source

SerializeAsync(Bom, Stream)

Serializes a CycloneDX BOM writing the output to a stream.

Declaration
public static Task SerializeAsync(Bom bom, Stream outputStream)
Parameters
Type Name Description
Bom bom
Stream outputStream
Returns
Type Description
Task