FBuildOutput

A build output is an immutable container of values, messages, and logs produced by a build.

Windows
MacOS
Linux

Inheritance Hierarchy

FBuildOutput

FOptionalBuildOutput

References

Module

DerivedDataCache

Header

/Engine/Source/Developer/DerivedDataCache/Public/DerivedDataBuildOutput.h

Include

#include "DerivedDataBuildOutput.h"

Syntax

class FBuildOutput

Remarks

A build output is an immutable container of values, messages, and logs produced by a build.

The output will not contain any values if it has any errors.

The output can be requested without data, which means that the values will have null data.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Const

FStringView

 

GetFunction()

Returns the name of the build function that produced this output.

Public function Const

TConstArrayV...

 

GetLogs()

Returns the logs in the order that they were recorded.

Public function Const

TConstArrayV...

 

GetMessages()

Returns the messages in the order that they were recorded.

Public function Const

const FCbObj...

 

GetMeta()

Returns the optional metadata.

Public function Const

FStringView

 

GetName()

Returns the name by which to identify this output for logging and profiling.

Public function Const

const FValue...

 

GetValue

(
    const FValueId& Id
)

Returns the value matching the ID. Null if no match. Buffer is null if skipped.

Public function Const

TConstArrayV...

 

GetValues()

Returns the values in the output in order by ID.

Public function Const

bool

 

HasError()

Returns whether the output has any errors.

Public function Const

bool

 

HasLogs()

Returns whether the output has any logs.

Public function Static

FOptionalBui...

 

Load

(
    FStringView Name,
    FStringView Function,
    const FCbObject& Output
)

Load a build output.

Public function Static

FOptionalBui...

 

Load

(
    FStringView Name,
    FStringView Function,
    const FCacheRecord& Output
)

Load a build output.

Public function Const

void

 

Save

(
    FCbWriter& Writer
)

Saves the build output to a compact binary object with values as attachments.

Public function Const

void

 

Save

(
    FCacheRecordBuilder& RecordBuilder
)

Saves the build output to a cache record.