Sha256: cd341def7c541b39dd7602ad7976b4dce7c264f9ac6158c59dfb9847b598fa18
Contents?: true
Size: 1.15 KB
Versions: 307
Compression:
Stored size: 1.15 KB
Contents
# Unwraps a Sensitive value and returns the wrapped object.
#
# @example Usage of unwrap
#
# ```puppet
# $plaintext = 'hunter2'
# $pw = Sensitive.new($plaintext)
# notice("Wrapped object is $pw") #=> Prints "Wrapped object is Sensitive [value redacted]"
# $unwrapped = $pw.unwrap
# notice("Unwrapped object is $unwrapped") #=> Prints "Unwrapped object is hunter2"
# ```
#
# You can optionally pass a block to unwrap in order to limit the scope where the
# unwrapped value is visible.
#
# @example Unwrapping with a block of code
#
# ```puppet
# $pw = Sensitive.new('hunter2')
# notice("Wrapped object is $pw") #=> Prints "Wrapped object is Sensitive [value redacted]"
# $pw.unwrap |$unwrapped| {
# $conf = inline_template("password: ${unwrapped}\n")
# Sensitive.new($conf)
# } #=> Returns a new Sensitive object containing an interpolated config file
# # $unwrapped is now out of scope
# ```
#
# @since 4.0.0
#
Puppet::Functions.create_function(:unwrap) do
dispatch :unwrap do
param 'Sensitive', :arg
optional_block_param
end
def unwrap(arg)
unwrapped = arg.unwrap
if block_given?
yield(unwrapped)
else
unwrapped
end
end
end
Version data entries
307 entries across 307 versions & 2 rubygems