StructFilter

Used to filter a struct and return a new struct containing the result

Method Signature

StructFilter(struct=[structloose], callback=[function:BiPredicate], parallel=[boolean], maxThreads=[integer])

Arguments

Argument	Type	Required	Description	Default
struct	struct	true	The target struct to test
callback	function:BiPredicate	true	The function used to filter. The function will be passed 3 arguments: the key, the value, the struct. You can alternatively pass a Java BiPredicate 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

Examples

Example using a simple numeric comparison

Take a struct of items with their rating and use structFilter to return ones of a rating 3 and higher.

Run Example

fruitRatings = { 
	APPLE : 4,
	BANANA : 1,
	ORANGE : 5,
	MANGO : 2,
	KIWI : 3
};
favoriteFruits = structFilter( fruitRatings, ( Any key, Any value ) => {
	return value >= 3;
} );
writedump( favoriteFruits );

Result: {apple=4,orange=5,kiwi=3}

Example using a member function

This is the same example, but using a member function on the struct instead of a standalone function.

Run Example

fruitRatings = { 
	APPLE : 4,
	BANANA : 1,
	ORANGE : 5,
	MANGO : 2,
	KIWI : 3
};
favoriteFruits = fruitRatings.filter( ( Any key, Any value ) => {
	return value >= 3;
} );
writedump( favoriteFruits );

Result: {apple=4,orange=5,kiwi=3}

Additional Examples

Run Example

animals = { 
	COW : "moo",
	PIG : "oink",
	SNAIL : ""
};
// Show all animals
Dump( label="All animals", var=animals );
// Get animals that make noise
noisyAnimals = StructFilter( animals, ( Any key ) => {
	// If the key has a value return true (noisy animal)
	if( Len( animals[ arguments.KEY ] ) ) {
		return true;
	}
	return false;
} );
Dump( label="Noisy Animals", var=noisyAnimals );
// Get animals that are quiet
quietAnimals = StructFilter( animals, ( Any key ) => {
	// If the key has a value return true (quiet animal)
	if( !Len( animals[ arguments.KEY ] ) ) {
		return true;
	}
	return false;
} );
Dump( label="Quiet Animals", var=quietAnimals );

Related

• StructEquals

• StructReduce

• StructIsCaseSensitive

• StructNew

• StructGet

• StructDelete

• StructIsOrdered

• StructSort

• StructEach

• StructToQueryString

• StructUpdate

• StructClear

• StructGetMetadata

• StructKeyArray

• StructToSorted

• StructCopy

• StructFindKey

• StructInsert

• StructMap

• StructFindValue

• StructValueArray

• StructSome

• StructKeyExists

• StructKeyTranslate

• StructEvery

• StructFind

• StructKeyList

• StructAppend