address

package

v0.0.0-...-798156f Latest Latest Go to latest Published: Oct 3, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/DigitalBitsOrg/go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package address provides utility functions for working with digitalbits addresses. See https://developer.digitalbits.io/guides/concepts/federation. html#digitalbits-addresses for more on addresses.

Index ¶

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

Constants ¶

View Source

const Separator = "*"

Separator seperates the name and domain portions of an address

Variables ¶

View Source

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.

Types ¶

This section is empty.

Source Files ¶

View all Source files

main.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL