Puppet Function: validate_string

Defined in:
puppet/modules/stdlib/lib/puppet/functions/validate_string.rb
Function type:
Ruby 4.x API

Overview

validate_string(Any $scope, Any *$args)Any

Parameters:

  • scope (Any)
  • *args (Any)

Returns:

  • (Any)


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# File 'puppet/modules/stdlib/lib/puppet/functions/validate_string.rb', line 1

Puppet::Functions.create_function(:validate_string) do
  dispatch :deprecation_gen do
    param 'Any', :scope
    repeated_param 'Any', :args
  end
  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
  def call(scope, *args)
    manipulated_args = [scope] + args
    self.class.dispatcher.dispatch(self, scope, manipulated_args)
  end
  def deprecation_gen(scope, *args)
    call_function('deprecation', 'validate_string', "This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.")
    scope.send("function_validate_string", args)
  end
end