api

type Appender interface {
	Append(val any) WriteMagicArray
}

type BaseType interface {
	~string | ~int | ~int8 | ~int16 | ~int32 | ~int64 | ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | time.Time
}

type Getter interface {
	Get(key interface{}) ZVal
}

type Iterator interface {
	// All The iterate of Array
	NextKV() (ZVal, ZVal)
	FirstKV() (ZVal, ZVal)
	//NextKey() ZVal todo
	NextVal() ZVal
	FirstVal() ZVal
	Index() int
}

type KV interface {
	Keys() MagicArray
	Values() MagicArray
	IsKeys() bool
}

type Len interface {
	Len() int
}

type MagicArray interface {
	Iter() Iterator
	KV
	Len
	Getter
}

type Remover interface {
	Remove(key any) (WriteMagicArray, error)
}

type Setter interface {
	Set(key interface{}, val interface{}) WriteMagicArray
}

type WriteMagicArray interface {
	MagicArray
	Setter
	Appender
	Remover
}

type ZVal interface {

	// Compare less=1 equal = 2 large =3 faild = 4
	Int() (int, bool)
	Uint() (uint, bool)
	Compare(val ZVal) bool
	Int64() (int64, bool)
	Uint64() (uint64, bool)
	Int32() (int32, bool)
	Int16() (int16, bool)
	Int8() (int8, bool)
	Uint32() (uint32, bool)
	Uint16() (uint16, bool)
	Uint8() (uint8, bool)
	String() string
	ZVal() ZVal
	Interface() interface{}
	Arr() (MagicArray, bool)
	Kind() uint8
	IsEmpty() bool
	IsNil() bool
	//IsSet is different with php, nil whil return true
	IsSet() bool
	Float32() (float32, bool)
	Float64() (float64, bool)
	Time() (time.Time, bool)
	Bool() (bool, bool)

	MustInt() int
	MustUint() uint
	MustInt32() int32
	MustInt16() int16
	MustInt8() int8
	MustUint32() uint32
	MustUint16() uint16
	MustUint8() uint8
	MustArr() MagicArray
	MustInt64() int64
	MustUint64() uint64
	MustFloat32() float32
	MustFloat64() float64
	MustTime() time.Time
	MustBool() bool
}

type ZValTag interface {
	GetTag(string) (string, bool)
}

type ZValTagSet interface {
	SetTag(s string, val string)
}