clang 17.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
Collaboration diagram for clang::extractapi::APISerializer:
Collaboration graph

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

const APISetAPI
const APIIgnoresListIgnoresList
 The list of symbols to ignore.
APISerializerOption Options

Detailed Description

The base interface of serializers for API information.

Definition at line 31 of file SerializerBase.h.

Constructor & Destructor Documentation

◆ APISerializer() [1/4]

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

◆ APISerializer() [2/4]

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

◆ APISerializer() [3/4]

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

◆ APISerializer() [4/4]

clang::extractapi::APISerializer::APISerializer ( const APISet API,
const APIIgnoresList IgnoresList,
APISerializerOption  Options = {} 

Definition at line 54 of file SerializerBase.h.

◆ ~APISerializer()

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

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ 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


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

◆ IgnoresList

const APIIgnoresList& clang::extractapi::APISerializer::IgnoresList

The list of symbols to ignore.

Note: This should be consulted before emitting a symbol.

Definition at line 42 of file SerializerBase.h.

◆ Options

APISerializerOption clang::extractapi::APISerializer::Options

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