asset

Documentation

Index

• Variables
• type Item
  • func New(input string) (Item, error)
  • func UseDefault() Item
  • func (a Item) IsFutures() bool
  • func (a Item) IsOptions() bool
  • func (a Item) IsValid() bool
  • func (a Item) MarshalJSON() ([]byte, error)
  • func (a Item) String() string
  • func (a *Item) UnmarshalJSON(d []byte) error
• type Items
  • func Supported() Items
  • func (a Items) Contains(i Item) bool
  • func (a Items) JoinToString(separator string) string
  • func (a Items) Strings() []string

Variables

var (
	ErrNotSupported = errors.New("unsupported asset type")
	ErrNotEnabled   = errors.New("asset type not enabled")
	ErrInvalidAsset = errors.New("asset is invalid")
)

Public errors related to assets

Types

type Item

type Item uint32

Item stores the asset type

const (
	Empty Item = iota
	Spot
	Margin
	CrossMargin
	MarginFunding
	Index
	Binary
	// Futures asset consts must come below this comment for method `IsFutures`
	Futures
	PerpetualContract
	PerpetualSwap
	DeliveryFutures
	UpsideProfitContract
	DownsideProfitContract
	CoinMarginedFutures
	USDTMarginedFutures
	USDCMarginedFutures
	FutureCombo
	LinearContract
	// Options asset consts must come below this comment for method `IsOptions`
	Options
	OptionCombo
	// All asset const must come immediately after all valid assets for method `IsValid`
	All
)

Supported Assets

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) IsFutures

func (a Item) IsFutures() bool

IsFutures checks if the asset type is a futures contract based asset

func (Item) IsOptions

func (a Item) IsOptions() bool

IsOptions checks if the asset type is options contract based asset

func (Item) IsValid

func (a Item) IsValid() bool

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

func (Item) MarshalJSON

func (a Item) MarshalJSON() ([]byte, error)

MarshalJSON conforms type to the marshaller interface

func (Item) String

func (a Item) String() string

String converts an Item to its string representation

func (*Item) UnmarshalJSON

func (a *Item) UnmarshalJSON(d []byte) error

UnmarshalJSON conforms type to the umarshaler interface

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