clang  16.0.0git
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::extractapi::APISerializer Class Referenceabstract

The base interface of serializers for API information. More...

#include "clang/ExtractAPI/Serialization/SerializerBase.h"

Inheritance diagram for clang::extractapi::APISerializer:
Inheritance graph
[legend]
Collaboration diagram for clang::extractapi::APISerializer:
Collaboration graph
[legend]

Public Member Functions

virtual void serialize (raw_ostream &os)=0
 Serialize the API information to os. More...
 
 APISerializer ()=delete
 
 APISerializer (const APISerializer &)=delete
 
 APISerializer (APISerializer &&)=delete
 
APISerializeroperator= (const APISerializer &)=delete
 
APISerializeroperator= (APISerializer &&)=delete
 

Protected Member Functions

 APISerializer (const APISet &API, StringRef ProductName, APISerializerOption Options={})
 
virtual ~APISerializer ()=default
 

Protected Attributes

const APISetAPI
 
StringRef ProductName
 The product name of API. More...
 
APISerializerOption Options
 

Detailed Description

The base interface of serializers for API information.

Definition at line 30 of file SerializerBase.h.

Constructor & Destructor Documentation

◆ APISerializer() [1/4]

clang::extractapi::APISerializer::APISerializer ( )
delete

◆ APISerializer() [2/4]

clang::extractapi::APISerializer::APISerializer ( const APISerializer )
delete

◆ APISerializer() [3/4]

clang::extractapi::APISerializer::APISerializer ( APISerializer &&  )
delete

◆ APISerializer() [4/4]

clang::extractapi::APISerializer::APISerializer ( const APISet API,
StringRef  ProductName,
APISerializerOption  Options = {} 
)
inlineprotected

Definition at line 53 of file SerializerBase.h.

◆ ~APISerializer()

virtual clang::extractapi::APISerializer::~APISerializer ( )
protectedvirtualdefault

Member Function Documentation

◆ operator=() [1/2]

APISerializer& clang::extractapi::APISerializer::operator= ( APISerializer &&  )
delete

◆ operator=() [2/2]

APISerializer& clang::extractapi::APISerializer::operator= ( const APISerializer )
delete

◆ serialize()

void APISerializer::serialize ( raw_ostream &  os)
pure virtual

Serialize the API information to os.

Implemented in clang::extractapi::SymbolGraphSerializer.

Definition at line 19 of file SerializerBase.cpp.

Member Data Documentation

◆ API

const APISet& clang::extractapi::APISerializer::API
protected

Definition at line 36 of file SerializerBase.h.

◆ Options

APISerializerOption clang::extractapi::APISerializer::Options
protected

Definition at line 43 of file SerializerBase.h.

◆ ProductName

StringRef clang::extractapi::APISerializer::ProductName
protected

The product name of API.

Note: This should be used for populating metadata about the API.

Definition at line 41 of file SerializerBase.h.


The documentation for this class was generated from the following files: