types

Documentation

Index

• Constants
• Variables
• type Authorization
• type ContainerType
• type ID
• type MD5Hash
  • func (hash *MD5Hash) UnmarshalText(data []byte) error

Constants

const (
	AlbumContainerType    = ContainerType("album")
	PlaylistContainerType = ContainerType("playlist")
)

const IDSize = sha256.Size

Variables

var (
	ErrInvalidContainerType = errors.New("invalid container type")
)

Types

type Authorization

type Authorization struct {
	Username string
	Password string
}

Authorization is a struct representing authorization details needed to sign in to use this API.

Currently both Username and Password are required.

type ContainerType

type ContainerType string

ContainerType is the enum that describes the Nixplay container type that holds photos, either album or playlist.

type ID

type ID [IDSize]byte

ID is a unique identifier for objects in this library.

This is implemented as a fixed size array instead of a slice or string to try to save qon heap allocations and thus make this more efficient.

type MD5Hash

type MD5Hash [md5.Size]byte

func (*MD5Hash) UnmarshalText

func (hash *MD5Hash) UnmarshalText(data []byte) error