ContextQMD
Back to Packer

`length` Function

website/content/docs/templates/hcl_templates/functions/collection/length.mdx

1.15.31.5 KB
Original Source

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[!IMPORTANT]
Documentation Update: Product documentation previously located in /website has moved to the hashicorp/web-unified-docs repository, where all product documentation is now centralized. Please make contributions directly to web-unified-docs, since changes to /website in this repository will not appear on developer.hashicorp.com. ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

length Function

length determines the length of a given list, map, or string.

If given a list or map, the result is the number of elements in that collection. If given a string, the result is the number of characters in the string.

Examples

shell-session
> length([])
0
> length(["a", "b"])
2
> length({"a" = "b"})
1
> length("hello")
5

When given a string, the result is the number of characters, rather than the number of bytes or Unicode sequences that form them:

shell-session
> length("👾🕹️")
2

A "character" is a grapheme cluster, as defined by Unicode Standard Annex #29. Note that remote APIs may have a different definition of "character" for the purpose of length limits on string arguments; a Packer provider is responsible for translating Packer's string representation into that used by its respective remote system and applying any additional validation rules to it.