llvm::MinidumpYAML::Stream Struct Reference

The base class for all minidump streams. More...

#include "llvm/ObjectYAML/MinidumpYAML.h"

Inheritance diagram for llvm::MinidumpYAML::Stream:

Public Types
enum class	StreamKind {   Exception , MemoryInfoList , MemoryList , Memory64List ,   ModuleList , RawContent , SystemInfo , TextContent ,   ThreadList }

Public Member Functions
	Stream (StreamKind Kind, minidump::StreamType Type)
virtual	~Stream ()

Static Public Member Functions
static StreamKind	getKind (minidump::StreamType Type)
	Get the stream Kind used for representing streams of a given Type.
static std::unique_ptr< Stream >	create (minidump::StreamType Type)
	Create an empty stream of the given Type.
static Expected< std::unique_ptr< Stream > >	create (const minidump::Directory &StreamDesc, const object::MinidumpFile &File)
	Create a stream from the given stream directory entry.

Public Attributes
const StreamKind	Kind
const minidump::StreamType	Type

Detailed Description

The base class for all minidump streams.

The "Type" of the stream corresponds to the Stream Type field in the minidump file. The "Kind" field specifies how are we going to treat it. For highly specialized streams (e.g. SystemInfo), there is a 1:1 mapping between Types and Kinds, but in general one stream Kind can be used to represent multiple stream Types (e.g. any unrecognised stream Type will be handled via RawContentStream). The mapping from Types to Kinds is fixed and given by the static getKind function.

Definition at line 27 of file MinidumpYAML.h.

Member Enumeration Documentation

StreamKind

enum class llvm::MinidumpYAML::Stream::StreamKind

strong

Enumerator
Exception
MemoryInfoList
MemoryList
Memory64List
ModuleList
RawContent
SystemInfo
TextContent
ThreadList

Definition at line 28 of file MinidumpYAML.h.

Constructor & Destructor Documentation

Stream()

llvm::MinidumpYAML::Stream::Stream ( StreamKind Kind, minidump::StreamType Type )

inline

Definition at line 40 of file MinidumpYAML.h.

References Kind, and Type.

Referenced by llvm::MinidumpYAML::detail::ListStream< detail::ParsedModule >::classof(), llvm::MinidumpYAML::ExceptionStream::classof(), llvm::MinidumpYAML::MemoryInfoListStream::classof(), llvm::MinidumpYAML::RawContentStream::classof(), llvm::MinidumpYAML::SystemInfoStream::classof(), llvm::MinidumpYAML::TextContentStream::classof(), llvm::MinidumpYAML::ExceptionStream::ExceptionStream(), llvm::MinidumpYAML::ExceptionStream::ExceptionStream(), llvm::MinidumpYAML::MemoryInfoListStream::MemoryInfoListStream(), llvm::MinidumpYAML::MemoryInfoListStream::MemoryInfoListStream(), llvm::MinidumpYAML::SystemInfoStream::SystemInfoStream(), and llvm::MinidumpYAML::SystemInfoStream::SystemInfoStream().

~Stream()

Stream::~Stream ( )

virtualdefault

Member Function Documentation

create() [1/2]

Expected< std::unique_ptr< Stream > > Stream::create ( const minidump::Directory & StreamDesc, const object::MinidumpFile & File )

static

Create a stream from the given stream directory entry.

Definition at line 496 of file MinidumpYAML.cpp.

References Exception, getKind(), Kind, llvm_unreachable, Memory64List, MemoryInfoList, MemoryList, ModuleList, RawContent, llvm::Error::success(), SystemInfo, T, llvm::Expected< T >::takeError(), TextContent, ThreadList, llvm::toStringRef(), and llvm::minidump::Directory::Type.

create() [2/2]

std::unique_ptr< Stream > Stream::create ( minidump::StreamType Type )

static

Create an empty stream of the given Type.

Definition at line 98 of file MinidumpYAML.cpp.

References Exception, getKind(), Kind, llvm_unreachable, Memory64List, MemoryInfoList, MemoryList, ModuleList, RawContent, SystemInfo, TextContent, ThreadList, and Type.

Referenced by llvm::MinidumpYAML::Object::create().

getKind()

Stream::StreamKind Stream::getKind ( minidump::StreamType Type )

static

Get the stream Kind used for representing streams of a given Type.

Definition at line 69 of file MinidumpYAML.cpp.

References Exception, Memory64List, MemoryInfoList, MemoryList, ModuleList, RawContent, SystemInfo, TextContent, ThreadList, and Type.

Referenced by create(), and create().

Member Data Documentation

Kind

const StreamKind llvm::MinidumpYAML::Stream::Kind

Definition at line 43 of file MinidumpYAML.h.

Referenced by llvm::MinidumpYAML::detail::ListStream< detail::ParsedModule >::classof(), llvm::MinidumpYAML::ExceptionStream::classof(), llvm::MinidumpYAML::MemoryInfoListStream::classof(), llvm::MinidumpYAML::RawContentStream::classof(), llvm::MinidumpYAML::SystemInfoStream::classof(), llvm::MinidumpYAML::TextContentStream::classof(), create(), create(), layout(), and Stream().

Type

const minidump::StreamType llvm::MinidumpYAML::Stream::Type

Definition at line 44 of file MinidumpYAML.h.

Referenced by create(), getKind(), layout(), llvm::MinidumpYAML::RawContentStream::RawContentStream(), Stream(), and llvm::MinidumpYAML::TextContentStream::TextContentStream().

---

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

• include/llvm/ObjectYAML/MinidumpYAML.h
• lib/ObjectYAML/MinidumpYAML.cpp