From 5dd7df187aaef5a0b20cc012a143643e01210752 Mon Sep 17 00:00:00 2001
From: Dave Henderson <dhenderson@gmail.com>
Date: Mon, 23 Aug 2021 18:45:41 -0400
Subject: New functions net.ParseIP, net.ParseIPPrefix, and net.ParseIPRange
 (#1197)

Signed-off-by: Dave Henderson <dhenderson@gmail.com>
---
 docs-src/content/functions/net.yml | 77 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 76 insertions(+), 1 deletion(-)

(limited to 'docs-src/content/functions')

diff --git a/docs-src/content/functions/net.yml b/docs-src/content/functions/net.yml
index 5f01cc2b..875698c9 100644
--- a/docs-src/content/functions/net.yml
+++ b/docs-src/content/functions/net.yml
@@ -1,5 +1,13 @@
 ns: net
-preamble: ''
+preamble: |
+  The `net` namespace contains functions that can help deal with network-related
+  lookups and calculations. Some of these functions return specifically-typed
+  values that contain additional methods useful for formatting or further
+  calculations.
+
+  [RFC 4632]: http://tools.ietf.org/html/rfc4632
+  [RFC 4291]: http://tools.ietf.org/html/rfc4291
+  [`inet.af/netaddr`]: https://pkg.go.dev/inet.af/netaddr
 funcs:
   - name: net.LookupIP
     description: |
@@ -117,3 +125,70 @@ funcs:
         [
           "v=spf1 -all"
         ]
+  - name: net.ParseIP
+    description: |
+      Parse the given string as an IP address (a `netaddr.IP` from the
+      [`inet.af/netaddr`](https://pkg.go.dev/inet.af/netaddr) package).
+
+      Any of `netaddr.IP`'s methods may be called on the resulting value. See
+      [the docs](https://pkg.go.dev/inet.af/netaddr) for details.
+    pipeline: true
+    arguments:
+      - name: ip
+        required: true
+        description: The IP string to parse. It must be either an IPv4 or IPv6 address.
+    examples:
+      - |
+        $ gomplate -i '{{ (net.ParseIP "192.168.0.1").IsPrivate }}'
+        true
+        $ gomplate -i '{{ $ip := net.ParseIP (net.LookupIP "example.com") -}}
+          {{ $ip.Prefix 12 }}'
+        93.176.0.0/12
+  - name: net.ParseIPPrefix
+    description: |
+      Parse the given string as an IP address prefix (CIDR) representing an IP
+      network (a `netaddr.IPPrefix` from the
+      [`inet.af/netaddr`][] package).
+
+      The string can be in the form `"192.168.1.0/24"` or `"2001::db8::/32"`,
+      the CIDR notations defined in [RFC 4632][] and [RFC 4291][].
+
+      Any of `netaddr.IPPrefix`'s methods may be called on the resulting value.
+      See [the docs][`inet.af/netaddr`] for details.
+    pipeline: true
+    arguments:
+      - name: ipprefix
+        required: true
+        description: The IP address prefix to parse. It must represent either an IPv4 or IPv6 prefix, containing a `/`.
+    examples:
+      - |
+        $ gomplate -i '{{ (net.ParseIPPrefix "192.168.0.0/24").Range }}'
+        192.168.0.0-192.168.0.255
+        $ gomplate -i '{{ $ip := net.ParseIP (net.LookupIP "example.com") -}}
+          {{ $net := net.ParseIPPrefix "93.184.0.0/16" -}}
+          {{ $net.Contains $ip }}'
+        true
+        $ gomplate -i '{{ $net := net.ParseIPPrefix "93.184.0.0/12" -}}
+          {{ $net.Range }}'
+        93.176.0.0-93.191.255.255
+  - name: net.ParseIPRange
+    description: |
+      Parse the given string as an inclusive range of IP addresses from the same
+      address family (a `netaddr.IPRange` from the [`inet.af/netaddr`][] package).
+
+      The string must contain a hyphen (`-`).
+
+      Any of `netaddr.IPRange`'s methods may be called on the resulting value.
+      See [the docs][`inet.af/netaddr`] for details.
+    pipeline: true
+    arguments:
+      - name: iprange
+        required: true
+        description: The IP address range to parse. It must represent either an IPv4 or IPv6 range, containing a `-`.
+    examples:
+      - |
+        $ gomplate -i '{{ (net.ParseIPRange "192.168.0.0-192.168.0.255").To }}'
+        192.168.0.255
+        $ gomplate -i '{{ $range := net.ParseIPRange "1.2.3.0-1.2.3.233" -}}
+          {{ $range.Prefixes }}'
+        [1.2.3.0/25 1.2.3.128/26 1.2.3.192/27]
-- 
cgit v1.2.3