API Reference Shun v1.0.2

Modules

Top-level module holding the Shun library, which provides URI, IPv4 and IPv6 address verification primitives.

Provides convenience functions to deal with IPv4 and IPv6 addresses.

Provides a way to programmatically create modules that implement the Shun.Provider behaviour.

Specifies how additional reusable rules are provided.

Provides an AWS-related rule which forbids access to the EC2 Instance Metadata endpoint.

Represents a compile-time error when the Preset module has not provided a default handler, yet is referred to with Shun.Builder.handle/1.

Provides IPv4 related rules that reject link-local blocks.

Provides IPv4 related rules that reject loopback blocks.

Provides IPv4 related rules that reject private blocks.

Provides IPv6 related rules which verify the embedded IPv4 addresses correctly. Instead of verifying the IPv6 addresses as-is, the embedded IPv4 address will be extracted and verified as if it has been used from the beginning.

Provides IPv6 related rules that reject link-local blocks.

Provides IPv6 related rules that reject loopback blocks.

Specifies how the incoming URI or IP Address should be validated.

Specifies how names are resolved to addresses.

Represents what should be done based on the target pattern, which can represent an URI, IPv4, or IPv6 address. It can also be given a String literal, which represents either an IPv4 or IPv6 address, or a range of addresses using CIDR notation.

Represents a compile-time error when the pattern used to build a Rule is not valid.

Encapsulates target classification logic used by Shun.Rule to interpret target patterns.

Allows verification of an URI, IPv4 address, or IPv6 address using a Provider.