meineerde/rackstash
1
0
Fork 0
mirror of https://github.com/meineerde/rackstash.git synced 2026-02-01 01:37:12 +00:00
Code Issues Releases Activity

Clarify the behavior of Fields::Hash#set with different force values

Browse Source
This commit is contained in:
Holger Just 2017-10-08 21:54:32 +02:00
parent 2d0f47a813
commit 72dae8e222
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/rackstash/fields/hash.rb
View File

@ -412,9 +412,15 @@ module Rackstash
alias reverse_update reverse_merge!
# Set a `key` of `self` to the returned value of the passed block.
# If the key is forbidden from being set or already exists with a value
# other than `nil`, the block will not be called and the value will not be
# set.
#
# With `force: true`, we call the given block and set the normalized
# result to the `key`, overwriting any existing value. If the key is
# forbidden from being set, we raise an `ArgumentError` without calling
# the block.
#
# With `force: false`, if the key is forbidden from being set or already
# exists with a value other than `nil`, the block will not be called and
# the value will not be set / overwritten.
#
# @param key [#to_s] the field name. When setting the field, this name
# will be normalized as a frozen UTF-8 string.