FCbArrayView

Array of [FCbField](API\Runtime\Core\Serialization\FCbField)[View] that have no names.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FCbFieldView

FCbArrayView

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Serialization/CompactBinary.h

Include

#include "Serialization/CompactBinary.h"

Syntax

class FCbArrayView : protected FCbFieldView

Remarks

Array of FCbField[View] that have no names.

Accessing a field of the array requires iteration. Access by index is not provided because the cost of accessing an item by index scales linearly with the index.

This type only provides a view into memory and does not perform any memory management itself. Use FCbArray to hold a reference to the underlying memory when necessary.

Constructors

Name Description

Public function

FCbArrayView()

Construct an array with no fields.

Functions

Name Description

Public function Const

void

 

AppendHash

(
    FIoHashBuilder& Builder
)

Append the hash of the array if serialized by itself with no name.

Public function Const

FCbFieldView

 

AsFieldView()

Access the array as an array field.

Public function Const

void

 

CopyTo

(
    FMutableMemoryView Buffer
)

Copy the array into a buffer of exactly GetSize() bytes, with no name.

Public function Const

void

 

CopyTo

(
    FArchive& Ar
)

Copy the array into an archive.

Public function Const

bool

 

Equals

(
    const FCbArrayView& Other
)

Whether this array is identical to the other array.

Public function Static

FCbArrayView

 

FromFieldNoCheck

(
    const FCbFieldView& Field
)

Construct an array from an array field. No type check is performed!

Public function Const

FIoHash

 

GetHash()

Calculate the hash of the array if serialized by itself with no name.

Public function Const

uint64

 

GetSize()

Returns the size of the array in bytes if serialized by itself with no name.

Public function Const

void

 

IterateAttachments

(
    FCbFieldVisitor Visitor
)

Invoke the visitor for every attachment in the array.

Public function Const

uint64

 

Num()

Returns the number of items in the array.

Public function Const

bool

 

TryGetView

(
    FMemoryView& OutView
)

Try to get a view of the array as it would be serialized, such as by CopyTo.

Operators

Name Description

Public function Const

 

operator bool()

Whether the array has any fields.