asset

package

v0.0.0-...-095394f Latest Latest Go to latest Published: May 7, 2024 License: MIT Imports: 4 Imported by: 273

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/thrasher-corp/gocryptotrader

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Item
- func New(input string) (Item, error)
- func UseDefault() Item
type Items
- func Supported() Items

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrNotSupported is an error for an unsupported asset type
	ErrNotSupported = errors.New("unsupported asset type")
	// ErrNotEnabled is an error for an asset not enabled
	ErrNotEnabled = errors.New("asset type not enabled")
	// ErrInvalidAsset is returned when the assist isn't valid
	ErrInvalidAsset = errors.New("asset is invalid")
)

Functions ¶

This section is empty.

Types ¶

type Item ¶

type Item uint32

Item stores the asset type

const (
	Empty Item = 0
	Spot  Item = 1 << iota
	Margin
	CrossMargin
	MarginFunding
	Index
	Binary
	PerpetualContract
	PerpetualSwap
	Futures
	DeliveryFutures
	UpsideProfitContract
	DownsideProfitContract
	CoinMarginedFutures
	USDTMarginedFutures
	USDCMarginedFutures
	Options

	// Added to represent a USDT and USDC based linear derivatives(futures/perpetual) assets in Bybit V5.
	LinearContract
)

Const vars for asset package

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

Source Files ¶

View all Source files

asset.go

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