Debian Codegraph @

docs/modules/yaml/pages/str-ft-obj.adoc

raw
1 = YAML string field type object
2
3 A _**string field type object**_ is the type of null-terminated string
4 data fields, found in xref:how-barectf-works:ctf-primer.adoc#ds[data
5 streams].
6
7 [[props]]
8 == Properties
9
10 [%autowidth.stretch, cols="d,d,a,d"]
11 |===
12 |Name |Type |Description |Required?
13
14 |[[class-prop]]`class`
15 |String
16 |This property's value must be one of:
17
18 * `string`
19 * `str`
20 |Yes if the <<inherit-prop,`$inherit`>> property is not set.
21
22 include::partial$ft-obj-inherit-prop.adoc[]
23 |===
24
25 == Generated C{nbsp}type
26
27 `const char *`
28
29 == Example
30
31 .Basic string field type object.
32 ====
33 [source,yaml]
34 ----
35 class: string
36 ----
37 ====