asset

Documentation

Index

• Constants
• Variables
• type Item
  • func New(input string) (Item, error)
  • func UseDefault() Item
  • func (a Item) IsValid() bool
  • func (a Item) String() string
• type Items
  • func Supported() Items
  • func (a Items) Contains(i Item) bool
  • func (a Items) JoinToString(separator string) string
  • func (a Items) Strings() []string

Constants

const (
	Spot                   = Item("spot")
	Margin                 = Item("margin")
	MarginFunding          = Item("marginfunding")
	Index                  = Item("index")
	Binary                 = Item("binary")
	PerpetualContract      = Item("perpetualcontract")
	PerpetualSwap          = Item("perpetualswap")
	Futures                = Item("futures")
	Future                 = Item("future")
	UpsideProfitContract   = Item("upsideprofitcontract")
	DownsideProfitContract = Item("downsideprofitcontract")
	CoinMarginedFutures    = Item("coinmarginedfutures")
	USDTMarginedFutures    = Item("usdtmarginedfutures")
)

Const vars for asset package

Variables

var (
	// ErrNotSupported is an error for an unsupported asset type
	ErrNotSupported = errors.New("received unsupported asset type")
)

Types

type Item

type Item string

Item stores the asset type

func New

func New(input string) (Item, error)

New takes an input matches to relevant package assets

func UseDefault

func UseDefault() Item

UseDefault returns default asset type

func (Item) IsValid

func (a Item) IsValid() bool

IsValid returns whether or not the supplied asset type is valid or not

func (Item) String

func (a Item) String() string

returns an Item to string

type Items

type Items []Item

Items stores a list of assets types

func Supported

func Supported() Items

Supported returns a list of supported asset types

func (Items) Contains

func (a Items) Contains(i Item) bool

Contains returns whether or not the supplied asset exists in the list of Items

func (Items) JoinToString

func (a Items) JoinToString(separator string) string

JoinToString joins an asset type array and converts it to a string with the supplied separator

func (Items) Strings

func (a Items) Strings() []string

Strings converts an asset type array to a string array