Method: Puppet::Pal::Compiler#list_functions

Defined in:
lib/puppet/pal/compiler.rb

#list_functions(filter_regex = nil, error_collector = nil) ⇒ Array<Puppet::Pops::Loader::TypedName>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns an array of TypedName objects for all functions, optionally filtered by a regular expression. The returned array has more information than just the leaf name - the typical thing is to just get the name as showing the following example.

Errors that occur during function discovery will either be logged as warnings or collected by the optional ‘error_collector` array. When provided, it will receive DataTypes::Error instances describing each error in detail and no warnings will be logged.

Examples:

getting the names of all functions

compiler.list_functions.map {|tn| tn.name }

Parameters:

  • filter_regex (Regexp) (defaults to: nil) —

    an optional regexp that filters based on name (matching names are included in the result)

  • error_collector (Array<Puppet::DataTypes::Error>) (defaults to: nil) —

    an optional array that will receive errors during load

Returns:



67
68
69
 
# File 'lib/puppet/pal/compiler.rb', line 67

def list_functions(filter_regex = nil, error_collector = nil)
  list_loadable_kind(:function, filter_regex, error_collector)
end