iptype

Documentation

Index

• Variables
• func Is(rawIpVersion string, expectedVersion Variant) bool
• func IsV4(rawIpVersion string) bool
• func IsV6(rawIpVersion string) bool
• func RangesInvalidErr() error
• func StringMustBe(rawString string, expected Variant)
• func V4ValidationError(rawIpVersion string) error
• func V6ValidationError(rawIpVersion string) error
• func ValidationError(rawString string, expectedEnum Variant) error
• type Variant
  • func CreateTypeUsingExplicit(name string) Variant
  • func GetUsingIpString(rawIpVersion string) Variant
  • func Max() Variant
  • func Min() Variant
  • func New(name string) (Variant, error)
  • func NewMust(name string) Variant
  • func (it Variant) AllNameValues() []string
  • func (it Variant) AsBasicByteEnumContractsBinder() enuminf.BasicByteEnumContractsBinder
  • func (it Variant) AsBasicEnumContractsBinder() enuminf.BasicEnumContractsBinder
  • func (it Variant) AsJsonContractsBinder() corejson.JsonContractsBinder
  • func (it Variant) AsJsonMarshaller() corejson.JsonMarshaller
  • func (it Variant) AsJsoner() corejson.Jsoner
  • func (it Variant) EnumType() enuminf.EnumTyper
  • func (it Variant) Format(format string) (compiled string)
  • func (it Variant) IntegerEnumRanges() []int
  • func (it Variant) IsAboveOrEqual(level Variant) bool
  • func (it Variant) IsAnyNamesOf(names ...string) bool
  • func (it Variant) IsAnyOf(anyOfItems ...Variant) bool
  • func (it Variant) IsAnyValuesEqual(anyByteValues ...byte) bool
  • func (it Variant) IsByteValueEqual(value byte) bool
  • func (it Variant) IsEqual(level Variant) bool
  • func (it Variant) IsInvalid() bool
  • func (it Variant) IsIp4() bool
  • func (it Variant) IsIp6() bool
  • func (it Variant) IsLowerOrEqual(level Variant) bool
  • func (it Variant) IsNameEqual(name string) bool
  • func (it Variant) IsV4() bool
  • func (it Variant) IsV6() bool
  • func (it Variant) IsValid() bool
  • func (it Variant) IsValueEqual(value byte) bool
  • func (it Variant) IsVersion4() bool
  • func (it Variant) IsVersion6() bool
  • func (it Variant) Json() corejson.Result
  • func (it *Variant) JsonParseSelfInject(jsonResult *corejson.Result) error
  • func (it Variant) JsonPtr() *corejson.Result
  • func (it Variant) MarshalJSON() ([]byte, error)
  • func (it Variant) MaxByte() byte
  • func (it Variant) MaxInt() int
  • func (it Variant) MaxValueString() string
  • func (it Variant) MinByte() byte
  • func (it Variant) MinInt() int
  • func (it Variant) MinMaxAny() (min, max interface{})
  • func (it Variant) MinValueString() string
  • func (it Variant) Name() string
  • func (it Variant) NameValue() string
  • func (it Variant) OnlySupportedErr(names ...string) error
  • func (it Variant) OnlySupportedMsgErr(message string, names ...string) error
  • func (it Variant) RangeNamesCsv() string
  • func (it Variant) RangesByte() []byte
  • func (it Variant) RangesDynamicMap() map[string]interface{}
  • func (it Variant) String() string
  • func (it Variant) ToNumberString() string
  • func (it Variant) ToPtr() *Variant
  • func (it Variant) TypeName() string
  • func (it *Variant) UnmarshalJSON(data []byte) error
  • func (it Variant) UnmarshallEnumToValue(jsonUnmarshallingValue []byte) (byte, error)
  • func (it Variant) Value() byte
  • func (it Variant) ValueByte() byte
  • func (it Variant) ValueInt() int
  • func (it Variant) ValueInt16() int16
  • func (it Variant) ValueInt32() int32
  • func (it Variant) ValueInt8() int8
  • func (it Variant) ValueString() string
  • func (it Variant) ValueUInt16() uint16

Variables

var (
	Ranges = [...]string{
		Invalid: "Invalid",
		V4:      "IpV4",
		V6:      "IpV6",
	}

	BasicEnumImpl = enumimpl.New.BasicByte.DefaultWithAliasMap(
		Invalid,
		Ranges[:],
		aliasMap)
)

Functions

func Is

func Is(
	rawIpVersion string,
	expectedVersion Variant,
) bool

func IsV4

func IsV4(rawIpVersion string) bool

func IsV6

func IsV6(rawIpVersion string) bool

func RangesInvalidErr

func RangesInvalidErr() error

func StringMustBe

func StringMustBe(
	rawString string,
	expected Variant,
)

func V4ValidationError

func V4ValidationError(
	rawIpVersion string,
) error

func V6ValidationError

func V6ValidationError(
	rawIpVersion string,
) error

func ValidationError

func ValidationError(
	rawString string,
	expectedEnum Variant,
) error

Types

type Variant

type Variant byte

const (
	Invalid Variant = iota
	V4
	V6
)

func CreateTypeUsingExplicit

func CreateTypeUsingExplicit(name string) Variant

func GetUsingIpString

func GetUsingIpString(
	rawIpVersion string,
) Variant

GetUsingIpString

returns specific Ip version based on ip string

Examples:

• "" : Invalid
• "192..." : V4
• "fe:00....." : V6

func Max

func Max() Variant

func Min

func Min() Variant

func New

func New(name string) (Variant, error)

func NewMust

func NewMust(name string) Variant

func (Variant) AllNameValues

func (it Variant) AllNameValues() []string

func (Variant) AsBasicByteEnumContractsBinder

func (it Variant) AsBasicByteEnumContractsBinder() enuminf.BasicByteEnumContractsBinder

func (Variant) AsBasicEnumContractsBinder

func (it Variant) AsBasicEnumContractsBinder() enuminf.BasicEnumContractsBinder

func (Variant) AsJsonContractsBinder

func (it Variant) AsJsonContractsBinder() corejson.JsonContractsBinder

func (Variant) AsJsonMarshaller

func (it Variant) AsJsonMarshaller() corejson.JsonMarshaller

func (Variant) AsJsoner

func (it Variant) AsJsoner() corejson.Jsoner

func (Variant) EnumType

func (it Variant) EnumType() enuminf.EnumTyper

func (Variant) Format

func (it Variant) Format(format string) (compiled string)

func (Variant) IntegerEnumRanges

func (it Variant) IntegerEnumRanges() []int

func (Variant) IsAboveOrEqual

func (it Variant) IsAboveOrEqual(level Variant) bool

func (Variant) IsAnyNamesOf

func (it Variant) IsAnyNamesOf(names ...string) bool

func (Variant) IsAnyOf

func (it Variant) IsAnyOf(anyOfItems ...Variant) bool

func (Variant) IsAnyValuesEqual

func (it Variant) IsAnyValuesEqual(anyByteValues ...byte) bool

func (Variant) IsByteValueEqual

func (it Variant) IsByteValueEqual(value byte) bool

func (Variant) IsEqual

func (it Variant) IsEqual(level Variant) bool

func (Variant) IsInvalid

func (it Variant) IsInvalid() bool

func (Variant) IsIp4

func (it Variant) IsIp4() bool

func (Variant) IsIp6

func (it Variant) IsIp6() bool

func (Variant) IsLowerOrEqual

func (it Variant) IsLowerOrEqual(level Variant) bool

func (Variant) IsNameEqual

func (it Variant) IsNameEqual(name string) bool

func (Variant) IsV4

func (it Variant) IsV4() bool

func (Variant) IsV6

func (it Variant) IsV6() bool

func (Variant) IsValid

func (it Variant) IsValid() bool

func (Variant) IsValueEqual

func (it Variant) IsValueEqual(value byte) bool

func (Variant) IsVersion4

func (it Variant) IsVersion4() bool

func (Variant) IsVersion6

func (it Variant) IsVersion6() bool

func (Variant) Json

func (it Variant) Json() corejson.Result

func (*Variant) JsonParseSelfInject

func (it *Variant) JsonParseSelfInject(jsonResult *corejson.Result) error

func (Variant) JsonPtr

func (it Variant) JsonPtr() *corejson.Result

func (Variant) MarshalJSON

func (it Variant) MarshalJSON() ([]byte, error)

func (Variant) MaxByte

func (it Variant) MaxByte() byte

func (Variant) MaxInt

func (it Variant) MaxInt() int

func (Variant) MaxValueString

func (it Variant) MaxValueString() string

func (Variant) MinByte

func (it Variant) MinByte() byte

func (Variant) MinInt

func (it Variant) MinInt() int

func (Variant) MinMaxAny

func (it Variant) MinMaxAny() (min, max interface{})

func (Variant) MinValueString

func (it Variant) MinValueString() string

func (Variant) Name

func (it Variant) Name() string

func (Variant) NameValue

func (it Variant) NameValue() string

func (Variant) OnlySupportedErr

func (it Variant) OnlySupportedErr(names ...string) error

func (Variant) OnlySupportedMsgErr

func (it Variant) OnlySupportedMsgErr(message string, names ...string) error

func (Variant) RangeNamesCsv

func (it Variant) RangeNamesCsv() string

func (Variant) RangesByte

func (it Variant) RangesByte() []byte

func (Variant) RangesDynamicMap

func (it Variant) RangesDynamicMap() map[string]interface{}

func (Variant) String

func (it Variant) String() string

func (Variant) ToNumberString

func (it Variant) ToNumberString() string

func (Variant) ToPtr

func (it Variant) ToPtr() *Variant

func (Variant) TypeName

func (it Variant) TypeName() string

func (*Variant) UnmarshalJSON

func (it *Variant) UnmarshalJSON(data []byte) error

func (Variant) UnmarshallEnumToValue

func (it Variant) UnmarshallEnumToValue(
	jsonUnmarshallingValue []byte,
) (byte, error)

func (Variant) Value

func (it Variant) Value() byte

func (Variant) ValueByte

func (it Variant) ValueByte() byte

func (Variant) ValueInt

func (it Variant) ValueInt() int

func (Variant) ValueInt16

func (it Variant) ValueInt16() int16

func (Variant) ValueInt32

func (it Variant) ValueInt32() int32

func (Variant) ValueInt8

func (it Variant) ValueInt8() int8

func (Variant) ValueString

func (it Variant) ValueString() string

func (Variant) ValueUInt16

func (it Variant) ValueUInt16() uint16