| 1 |
= YAML integer field type objects |
| 2 |
|
| 3 |
_**Integer field type objects**_ are the types of integer data fields, |
| 4 |
found in xref:how-barectf-works:ctf-primer.adoc#ds[data streams]. |
| 5 |
|
| 6 |
[[props]] |
| 7 |
== Properties |
| 8 |
|
| 9 |
[%autowidth.stretch, cols="d,d,a,d,a", role="can-break"] |
| 10 |
|=== |
| 11 |
|Name |Type |Description |{req-abbr} |Default |
| 12 |
|
| 13 |
|[[class-prop]]`class` |
| 14 |
|String |
| 15 |
|This property's value must be one of: |
| 16 |
|
| 17 |
`unsigned-integer`:: |
| 18 |
`unsigned-int`:: |
| 19 |
`uint`:: |
| 20 |
Unsigned integer field type |
| 21 |
|
| 22 |
`signed-integer`:: |
| 23 |
`signed-int`:: |
| 24 |
`sint`:: |
| 25 |
Signed integer field type |
| 26 |
|Yes if the <<inherit-prop,`$inherit`>> property is not set. |
| 27 |
| |
| 28 |
|
| 29 |
include::partial$int-ft-obj-base-props.adoc[] |
| 30 |
|
| 31 |
|=== |
| 32 |
|
| 33 |
== Generated C{nbsp}types |
| 34 |
|
| 35 |
include::partial$int-ft-obj-c-types-table.adoc[] |
| 36 |
|
| 37 |
== Examples |
| 38 |
|
| 39 |
.Basic <<size-prop,8-bit>> unsigned integer field type object. |
| 40 |
==== |
| 41 |
[source,yaml] |
| 42 |
---- |
| 43 |
class: unsigned-integer |
| 44 |
size: 8 |
| 45 |
---- |
| 46 |
==== |
| 47 |
|
| 48 |
.<<size-prop,23-bit>> signed integer field type object. |
| 49 |
==== |
| 50 |
[source,yaml] |
| 51 |
---- |
| 52 |
class: signed-integer |
| 53 |
size: 23 |
| 54 |
---- |
| 55 |
==== |
| 56 |
|
| 57 |
.32-bit-<<align-prop,aligned>> <<size-prop,16-bit>> signed integer field type object. |
| 58 |
==== |
| 59 |
[source,yaml] |
| 60 |
---- |
| 61 |
class: signed-integer |
| 62 |
size: 16 |
| 63 |
alignment: 32 |
| 64 |
---- |
| 65 |
==== |
| 66 |
|
| 67 |
.<<size-prop,32-bit>> unsigned integer field type object with a hexadecimal <<pref-disp-base-prop,preferred display base>>. |
| 68 |
==== |
| 69 |
[source,yaml] |
| 70 |
---- |
| 71 |
class: unsigned-integer |
| 72 |
size: 32 |
| 73 |
preferred-display-base: hexadecimal |
| 74 |
---- |
| 75 |
==== |