Show / Hide Table of Contents

Class Serializer

Contains all JSON serialization methods.

Inheritance
System.Object
Serializer
Namespace: CycloneDX.Json
Assembly: CycloneDX.Core.dll
Syntax
public static class Serializer : object

Methods

| Improve this Doc View Source

Deserialize(String)

Deserializes CycloneDX JSON document from a string.

Declaration
public static Bom Deserialize(string jsonString)
Parameters
Type Name Description
System.String jsonString
Returns
Type Description
Bom
| Improve this Doc View Source

DeserializeAsync(Stream)

Dserializes CycloneDX JSON document from a stream.

Declaration
public static async Task<Bom> DeserializeAsync(Stream jsonStream)
Parameters
Type Name Description
Stream jsonStream
Returns
Type Description
Task<Bom>
| Improve this Doc 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
System.String
| Improve this Doc View Source

SerializeAsync(Bom, Stream)

Serializes a CycloneDX BOM writing the output to a stream.

Declaration
public static async Task SerializeAsync(Bom bom, Stream outputStream)
Parameters
Type Name Description
Bom bom
Stream outputStream
Returns
Type Description
Task
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX