StructEach

Used to iterate over a struct and run the function closure for each key/value pair.

Method Signature

StructEach(struct=[structloose], callback=[function:BiConsumer], parallel=[boolean], maxThreads=[integer], ordered=[boolean])

Arguments

Argument Type Required Description Default

Argument	Type	Required	Description	Default
`struct`	`struct`	`true`	The target struct to iterate
`callback`	`function:BiConsumer`	`true`	The function to invoke for each item. The function will be passed 3 arguments: the key, the value, the struct. You can alternatively pass a Java BiConsumer which will only receive the first 2 args.
`parallel`	`boolean`	`false`	Specifies whether the items can be executed in parallel	`false`
`maxThreads`	`integer`	`false`	The maximum number of threads to use when parallel = true
`ordered`	`boolean`	`false`	(BoxLang only) whether parallel operations should execute and maintain order	`false`

struct

true

The target struct to iterate

callback

function:BiConsumer

true

The function to invoke for each item. The function will be passed 3 arguments: the key, the value, the struct. You can alternatively pass a Java BiConsumer which will only receive the first 2 args.

parallel

boolean

false

Specifies whether the items can be executed in parallel

false

maxThreads

integer

false

The maximum number of threads to use when parallel = true

ordered

boolean

false

(BoxLang only) whether parallel operations should execute and maintain order

false

Examples

PreviousStructDelete NextStructEquals

Last updated 4 months ago

Method Signature

Arguments

Examples

Related