address

Documentation

Overview

Package address provides utility functions for working with hcnet addresses. See https://developers.hcnet.org/docs/glossary/federation/ html#hcnet-addresses for more on addresses.

Index

• Constants
• Variables
• func New(name, domain string) string
• func Split(address string) (name, domain string, err error)

Constants

const Separator = "*"

Separator seperates the name and domain portions of an address

Variables

var (
	// ErrInvalidAddress is the error returned when an address is invalid in
	// such a way that we do not know if the name or domain portion is at fault.
	ErrInvalidAddress = errors.New("invalid address")

	// ErrInvalidName is the error returned when an address's name portion is
	// invalid.
	ErrInvalidName = errors.New("name part of address is invalid")

	// ErrInvalidDomain is the error returned when an address's domain portion
	// is invalid.
	ErrInvalidDomain = errors.New("domain part of address is invalid")
)

Functions

func New

func New(name, domain string) string

New returns a new address based upon the provided name and domain. Note: Not validation is performed on the parts provided... it is possible to create an invalid address by supplying invalid information, for example, supplying a blank domain.

func Split

func Split(address string) (name, domain string, err error)

Split takes an address, of the form "name*domain" and provides the constituent elements.