Puppet Function: is_float

Defined in:
modules/stdlib/lib/puppet/parser/functions/is_float.rb
Function type:
Ruby 3.x API

Overview

is_float()Boolean

> *Note: *Deprecated* Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).

Returns:

  • (Boolean)

    Returns `true` or `false`



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'modules/stdlib/lib/puppet/parser/functions/is_float.rb', line 5

newfunction(:is_float, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns true if the variable passed to this function is a float.

  @return [Boolean]
    Returns `true` or `false`

  > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  [`validate_legacy`](#validate_legacy).
  DOC
           ) do |arguments|

  function_deprecation([:is_float, 'This method is deprecated, please use the stdlib validate_legacy function,
                        with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.'])

  if arguments.size != 1
    raise(Puppet::ParseError, "is_float(): Wrong number of arguments given #{arguments.size} for 1")
  end

  value = arguments[0]

  # Only allow Numeric or String types
  return false unless value.is_a?(Numeric) || value.is_a?(String)

  return false if value != value.to_f.to_s && !value.is_a?(Float)
  return true
end