Documentation ¶
Overview ¶
Package types provides types used in Quazal Rendez-Vous/NEX
Index ¶
- Variables
- func RegisterDataHolderType(name string, rvType RVType)
- func RegisterVariantType(id uint8, rvType RVType)
- type AnyDataHolder
- func (adh *AnyDataHolder) Copy() RVType
- func (adh *AnyDataHolder) Equals(o RVType) bool
- func (adh *AnyDataHolder) ExtractFrom(readable Readable) error
- func (adh *AnyDataHolder) FormatToString(indentationLevel int) string
- func (adh *AnyDataHolder) String() string
- func (adh *AnyDataHolder) WriteTo(writable Writable)
- type Buffer
- type ClassVersionContainer
- func (cvc *ClassVersionContainer) Copy() RVType
- func (cvc *ClassVersionContainer) Equals(o RVType) bool
- func (cvc *ClassVersionContainer) ExtractFrom(readable Readable) error
- func (cvc *ClassVersionContainer) FormatToString(indentationLevel int) string
- func (cvc *ClassVersionContainer) String() string
- func (cvc *ClassVersionContainer) WriteTo(writable Writable)
- type Data
- type DateTime
- func (dt *DateTime) Copy() RVType
- func (dt *DateTime) Day() int
- func (dt *DateTime) Equals(o RVType) bool
- func (dt *DateTime) ExtractFrom(readable Readable) error
- func (dt *DateTime) FormatToString(indentationLevel int) string
- func (dt *DateTime) FromTimestamp(timestamp time.Time) *DateTime
- func (dt *DateTime) Hour() int
- func (dt *DateTime) Make(year, month, day, hour, minute, second int) *DateTime
- func (dt *DateTime) Minute() int
- func (dt *DateTime) Month() time.Month
- func (dt *DateTime) Now() *DateTime
- func (dt *DateTime) Second() int
- func (dt *DateTime) Standard() time.Time
- func (dt *DateTime) String() string
- func (dt *DateTime) Value() uint64
- func (dt *DateTime) WriteTo(writable Writable)
- func (dt *DateTime) Year() int
- type List
- func (l *List[T]) Append(value T)
- func (l *List[T]) Contains(checkValue T) bool
- func (l *List[T]) Copy() RVType
- func (l *List[T]) DeleteIndex(index int) error
- func (l *List[T]) Each(callback func(i int, value T) bool) bool
- func (l *List[T]) Equals(o RVType) bool
- func (l *List[T]) ExtractFrom(readable Readable) error
- func (l *List[T]) Get(index int) (T, error)
- func (l *List[T]) Length() int
- func (l *List[T]) Remove(check T)
- func (l *List[T]) SetFromData(data []T)
- func (l *List[T]) SetIndex(index int, value T) error
- func (l *List[T]) Slice() []T
- func (l *List[T]) String() string
- func (l *List[T]) WriteTo(writable Writable)
- type Map
- func (m *Map[K, V]) Copy() RVType
- func (m *Map[K, V]) Equals(o RVType) bool
- func (m *Map[K, V]) ExtractFrom(readable Readable) error
- func (m *Map[K, V]) FormatToString(indentationLevel int) string
- func (m *Map[K, V]) Get(key K) (V, bool)
- func (m *Map[K, V]) Set(key K, value V)
- func (m *Map[K, V]) Size() int
- func (m *Map[K, V]) String() string
- func (m *Map[K, V]) WriteTo(writable Writable)
- type PID
- func (p *PID) Copy() RVType
- func (p *PID) Equals(o RVType) bool
- func (p *PID) ExtractFrom(readable Readable) error
- func (p *PID) FormatToString(indentationLevel int) string
- func (p *PID) LegacyValue() uint32
- func (p *PID) String() string
- func (p *PID) Value() uint64
- func (p *PID) WriteTo(writable Writable)
- type PrimitiveBool
- type PrimitiveF32
- type PrimitiveF64
- type PrimitiveS16
- func (s16 *PrimitiveS16) AND(other *PrimitiveS16) *PrimitiveS16
- func (s16 *PrimitiveS16) ANDNOT(other *PrimitiveS16) *PrimitiveS16
- func (s16 *PrimitiveS16) Copy() RVType
- func (s16 *PrimitiveS16) Equals(o RVType) bool
- func (s16 *PrimitiveS16) ExtractFrom(readable Readable) error
- func (s16 *PrimitiveS16) LShift(other *PrimitiveS16) *PrimitiveS16
- func (s16 *PrimitiveS16) NOT() *PrimitiveS16
- func (s16 *PrimitiveS16) OR(other *PrimitiveS16) *PrimitiveS16
- func (s16 *PrimitiveS16) PAND(value int16) int16
- func (s16 *PrimitiveS16) PANDNOT(value int16) int16
- func (s16 *PrimitiveS16) PLShift(value int16) int16
- func (s16 *PrimitiveS16) PNOT() int16
- func (s16 *PrimitiveS16) POR(value int16) int16
- func (s16 *PrimitiveS16) PRShift(value int16) int16
- func (s16 *PrimitiveS16) PXOR(value int16) int16
- func (s16 *PrimitiveS16) RShift(other *PrimitiveS16) *PrimitiveS16
- func (s16 *PrimitiveS16) String() string
- func (s16 *PrimitiveS16) WriteTo(writable Writable)
- func (s16 *PrimitiveS16) XOR(other *PrimitiveS16) *PrimitiveS16
- type PrimitiveS32
- func (s32 *PrimitiveS32) AND(other *PrimitiveS32) *PrimitiveS32
- func (s32 *PrimitiveS32) ANDNOT(other *PrimitiveS32) *PrimitiveS32
- func (s32 *PrimitiveS32) Copy() RVType
- func (s32 *PrimitiveS32) Equals(o RVType) bool
- func (s32 *PrimitiveS32) ExtractFrom(readable Readable) error
- func (s32 *PrimitiveS32) LShift(other *PrimitiveS32) *PrimitiveS32
- func (s32 *PrimitiveS32) NOT() *PrimitiveS32
- func (s32 *PrimitiveS32) OR(other *PrimitiveS32) *PrimitiveS32
- func (s32 *PrimitiveS32) PAND(value int32) int32
- func (s32 *PrimitiveS32) PANDNOT(value int32) int32
- func (s32 *PrimitiveS32) PLShift(value int32) int32
- func (s32 *PrimitiveS32) PNOT() int32
- func (s32 *PrimitiveS32) POR(value int32) int32
- func (s32 *PrimitiveS32) PRShift(value int32) int32
- func (s32 *PrimitiveS32) PXOR(value int32) int32
- func (s32 *PrimitiveS32) RShift(other *PrimitiveS32) *PrimitiveS32
- func (s32 *PrimitiveS32) String() string
- func (s32 *PrimitiveS32) WriteTo(writable Writable)
- func (s32 *PrimitiveS32) XOR(other *PrimitiveS32) *PrimitiveS32
- type PrimitiveS64
- func (s64 *PrimitiveS64) AND(other *PrimitiveS64) *PrimitiveS64
- func (s64 *PrimitiveS64) ANDNOT(other *PrimitiveS64) *PrimitiveS64
- func (s64 *PrimitiveS64) Copy() RVType
- func (s64 *PrimitiveS64) Equals(o RVType) bool
- func (s64 *PrimitiveS64) ExtractFrom(readable Readable) error
- func (s64 *PrimitiveS64) LShift(other *PrimitiveS64) *PrimitiveS64
- func (s64 *PrimitiveS64) NOT() *PrimitiveS64
- func (s64 *PrimitiveS64) OR(other *PrimitiveS64) *PrimitiveS64
- func (s64 *PrimitiveS64) PAND(value int64) int64
- func (s64 *PrimitiveS64) PANDNOT(value int64) int64
- func (s64 *PrimitiveS64) PLShift(value int64) int64
- func (s64 *PrimitiveS64) PNOT() int64
- func (s64 *PrimitiveS64) POR(value int64) int64
- func (s64 *PrimitiveS64) PRShift(value int64) int64
- func (s64 *PrimitiveS64) PXOR(value int64) int64
- func (s64 *PrimitiveS64) RShift(other *PrimitiveS64) *PrimitiveS64
- func (s64 *PrimitiveS64) String() string
- func (s64 *PrimitiveS64) WriteTo(writable Writable)
- func (s64 *PrimitiveS64) XOR(other *PrimitiveS64) *PrimitiveS64
- type PrimitiveS8
- func (s8 *PrimitiveS8) AND(other *PrimitiveS8) *PrimitiveS8
- func (s8 *PrimitiveS8) ANDNOT(other *PrimitiveS8) *PrimitiveS8
- func (s8 *PrimitiveS8) Copy() RVType
- func (s8 *PrimitiveS8) Equals(o RVType) bool
- func (s8 *PrimitiveS8) ExtractFrom(readable Readable) error
- func (s8 *PrimitiveS8) LShift(other *PrimitiveS8) *PrimitiveS8
- func (s8 *PrimitiveS8) NOT() *PrimitiveS8
- func (s8 *PrimitiveS8) OR(other *PrimitiveS8) *PrimitiveS8
- func (s8 *PrimitiveS8) PAND(value int8) int8
- func (s8 *PrimitiveS8) PANDNOT(value int8) int8
- func (s8 *PrimitiveS8) PLShift(value int8) int8
- func (s8 *PrimitiveS8) PNOT() int8
- func (s8 *PrimitiveS8) POR(value int8) int8
- func (s8 *PrimitiveS8) PRShift(value int8) int8
- func (s8 *PrimitiveS8) PXOR(value int8) int8
- func (s8 *PrimitiveS8) RShift(other *PrimitiveS8) *PrimitiveS8
- func (s8 *PrimitiveS8) String() string
- func (s8 *PrimitiveS8) WriteTo(writable Writable)
- func (s8 *PrimitiveS8) XOR(other *PrimitiveS8) *PrimitiveS8
- type PrimitiveU16
- func (u16 *PrimitiveU16) AND(other *PrimitiveU16) *PrimitiveU16
- func (u16 *PrimitiveU16) ANDNOT(other *PrimitiveU16) *PrimitiveU16
- func (u16 *PrimitiveU16) Copy() RVType
- func (u16 *PrimitiveU16) Equals(o RVType) bool
- func (u16 *PrimitiveU16) ExtractFrom(readable Readable) error
- func (u16 *PrimitiveU16) LShift(other *PrimitiveU16) *PrimitiveU16
- func (u16 *PrimitiveU16) NOT() *PrimitiveU16
- func (u16 *PrimitiveU16) OR(other *PrimitiveU16) *PrimitiveU16
- func (u16 *PrimitiveU16) PAND(value uint16) uint16
- func (u16 *PrimitiveU16) PANDNOT(value uint16) uint16
- func (u16 *PrimitiveU16) PLShift(value uint16) uint16
- func (u16 *PrimitiveU16) PNOT() uint16
- func (u16 *PrimitiveU16) POR(value uint16) uint16
- func (u16 *PrimitiveU16) PRShift(value uint16) uint16
- func (u16 *PrimitiveU16) PXOR(value uint16) uint16
- func (u16 *PrimitiveU16) RShift(other *PrimitiveU16) *PrimitiveU16
- func (u16 *PrimitiveU16) String() string
- func (u16 *PrimitiveU16) WriteTo(writable Writable)
- func (u16 *PrimitiveU16) XOR(other *PrimitiveU16) *PrimitiveU16
- type PrimitiveU32
- func (u32 *PrimitiveU32) AND(other *PrimitiveU32) *PrimitiveU32
- func (u32 *PrimitiveU32) ANDNOT(other *PrimitiveU32) *PrimitiveU32
- func (u32 *PrimitiveU32) Copy() RVType
- func (u32 *PrimitiveU32) Equals(o RVType) bool
- func (u32 *PrimitiveU32) ExtractFrom(readable Readable) error
- func (u32 *PrimitiveU32) LShift(other *PrimitiveU32) *PrimitiveU32
- func (u32 *PrimitiveU32) NOT() *PrimitiveU32
- func (u32 *PrimitiveU32) OR(other *PrimitiveU32) *PrimitiveU32
- func (u32 *PrimitiveU32) PAND(value uint32) uint32
- func (u32 *PrimitiveU32) PANDNOT(value uint32) uint32
- func (u32 *PrimitiveU32) PLShift(value uint32) uint32
- func (u32 *PrimitiveU32) PNOT() uint32
- func (u32 *PrimitiveU32) POR(value uint32) uint32
- func (u32 *PrimitiveU32) PRShift(value uint32) uint32
- func (u32 *PrimitiveU32) PXOR(value uint32) uint32
- func (u32 *PrimitiveU32) RShift(other *PrimitiveU32) *PrimitiveU32
- func (u32 *PrimitiveU32) String() string
- func (u32 *PrimitiveU32) WriteTo(writable Writable)
- func (u32 *PrimitiveU32) XOR(other *PrimitiveU32) *PrimitiveU32
- type PrimitiveU64
- func (u64 *PrimitiveU64) AND(other *PrimitiveU64) *PrimitiveU64
- func (u64 *PrimitiveU64) ANDNOT(other *PrimitiveU64) *PrimitiveU64
- func (u64 *PrimitiveU64) Copy() RVType
- func (u64 *PrimitiveU64) Equals(o RVType) bool
- func (u64 *PrimitiveU64) ExtractFrom(readable Readable) error
- func (u64 *PrimitiveU64) LShift(other *PrimitiveU64) *PrimitiveU64
- func (u64 *PrimitiveU64) NOT() *PrimitiveU64
- func (u64 *PrimitiveU64) OR(other *PrimitiveU64) *PrimitiveU64
- func (u64 *PrimitiveU64) PAND(value uint64) uint64
- func (u64 *PrimitiveU64) PANDNOT(value uint64) uint64
- func (u64 *PrimitiveU64) PLShift(value uint64) uint64
- func (u64 *PrimitiveU64) PNOT() uint64
- func (u64 *PrimitiveU64) POR(value uint64) uint64
- func (u64 *PrimitiveU64) PRShift(value uint64) uint64
- func (u64 *PrimitiveU64) PXOR(value uint64) uint64
- func (u64 *PrimitiveU64) RShift(other *PrimitiveU64) *PrimitiveU64
- func (u64 *PrimitiveU64) String() string
- func (u64 *PrimitiveU64) WriteTo(writable Writable)
- func (u64 *PrimitiveU64) XOR(other *PrimitiveU64) *PrimitiveU64
- type PrimitiveU8
- func (u8 *PrimitiveU8) AND(other *PrimitiveU8) *PrimitiveU8
- func (u8 *PrimitiveU8) ANDNOT(other *PrimitiveU8) *PrimitiveU8
- func (u8 *PrimitiveU8) Copy() RVType
- func (u8 *PrimitiveU8) Equals(o RVType) bool
- func (u8 *PrimitiveU8) ExtractFrom(readable Readable) error
- func (u8 *PrimitiveU8) LShift(other *PrimitiveU8) *PrimitiveU8
- func (u8 *PrimitiveU8) NOT() *PrimitiveU8
- func (u8 *PrimitiveU8) OR(other *PrimitiveU8) *PrimitiveU8
- func (u8 *PrimitiveU8) PAND(value uint8) uint8
- func (u8 *PrimitiveU8) PANDNOT(value uint8) uint8
- func (u8 *PrimitiveU8) PLShift(value uint8) uint8
- func (u8 *PrimitiveU8) PNOT() uint8
- func (u8 *PrimitiveU8) POR(value uint8) uint8
- func (u8 *PrimitiveU8) PRShift(value uint8) uint8
- func (u8 *PrimitiveU8) PXOR(value uint8) uint8
- func (u8 *PrimitiveU8) RShift(other *PrimitiveU8) *PrimitiveU8
- func (u8 *PrimitiveU8) String() string
- func (u8 *PrimitiveU8) WriteTo(writable Writable)
- func (u8 *PrimitiveU8) XOR(other *PrimitiveU8) *PrimitiveU8
- type QBuffer
- type QResult
- func (r *QResult) Copy() RVType
- func (r *QResult) Equals(o RVType) bool
- func (r *QResult) ExtractFrom(readable Readable) error
- func (r *QResult) FormatToString(indentationLevel int) string
- func (r *QResult) IsError() bool
- func (r *QResult) IsSuccess() bool
- func (r *QResult) String() string
- func (r *QResult) WriteTo(writable Writable)
- type QUUID
- func (qu *QUUID) Copy() RVType
- func (qu *QUUID) Equals(o RVType) bool
- func (qu *QUUID) ExtractFrom(readable Readable) error
- func (qu *QUUID) FormatToString(indentationLevel int) string
- func (qu *QUUID) FromString(uuid string) error
- func (qu *QUUID) GetStringValue() string
- func (qu *QUUID) String() string
- func (qu *QUUID) WriteTo(writable Writable)
- type RVConnectionData
- func (rvcd *RVConnectionData) Copy() RVType
- func (rvcd *RVConnectionData) Equals(o RVType) bool
- func (rvcd *RVConnectionData) ExtractFrom(readable Readable) error
- func (rvcd *RVConnectionData) FormatToString(indentationLevel int) string
- func (rvcd *RVConnectionData) String() string
- func (rvcd *RVConnectionData) WriteTo(writable Writable)
- type RVType
- type Readable
- type ResultRange
- type StationURL
- func (s *StationURL) Address() (string, bool)
- func (s *StationURL) ConnectionID() (uint32, bool)
- func (s *StationURL) Copy() RVType
- func (s *StationURL) EncodeToString() string
- func (s *StationURL) Equals(o RVType) bool
- func (s *StationURL) ExtractFrom(readable Readable) error
- func (s *StationURL) FormatToString(indentationLevel int) string
- func (s *StationURL) FromString(str string)
- func (s *StationURL) IsBehindNAT() bool
- func (s *StationURL) IsFastProbeResponseEnabled() bool
- func (s *StationURL) IsNATPMPSupported() bool
- func (s *StationURL) IsProbeRequestInitiationEnabled() bool
- func (s *StationURL) IsPublic() bool
- func (s *StationURL) IsRelayServerEnabled() bool
- func (s *StationURL) IsUPnPSupported() bool
- func (s *StationURL) NATFiltering() (constants.NATFilteringProperties, bool)
- func (s *StationURL) NATMapping() (constants.NATMappingProperties, bool)
- func (s *StationURL) NodeID() (uint16, bool)
- func (s *StationURL) ParamValue(name string) (string, bool)
- func (s *StationURL) PlatformType() (uint8, bool)
- func (s *StationURL) PortNumber() (uint16, bool)
- func (s *StationURL) PrincipalID() (*PID, bool)
- func (s *StationURL) ProbeRequestID() (uint32, bool)
- func (s *StationURL) RVConnectionID() (uint32, bool)
- func (s *StationURL) RelayAddress() (string, bool)
- func (s *StationURL) RelayPort() (uint16, bool)
- func (s *StationURL) RelayServerAddress() (string, bool)
- func (s *StationURL) RelayServerPort() (uint16, bool)
- func (s *StationURL) RemoveParam(name string)
- func (s *StationURL) SetAddress(address string)
- func (s *StationURL) SetConnectionID(connectionID uint32)
- func (s *StationURL) SetFastProbeResponse(fast bool)
- func (s *StationURL) SetNATFiltering(filtering constants.NATFilteringProperties)
- func (s *StationURL) SetNATMapping(mapping constants.NATMappingProperties)
- func (s *StationURL) SetNATPMPSupport(supported bool)
- func (s *StationURL) SetNodeID(nodeID uint16)
- func (s *StationURL) SetParamValue(name, value string)
- func (s *StationURL) SetPlatformType(platformType uint8)
- func (s *StationURL) SetPortNumber(port uint16)
- func (s *StationURL) SetPrincipalID(pid *PID)
- func (s *StationURL) SetProbeRequestID(probeRequestID uint32)
- func (s *StationURL) SetProbeRequestInitiation(probeinit bool)
- func (s *StationURL) SetRVConnectionID(connectionID uint32)
- func (s *StationURL) SetRelayAddress(address string)
- func (s *StationURL) SetRelayPort(port uint16)
- func (s *StationURL) SetRelayServerAddress(address string)
- func (s *StationURL) SetRelayServerPort(port uint16)
- func (s *StationURL) SetStreamID(streamID uint8)
- func (s *StationURL) SetStreamType(streamType constants.StreamType)
- func (s *StationURL) SetType(flags uint8)
- func (s *StationURL) SetUPnPSupport(supported bool)
- func (s *StationURL) SetURLType(urlType constants.StationURLType)
- func (s *StationURL) SetUseRelayServer(useRelayServer bool)
- func (s *StationURL) StreamID() (uint8, bool)
- func (s *StationURL) StreamType() (constants.StreamType, bool)
- func (s *StationURL) String() string
- func (s *StationURL) Type() (uint8, bool)
- func (s *StationURL) URLType() constants.StationURLType
- func (s *StationURL) WriteTo(writable Writable)
- type String
- type Structure
- type Variant
- type Writable
Constants ¶
This section is empty.
Variables ¶
var AnyDataHolderObjects = make(map[string]RVType)
AnyDataHolderObjects holds a mapping of RVTypes that are accessible in a AnyDataHolder
var VariantTypes = make(map[uint8]RVType)
VariantTypes holds a mapping of RVTypes that are accessible in a Variant
Functions ¶
func RegisterDataHolderType ¶
RegisterDataHolderType registers a RVType to be accessible in a AnyDataHolder
func RegisterVariantType ¶
RegisterVariantType registers a RVType to be accessible in a Variant
Types ¶
type AnyDataHolder ¶
type AnyDataHolder struct { TypeName *String Length1 *PrimitiveU32 // Length of ObjectData + Length2 Length2 *PrimitiveU32 // Length of ObjectData ObjectData RVType }
AnyDataHolder is a class which can contain any Structure. The official type name and namespace is unknown. These Structures usually inherit from at least one other Structure. Typically this base class is the empty `Data` Structure, but this is not always the case. The contained Structures name & length are sent with the Structure body, so the receiver can properly decode it.
func NewAnyDataHolder ¶
func NewAnyDataHolder() *AnyDataHolder
NewAnyDataHolder returns a new AnyDataHolder
func (*AnyDataHolder) Copy ¶
func (adh *AnyDataHolder) Copy() RVType
Copy returns a new copied instance of AnyDataHolder
func (*AnyDataHolder) Equals ¶
func (adh *AnyDataHolder) Equals(o RVType) bool
Equals checks if the passed Structure contains the same data as the current instance
func (*AnyDataHolder) ExtractFrom ¶
func (adh *AnyDataHolder) ExtractFrom(readable Readable) error
ExtractFrom extracts the AnyDataHolder from the given readable
func (*AnyDataHolder) FormatToString ¶
func (adh *AnyDataHolder) FormatToString(indentationLevel int) string
FormatToString pretty-prints the struct data using the provided indentation level
func (*AnyDataHolder) String ¶
func (adh *AnyDataHolder) String() string
String returns a string representation of the struct
func (*AnyDataHolder) WriteTo ¶
func (adh *AnyDataHolder) WriteTo(writable Writable)
WriteTo writes the AnyDataHolder to the given writable
type Buffer ¶
type Buffer struct {
Value []byte
}
Buffer is an implementation of rdv::Buffer. Wraps a primitive Go byte slice. Same as QBuffer but with a uint32 length field.
func (*Buffer) Copy ¶
Copy returns a pointer to a copy of the Buffer. Requires type assertion when used
func (*Buffer) ExtractFrom ¶
ExtractFrom extracts the Buffer from the given readable
type ClassVersionContainer ¶
type ClassVersionContainer struct { Structure ClassVersions *Map[*String, *PrimitiveU16] }
ClassVersionContainer is an implementation of rdv::ClassVersionContainer. Contains version info for Structures used in verbose RMC messages.
func NewClassVersionContainer ¶
func NewClassVersionContainer() *ClassVersionContainer
NewClassVersionContainer returns a new ClassVersionContainer
func (*ClassVersionContainer) Copy ¶
func (cvc *ClassVersionContainer) Copy() RVType
Copy returns a pointer to a copy of the ClassVersionContainer. Requires type assertion when used
func (*ClassVersionContainer) Equals ¶
func (cvc *ClassVersionContainer) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*ClassVersionContainer) ExtractFrom ¶
func (cvc *ClassVersionContainer) ExtractFrom(readable Readable) error
ExtractFrom extracts the ClassVersionContainer from the given readable
func (*ClassVersionContainer) FormatToString ¶
func (cvc *ClassVersionContainer) FormatToString(indentationLevel int) string
FormatToString pretty-prints the struct data using the provided indentation level
func (*ClassVersionContainer) String ¶
func (cvc *ClassVersionContainer) String() string
String returns a string representation of the struct
func (*ClassVersionContainer) WriteTo ¶
func (cvc *ClassVersionContainer) WriteTo(writable Writable)
WriteTo writes the ClassVersionContainer to the given writable
type Data ¶
type Data struct {
Structure
}
Data is an implementation of rdv::Data. This structure has no data, and instead acts as the base class for many other structures.
func (*Data) ExtractFrom ¶
ExtractFrom extracts the Data from the given readable
func (*Data) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
type DateTime ¶
type DateTime struct {
// contains filtered or unexported fields
}
DateTime is an implementation of rdv::DateTime. The underlying value is a uint64 bit field containing date and time information.
func NewDateTime ¶
NewDateTime returns a new DateTime instance
func (*DateTime) ExtractFrom ¶
ExtractFrom extracts the DateTime from the given readable
func (*DateTime) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
func (*DateTime) FromTimestamp ¶
FromTimestamp converts a Time timestamp into a NEX DateTime
type List ¶
type List[T RVType] struct { Type T // contains filtered or unexported fields }
List is an implementation of rdv::qList. This data type holds an array of other types.
Unlike Buffer and qBuffer, which use the same data type with differing size field lengths, there does not seem to be an official rdv::List type
func (*List[T]) Append ¶
func (l *List[T]) Append(value T)
Append appends an element to the List internal slice
func (*List[T]) Copy ¶
Copy returns a pointer to a copy of the List. Requires type assertion when used
func (*List[T]) DeleteIndex ¶
DeleteIndex deletes an element at the given index. Returns an error if the index is OOB
func (*List[T]) Each ¶
Each runs a callback function for every element in the List The List should not be modified inside the callback function Returns true if the loop was terminated early
func (*List[T]) ExtractFrom ¶
ExtractFrom extracts the List from the given readable
func (*List[T]) Get ¶
Get returns an element at the given index. Returns an error if the index is OOB
func (*List[T]) Remove ¶
func (l *List[T]) Remove(check T)
Remove removes the first occurance of the input from the List. Returns an error if the index is OOB
func (*List[T]) SetFromData ¶
func (l *List[T]) SetFromData(data []T)
SetFromData sets the List's internal slice to the input data
func (*List[T]) Slice ¶
func (l *List[T]) Slice() []T
Slice returns the real underlying slice for the List
type Map ¶
type Map[K RVType, V RVType] struct { KeyType K ValueType V // contains filtered or unexported fields }
Map represents a Quazal Rendez-Vous/NEX Map type.
There is not an official type in either the rdv or nn::nex namespaces. The data is stored as an array of key-value pairs.
func (*Map[K, V]) Copy ¶
Copy returns a pointer to a copy of the Map. Requires type assertion when used
func (*Map[K, V]) ExtractFrom ¶
ExtractFrom extracts the Map from the given readable
func (*Map[K, V]) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
func (*Map[K, V]) Set ¶
func (m *Map[K, V]) Set(key K, value V)
Set sets an element to the Map internal slices
type PID ¶
type PID struct {
// contains filtered or unexported fields
}
PID represents a unique number to identify a user. The official library treats this as a primitive integer.
The true size of this value depends on the client version. Legacy clients (WiiU/3DS) use a uint32, whereas modern clients (Nintendo Switch) use a uint64. Value is always stored as the higher uint64, the consuming API should assert accordingly
func (*PID) ExtractFrom ¶
ExtractFrom extracts the PID from the given readable
func (*PID) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
func (*PID) LegacyValue ¶
LegacyValue returns the numeric value of the PID as a uint32, for legacy clients
type PrimitiveBool ¶
type PrimitiveBool struct {
Value bool
}
PrimitiveBool is wrapper around a Go primitive bool with receiver methods to conform to RVType
func NewPrimitiveBool ¶
func NewPrimitiveBool(boolean bool) *PrimitiveBool
NewPrimitiveBool returns a new PrimitiveBool
func (*PrimitiveBool) Copy ¶
func (b *PrimitiveBool) Copy() RVType
Copy returns a pointer to a copy of the PrimitiveBool. Requires type assertion when used
func (*PrimitiveBool) Equals ¶
func (b *PrimitiveBool) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveBool) ExtractFrom ¶
func (b *PrimitiveBool) ExtractFrom(readable Readable) error
ExtractFrom extracts the bool from the given readable
func (*PrimitiveBool) String ¶
func (b *PrimitiveBool) String() string
String returns a string representation of the struct
func (*PrimitiveBool) WriteTo ¶
func (b *PrimitiveBool) WriteTo(writable Writable)
WriteTo writes the bool to the given writable
type PrimitiveF32 ¶
type PrimitiveF32 struct {
Value float32
}
PrimitiveF32 is wrapper around a Go primitive float32 with receiver methods to conform to RVType
func NewPrimitiveF32 ¶
func NewPrimitiveF32(float float32) *PrimitiveF32
NewPrimitiveF32 returns a new PrimitiveF32
func (*PrimitiveF32) Copy ¶
func (f32 *PrimitiveF32) Copy() RVType
Copy returns a pointer to a copy of the float32. Requires type assertion when used
func (*PrimitiveF32) Equals ¶
func (f32 *PrimitiveF32) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveF32) ExtractFrom ¶
func (f32 *PrimitiveF32) ExtractFrom(readable Readable) error
ExtractFrom extracts the float32 from the given readable
func (*PrimitiveF32) String ¶
func (f32 *PrimitiveF32) String() string
String returns a string representation of the struct
func (*PrimitiveF32) WriteTo ¶
func (f32 *PrimitiveF32) WriteTo(writable Writable)
WriteTo writes the float32 to the given writable
type PrimitiveF64 ¶
type PrimitiveF64 struct {
Value float64
}
PrimitiveF64 is wrapper around a Go primitive float64 with receiver methods to conform to RVType
func NewPrimitiveF64 ¶
func NewPrimitiveF64(float float64) *PrimitiveF64
NewPrimitiveF64 returns a new PrimitiveF64
func (*PrimitiveF64) Copy ¶
func (f64 *PrimitiveF64) Copy() RVType
Copy returns a pointer to a copy of the float64. Requires type assertion when used
func (*PrimitiveF64) Equals ¶
func (f64 *PrimitiveF64) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveF64) ExtractFrom ¶
func (f64 *PrimitiveF64) ExtractFrom(readable Readable) error
ExtractFrom extracts the float64 from the given readable
func (*PrimitiveF64) String ¶
func (f64 *PrimitiveF64) String() string
String returns a string representation of the struct
func (*PrimitiveF64) WriteTo ¶
func (f64 *PrimitiveF64) WriteTo(writable Writable)
WriteTo writes the float64 to the given writable
type PrimitiveS16 ¶
type PrimitiveS16 struct {
Value int16
}
PrimitiveS16 is wrapper around a Go primitive int16 with receiver methods to conform to RVType
func NewPrimitiveS16 ¶
func NewPrimitiveS16(i16 int16) *PrimitiveS16
NewPrimitiveS16 returns a new PrimitiveS16
func (*PrimitiveS16) AND ¶
func (s16 *PrimitiveS16) AND(other *PrimitiveS16) *PrimitiveS16
AND runs a bitwise AND operation on the PrimitiveS16 value. Consumes and returns a NEX primitive
func (*PrimitiveS16) ANDNOT ¶
func (s16 *PrimitiveS16) ANDNOT(other *PrimitiveS16) *PrimitiveS16
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveS16 value. Consumes and returns a NEX primitive
func (*PrimitiveS16) Copy ¶
func (s16 *PrimitiveS16) Copy() RVType
Copy returns a pointer to a copy of the int16. Requires type assertion when used
func (*PrimitiveS16) Equals ¶
func (s16 *PrimitiveS16) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveS16) ExtractFrom ¶
func (s16 *PrimitiveS16) ExtractFrom(readable Readable) error
ExtractFrom extracts the int16 from the given readable
func (*PrimitiveS16) LShift ¶
func (s16 *PrimitiveS16) LShift(other *PrimitiveS16) *PrimitiveS16
LShift runs a left shift operation on the PrimitiveS16 value. Consumes and returns a NEX primitive
func (*PrimitiveS16) NOT ¶
func (s16 *PrimitiveS16) NOT() *PrimitiveS16
NOT runs a bitwise NOT operation on the PrimitiveS16 value. Returns a NEX primitive
func (*PrimitiveS16) OR ¶
func (s16 *PrimitiveS16) OR(other *PrimitiveS16) *PrimitiveS16
OR runs a bitwise OR operation on the PrimitiveS16 value. Consumes and returns a NEX primitive
func (*PrimitiveS16) PAND ¶
func (s16 *PrimitiveS16) PAND(value int16) int16
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveS16 value. Consumes and returns a Go primitive
func (*PrimitiveS16) PANDNOT ¶
func (s16 *PrimitiveS16) PANDNOT(value int16) int16
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveS16 value. Consumes and returns a Go primitive
func (*PrimitiveS16) PLShift ¶
func (s16 *PrimitiveS16) PLShift(value int16) int16
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveS16 value. Consumes and returns a Go primitive
func (*PrimitiveS16) PNOT ¶
func (s16 *PrimitiveS16) PNOT() int16
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveS16 value. Returns a Go primitive
func (*PrimitiveS16) POR ¶
func (s16 *PrimitiveS16) POR(value int16) int16
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveS16 value. Consumes and returns a Go primitive
func (*PrimitiveS16) PRShift ¶
func (s16 *PrimitiveS16) PRShift(value int16) int16
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveS16 value. Consumes and returns a Go primitive
func (*PrimitiveS16) PXOR ¶
func (s16 *PrimitiveS16) PXOR(value int16) int16
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveS16 value. Consumes and returns a Go primitive
func (*PrimitiveS16) RShift ¶
func (s16 *PrimitiveS16) RShift(other *PrimitiveS16) *PrimitiveS16
RShift runs a right shift operation on the PrimitiveS16 value. Consumes and returns a NEX primitive
func (*PrimitiveS16) String ¶
func (s16 *PrimitiveS16) String() string
String returns a string representation of the struct
func (*PrimitiveS16) WriteTo ¶
func (s16 *PrimitiveS16) WriteTo(writable Writable)
WriteTo writes the int16 to the given writable
func (*PrimitiveS16) XOR ¶
func (s16 *PrimitiveS16) XOR(other *PrimitiveS16) *PrimitiveS16
XOR runs a bitwise XOR operation on the PrimitiveS16 value. Consumes and returns a NEX primitive
type PrimitiveS32 ¶
type PrimitiveS32 struct {
Value int32
}
PrimitiveS32 is wrapper around a Go primitive int32 with receiver methods to conform to RVType
func NewPrimitiveS32 ¶
func NewPrimitiveS32(i32 int32) *PrimitiveS32
NewPrimitiveS32 returns a new PrimitiveS32
func (*PrimitiveS32) AND ¶
func (s32 *PrimitiveS32) AND(other *PrimitiveS32) *PrimitiveS32
AND runs a bitwise AND operation on the PrimitiveS32 value. Consumes and returns a NEX primitive
func (*PrimitiveS32) ANDNOT ¶
func (s32 *PrimitiveS32) ANDNOT(other *PrimitiveS32) *PrimitiveS32
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveS32 value. Consumes and returns a NEX primitive
func (*PrimitiveS32) Copy ¶
func (s32 *PrimitiveS32) Copy() RVType
Copy returns a pointer to a copy of the int32. Requires type assertion when used
func (*PrimitiveS32) Equals ¶
func (s32 *PrimitiveS32) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveS32) ExtractFrom ¶
func (s32 *PrimitiveS32) ExtractFrom(readable Readable) error
ExtractFrom extracts the int32 from the given readable
func (*PrimitiveS32) LShift ¶
func (s32 *PrimitiveS32) LShift(other *PrimitiveS32) *PrimitiveS32
LShift runs a left shift operation on the PrimitiveS32 value. Consumes and returns a NEX primitive
func (*PrimitiveS32) NOT ¶
func (s32 *PrimitiveS32) NOT() *PrimitiveS32
NOT runs a bitwise NOT operation on the PrimitiveS32 value. Returns a NEX primitive
func (*PrimitiveS32) OR ¶
func (s32 *PrimitiveS32) OR(other *PrimitiveS32) *PrimitiveS32
OR runs a bitwise OR operation on the PrimitiveS32 value. Consumes and returns a NEX primitive
func (*PrimitiveS32) PAND ¶
func (s32 *PrimitiveS32) PAND(value int32) int32
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveS32 value. Consumes and returns a Go primitive
func (*PrimitiveS32) PANDNOT ¶
func (s32 *PrimitiveS32) PANDNOT(value int32) int32
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveS32 value. Consumes and returns a Go primitive
func (*PrimitiveS32) PLShift ¶
func (s32 *PrimitiveS32) PLShift(value int32) int32
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveS32 value. Consumes and returns a Go primitive
func (*PrimitiveS32) PNOT ¶
func (s32 *PrimitiveS32) PNOT() int32
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveS32 value. Returns a Go primitive
func (*PrimitiveS32) POR ¶
func (s32 *PrimitiveS32) POR(value int32) int32
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveS32 value. Consumes and returns a Go primitive
func (*PrimitiveS32) PRShift ¶
func (s32 *PrimitiveS32) PRShift(value int32) int32
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveS32 value. Consumes and returns a Go primitive
func (*PrimitiveS32) PXOR ¶
func (s32 *PrimitiveS32) PXOR(value int32) int32
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveS32 value. Consumes and returns a Go primitive
func (*PrimitiveS32) RShift ¶
func (s32 *PrimitiveS32) RShift(other *PrimitiveS32) *PrimitiveS32
RShift runs a right shift operation on the PrimitiveS32 value. Consumes and returns a NEX primitive
func (*PrimitiveS32) String ¶
func (s32 *PrimitiveS32) String() string
String returns a string representation of the struct
func (*PrimitiveS32) WriteTo ¶
func (s32 *PrimitiveS32) WriteTo(writable Writable)
WriteTo writes the int32 to the given writable
func (*PrimitiveS32) XOR ¶
func (s32 *PrimitiveS32) XOR(other *PrimitiveS32) *PrimitiveS32
XOR runs a bitwise XOR operation on the PrimitiveS32 value. Consumes and returns a NEX primitive
type PrimitiveS64 ¶
type PrimitiveS64 struct {
Value int64
}
PrimitiveS64 is wrapper around a Go primitive int64 with receiver methods to conform to RVType
func NewPrimitiveS64 ¶
func NewPrimitiveS64(i64 int64) *PrimitiveS64
NewPrimitiveS64 returns a new PrimitiveS64
func (*PrimitiveS64) AND ¶
func (s64 *PrimitiveS64) AND(other *PrimitiveS64) *PrimitiveS64
AND runs a bitwise AND operation on the PrimitiveS64 value. Consumes and returns a NEX primitive
func (*PrimitiveS64) ANDNOT ¶
func (s64 *PrimitiveS64) ANDNOT(other *PrimitiveS64) *PrimitiveS64
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveS64 value. Consumes and returns a NEX primitive
func (*PrimitiveS64) Copy ¶
func (s64 *PrimitiveS64) Copy() RVType
Copy returns a pointer to a copy of the int64. Requires type assertion when used
func (*PrimitiveS64) Equals ¶
func (s64 *PrimitiveS64) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveS64) ExtractFrom ¶
func (s64 *PrimitiveS64) ExtractFrom(readable Readable) error
ExtractFrom extracts the int64 from the given readable
func (*PrimitiveS64) LShift ¶
func (s64 *PrimitiveS64) LShift(other *PrimitiveS64) *PrimitiveS64
LShift runs a left shift operation on the PrimitiveS64 value. Consumes and returns a NEX primitive
func (*PrimitiveS64) NOT ¶
func (s64 *PrimitiveS64) NOT() *PrimitiveS64
NOT runs a bitwise NOT operation on the PrimitiveS64 value. Returns a NEX primitive
func (*PrimitiveS64) OR ¶
func (s64 *PrimitiveS64) OR(other *PrimitiveS64) *PrimitiveS64
OR runs a bitwise OR operation on the PrimitiveS64 value. Consumes and returns a NEX primitive
func (*PrimitiveS64) PAND ¶
func (s64 *PrimitiveS64) PAND(value int64) int64
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveS64 value. Consumes and returns a Go primitive
func (*PrimitiveS64) PANDNOT ¶
func (s64 *PrimitiveS64) PANDNOT(value int64) int64
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveS64 value. Consumes and returns a Go primitive
func (*PrimitiveS64) PLShift ¶
func (s64 *PrimitiveS64) PLShift(value int64) int64
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveS64 value. Consumes and returns a Go primitive
func (*PrimitiveS64) PNOT ¶
func (s64 *PrimitiveS64) PNOT() int64
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveS64 value. Returns a Go primitive
func (*PrimitiveS64) POR ¶
func (s64 *PrimitiveS64) POR(value int64) int64
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveS64 value. Consumes and returns a Go primitive
func (*PrimitiveS64) PRShift ¶
func (s64 *PrimitiveS64) PRShift(value int64) int64
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveS64 value. Consumes and returns a Go primitive
func (*PrimitiveS64) PXOR ¶
func (s64 *PrimitiveS64) PXOR(value int64) int64
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveS64 value. Consumes and returns a Go primitive
func (*PrimitiveS64) RShift ¶
func (s64 *PrimitiveS64) RShift(other *PrimitiveS64) *PrimitiveS64
RShift runs a right shift operation on the PrimitiveS64 value. Consumes and returns a NEX primitive
func (*PrimitiveS64) String ¶
func (s64 *PrimitiveS64) String() string
String returns a string representation of the struct
func (*PrimitiveS64) WriteTo ¶
func (s64 *PrimitiveS64) WriteTo(writable Writable)
WriteTo writes the int64 to the given writable
func (*PrimitiveS64) XOR ¶
func (s64 *PrimitiveS64) XOR(other *PrimitiveS64) *PrimitiveS64
XOR runs a bitwise XOR operation on the PrimitiveS64 value. Consumes and returns a NEX primitive
type PrimitiveS8 ¶
type PrimitiveS8 struct {
Value int8
}
PrimitiveS8 is wrapper around a Go primitive int8 with receiver methods to conform to RVType
func NewPrimitiveS8 ¶
func NewPrimitiveS8(i8 int8) *PrimitiveS8
NewPrimitiveS8 returns a new PrimitiveS8
func (*PrimitiveS8) AND ¶
func (s8 *PrimitiveS8) AND(other *PrimitiveS8) *PrimitiveS8
AND runs a bitwise AND operation on the PrimitiveS8 value. Consumes and returns a NEX primitive
func (*PrimitiveS8) ANDNOT ¶
func (s8 *PrimitiveS8) ANDNOT(other *PrimitiveS8) *PrimitiveS8
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveS8 value. Consumes and returns a NEX primitive
func (*PrimitiveS8) Copy ¶
func (s8 *PrimitiveS8) Copy() RVType
Copy returns a pointer to a copy of the int8. Requires type assertion when used
func (*PrimitiveS8) Equals ¶
func (s8 *PrimitiveS8) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveS8) ExtractFrom ¶
func (s8 *PrimitiveS8) ExtractFrom(readable Readable) error
ExtractFrom extracts the int8 from the given readable
func (*PrimitiveS8) LShift ¶
func (s8 *PrimitiveS8) LShift(other *PrimitiveS8) *PrimitiveS8
LShift runs a left shift operation on the PrimitiveS8 value. Consumes and returns a NEX primitive
func (*PrimitiveS8) NOT ¶
func (s8 *PrimitiveS8) NOT() *PrimitiveS8
NOT runs a bitwise NOT operation on the PrimitiveS8 value. Returns a NEX primitive
func (*PrimitiveS8) OR ¶
func (s8 *PrimitiveS8) OR(other *PrimitiveS8) *PrimitiveS8
OR runs a bitwise OR operation on the PrimitiveS8 value. Consumes and returns a NEX primitive
func (*PrimitiveS8) PAND ¶
func (s8 *PrimitiveS8) PAND(value int8) int8
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveS8 value. Consumes and returns a Go primitive
func (*PrimitiveS8) PANDNOT ¶
func (s8 *PrimitiveS8) PANDNOT(value int8) int8
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveS8 value. Consumes and returns a Go primitive
func (*PrimitiveS8) PLShift ¶
func (s8 *PrimitiveS8) PLShift(value int8) int8
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveS8 value. Consumes and returns a Go primitive
func (*PrimitiveS8) PNOT ¶
func (s8 *PrimitiveS8) PNOT() int8
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveS8 value. Returns a Go primitive
func (*PrimitiveS8) POR ¶
func (s8 *PrimitiveS8) POR(value int8) int8
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveS8 value. Consumes and returns a Go primitive
func (*PrimitiveS8) PRShift ¶
func (s8 *PrimitiveS8) PRShift(value int8) int8
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveS8 value. Consumes and returns a Go primitive
func (*PrimitiveS8) PXOR ¶
func (s8 *PrimitiveS8) PXOR(value int8) int8
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveS8 value. Consumes and returns a Go primitive
func (*PrimitiveS8) RShift ¶
func (s8 *PrimitiveS8) RShift(other *PrimitiveS8) *PrimitiveS8
RShift runs a right shift operation on the PrimitiveS8 value. Consumes and returns a NEX primitive
func (*PrimitiveS8) String ¶
func (s8 *PrimitiveS8) String() string
String returns a string representation of the struct
func (*PrimitiveS8) WriteTo ¶
func (s8 *PrimitiveS8) WriteTo(writable Writable)
WriteTo writes the int8 to the given writable
func (*PrimitiveS8) XOR ¶
func (s8 *PrimitiveS8) XOR(other *PrimitiveS8) *PrimitiveS8
XOR runs a bitwise XOR operation on the PrimitiveS8 value. Consumes and returns a NEX primitive
type PrimitiveU16 ¶
type PrimitiveU16 struct {
Value uint16
}
PrimitiveU16 is wrapper around a Go primitive uint16 with receiver methods to conform to RVType
func NewPrimitiveU16 ¶
func NewPrimitiveU16(ui16 uint16) *PrimitiveU16
NewPrimitiveU16 returns a new PrimitiveU16
func (*PrimitiveU16) AND ¶
func (u16 *PrimitiveU16) AND(other *PrimitiveU16) *PrimitiveU16
AND runs a bitwise AND operation on the PrimitiveU16 value. Consumes and returns a NEX primitive
func (*PrimitiveU16) ANDNOT ¶
func (u16 *PrimitiveU16) ANDNOT(other *PrimitiveU16) *PrimitiveU16
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveU16 value. Consumes and returns a NEX primitive
func (*PrimitiveU16) Copy ¶
func (u16 *PrimitiveU16) Copy() RVType
Copy returns a pointer to a copy of the uint16. Requires type assertion when used
func (*PrimitiveU16) Equals ¶
func (u16 *PrimitiveU16) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveU16) ExtractFrom ¶
func (u16 *PrimitiveU16) ExtractFrom(readable Readable) error
ExtractFrom extracts the uint16 from the given readable
func (*PrimitiveU16) LShift ¶
func (u16 *PrimitiveU16) LShift(other *PrimitiveU16) *PrimitiveU16
LShift runs a left shift operation on the PrimitiveU16 value. Consumes and returns a NEX primitive
func (*PrimitiveU16) NOT ¶
func (u16 *PrimitiveU16) NOT() *PrimitiveU16
NOT runs a bitwise NOT operation on the PrimitiveU16 value. Returns a NEX primitive
func (*PrimitiveU16) OR ¶
func (u16 *PrimitiveU16) OR(other *PrimitiveU16) *PrimitiveU16
OR runs a bitwise OR operation on the PrimitiveU16 value. Consumes and returns a NEX primitive
func (*PrimitiveU16) PAND ¶
func (u16 *PrimitiveU16) PAND(value uint16) uint16
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveU16 value. Consumes and returns a Go primitive
func (*PrimitiveU16) PANDNOT ¶
func (u16 *PrimitiveU16) PANDNOT(value uint16) uint16
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveU16 value. Consumes and returns a Go primitive
func (*PrimitiveU16) PLShift ¶
func (u16 *PrimitiveU16) PLShift(value uint16) uint16
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveU16 value. Consumes and returns a Go primitive
func (*PrimitiveU16) PNOT ¶
func (u16 *PrimitiveU16) PNOT() uint16
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveU16 value. Returns a Go primitive
func (*PrimitiveU16) POR ¶
func (u16 *PrimitiveU16) POR(value uint16) uint16
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveU16 value. Consumes and returns a Go primitive
func (*PrimitiveU16) PRShift ¶
func (u16 *PrimitiveU16) PRShift(value uint16) uint16
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveU16 value. Consumes and returns a Go primitive
func (*PrimitiveU16) PXOR ¶
func (u16 *PrimitiveU16) PXOR(value uint16) uint16
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveU16 value. Consumes and returns a Go primitive
func (*PrimitiveU16) RShift ¶
func (u16 *PrimitiveU16) RShift(other *PrimitiveU16) *PrimitiveU16
RShift runs a right shift operation on the PrimitiveU16 value. Consumes and returns a NEX primitive
func (*PrimitiveU16) String ¶
func (u16 *PrimitiveU16) String() string
String returns a string representation of the struct
func (*PrimitiveU16) WriteTo ¶
func (u16 *PrimitiveU16) WriteTo(writable Writable)
WriteTo writes the uint16 to the given writable
func (*PrimitiveU16) XOR ¶
func (u16 *PrimitiveU16) XOR(other *PrimitiveU16) *PrimitiveU16
XOR runs a bitwise XOR operation on the PrimitiveU16 value. Consumes and returns a NEX primitive
type PrimitiveU32 ¶
type PrimitiveU32 struct {
Value uint32
}
PrimitiveU32 is wrapper around a Go primitive uint32 with receiver methods to conform to RVType
func NewPrimitiveU32 ¶
func NewPrimitiveU32(ui32 uint32) *PrimitiveU32
NewPrimitiveU32 returns a new PrimitiveU32
func (*PrimitiveU32) AND ¶
func (u32 *PrimitiveU32) AND(other *PrimitiveU32) *PrimitiveU32
AND runs a bitwise AND operation on the PrimitiveU32 value. Consumes and returns a NEX primitive
func (*PrimitiveU32) ANDNOT ¶
func (u32 *PrimitiveU32) ANDNOT(other *PrimitiveU32) *PrimitiveU32
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveU32 value. Consumes and returns a NEX primitive
func (*PrimitiveU32) Copy ¶
func (u32 *PrimitiveU32) Copy() RVType
Copy returns a pointer to a copy of the uint32. Requires type assertion when used
func (*PrimitiveU32) Equals ¶
func (u32 *PrimitiveU32) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveU32) ExtractFrom ¶
func (u32 *PrimitiveU32) ExtractFrom(readable Readable) error
ExtractFrom extracts the uint32 from the given readable
func (*PrimitiveU32) LShift ¶
func (u32 *PrimitiveU32) LShift(other *PrimitiveU32) *PrimitiveU32
LShift runs a left shift operation on the PrimitiveU32 value. Consumes and returns a NEX primitive
func (*PrimitiveU32) NOT ¶
func (u32 *PrimitiveU32) NOT() *PrimitiveU32
NOT runs a bitwise NOT operation on the PrimitiveU32 value. Returns a NEX primitive
func (*PrimitiveU32) OR ¶
func (u32 *PrimitiveU32) OR(other *PrimitiveU32) *PrimitiveU32
OR runs a bitwise OR operation on the PrimitiveU32 value. Consumes and returns a NEX primitive
func (*PrimitiveU32) PAND ¶
func (u32 *PrimitiveU32) PAND(value uint32) uint32
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveU32 value. Consumes and returns a Go primitive
func (*PrimitiveU32) PANDNOT ¶
func (u32 *PrimitiveU32) PANDNOT(value uint32) uint32
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveU32 value. Consumes and returns a Go primitive
func (*PrimitiveU32) PLShift ¶
func (u32 *PrimitiveU32) PLShift(value uint32) uint32
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveU32 value. Consumes and returns a Go primitive
func (*PrimitiveU32) PNOT ¶
func (u32 *PrimitiveU32) PNOT() uint32
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveU32 value. Returns a Go primitive
func (*PrimitiveU32) POR ¶
func (u32 *PrimitiveU32) POR(value uint32) uint32
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveU32 value. Consumes and returns a Go primitive
func (*PrimitiveU32) PRShift ¶
func (u32 *PrimitiveU32) PRShift(value uint32) uint32
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveU32 value. Consumes and returns a Go primitive
func (*PrimitiveU32) PXOR ¶
func (u32 *PrimitiveU32) PXOR(value uint32) uint32
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveU32 value. Consumes and returns a Go primitive
func (*PrimitiveU32) RShift ¶
func (u32 *PrimitiveU32) RShift(other *PrimitiveU32) *PrimitiveU32
RShift runs a right shift operation on the PrimitiveU32 value. Consumes and returns a NEX primitive
func (*PrimitiveU32) String ¶
func (u32 *PrimitiveU32) String() string
String returns a string representation of the struct
func (*PrimitiveU32) WriteTo ¶
func (u32 *PrimitiveU32) WriteTo(writable Writable)
WriteTo writes the uint32 to the given writable
func (*PrimitiveU32) XOR ¶
func (u32 *PrimitiveU32) XOR(other *PrimitiveU32) *PrimitiveU32
XOR runs a bitwise XOR operation on the PrimitiveU32 value. Consumes and returns a NEX primitive
type PrimitiveU64 ¶
type PrimitiveU64 struct {
Value uint64
}
PrimitiveU64 is wrapper around a Go primitive uint64 with receiver methods to conform to RVType
func NewPrimitiveU64 ¶
func NewPrimitiveU64(ui64 uint64) *PrimitiveU64
NewPrimitiveU64 returns a new PrimitiveU64
func (*PrimitiveU64) AND ¶
func (u64 *PrimitiveU64) AND(other *PrimitiveU64) *PrimitiveU64
AND runs a bitwise AND operation on the PrimitiveU64 value. Consumes and returns a NEX primitive
func (*PrimitiveU64) ANDNOT ¶
func (u64 *PrimitiveU64) ANDNOT(other *PrimitiveU64) *PrimitiveU64
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveU64 value. Consumes and returns a NEX primitive
func (*PrimitiveU64) Copy ¶
func (u64 *PrimitiveU64) Copy() RVType
Copy returns a pointer to a copy of the uint64. Requires type assertion when used
func (*PrimitiveU64) Equals ¶
func (u64 *PrimitiveU64) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveU64) ExtractFrom ¶
func (u64 *PrimitiveU64) ExtractFrom(readable Readable) error
ExtractFrom extracts the uint64 from the given readable
func (*PrimitiveU64) LShift ¶
func (u64 *PrimitiveU64) LShift(other *PrimitiveU64) *PrimitiveU64
LShift runs a left shift operation on the PrimitiveU64 value. Consumes and returns a NEX primitive
func (*PrimitiveU64) NOT ¶
func (u64 *PrimitiveU64) NOT() *PrimitiveU64
NOT runs a bitwise NOT operation on the PrimitiveU64 value. Returns a NEX primitive
func (*PrimitiveU64) OR ¶
func (u64 *PrimitiveU64) OR(other *PrimitiveU64) *PrimitiveU64
OR runs a bitwise OR operation on the PrimitiveU64 value. Consumes and returns a NEX primitive
func (*PrimitiveU64) PAND ¶
func (u64 *PrimitiveU64) PAND(value uint64) uint64
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveU64 value. Consumes and returns a Go primitive
func (*PrimitiveU64) PANDNOT ¶
func (u64 *PrimitiveU64) PANDNOT(value uint64) uint64
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveU64 value. Consumes and returns a Go primitive
func (*PrimitiveU64) PLShift ¶
func (u64 *PrimitiveU64) PLShift(value uint64) uint64
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveU64 value. Consumes and returns a Go primitive
func (*PrimitiveU64) PNOT ¶
func (u64 *PrimitiveU64) PNOT() uint64
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveU64 value. Returns a Go primitive
func (*PrimitiveU64) POR ¶
func (u64 *PrimitiveU64) POR(value uint64) uint64
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveU64 value. Consumes and returns a Go primitive
func (*PrimitiveU64) PRShift ¶
func (u64 *PrimitiveU64) PRShift(value uint64) uint64
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveU64 value. Consumes and returns a Go primitive
func (*PrimitiveU64) PXOR ¶
func (u64 *PrimitiveU64) PXOR(value uint64) uint64
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveU64 value. Consumes and returns a Go primitive
func (*PrimitiveU64) RShift ¶
func (u64 *PrimitiveU64) RShift(other *PrimitiveU64) *PrimitiveU64
RShift runs a right shift operation on the PrimitiveU64 value. Consumes and returns a NEX primitive
func (*PrimitiveU64) String ¶
func (u64 *PrimitiveU64) String() string
String returns a string representation of the struct
func (*PrimitiveU64) WriteTo ¶
func (u64 *PrimitiveU64) WriteTo(writable Writable)
WriteTo writes the uint64 to the given writable
func (*PrimitiveU64) XOR ¶
func (u64 *PrimitiveU64) XOR(other *PrimitiveU64) *PrimitiveU64
XOR runs a bitwise XOR operation on the PrimitiveU64 value. Consumes and returns a NEX primitive
type PrimitiveU8 ¶
type PrimitiveU8 struct {
Value uint8
}
PrimitiveU8 is wrapper around a Go primitive uint8 with receiver methods to conform to RVType
func NewPrimitiveU8 ¶
func NewPrimitiveU8(ui8 uint8) *PrimitiveU8
NewPrimitiveU8 returns a new PrimitiveU8
func (*PrimitiveU8) AND ¶
func (u8 *PrimitiveU8) AND(other *PrimitiveU8) *PrimitiveU8
AND runs a bitwise AND operation on the PrimitiveU8 value. Consumes and returns a NEX primitive
func (*PrimitiveU8) ANDNOT ¶
func (u8 *PrimitiveU8) ANDNOT(other *PrimitiveU8) *PrimitiveU8
ANDNOT runs a bitwise ANDNOT operation on the PrimitiveU8 value. Consumes and returns a NEX primitive
func (*PrimitiveU8) Copy ¶
func (u8 *PrimitiveU8) Copy() RVType
Copy returns a pointer to a copy of the uint8. Requires type assertion when used
func (*PrimitiveU8) Equals ¶
func (u8 *PrimitiveU8) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*PrimitiveU8) ExtractFrom ¶
func (u8 *PrimitiveU8) ExtractFrom(readable Readable) error
ExtractFrom extracts the uint8 from the given readable
func (*PrimitiveU8) LShift ¶
func (u8 *PrimitiveU8) LShift(other *PrimitiveU8) *PrimitiveU8
LShift runs a left shift operation on the PrimitiveU8 value. Consumes and returns a NEX primitive
func (*PrimitiveU8) NOT ¶
func (u8 *PrimitiveU8) NOT() *PrimitiveU8
NOT runs a bitwise NOT operation on the PrimitiveU8 value. Returns a NEX primitive
func (*PrimitiveU8) OR ¶
func (u8 *PrimitiveU8) OR(other *PrimitiveU8) *PrimitiveU8
OR runs a bitwise OR operation on the PrimitiveU8 value. Consumes and returns a NEX primitive
func (*PrimitiveU8) PAND ¶
func (u8 *PrimitiveU8) PAND(value uint8) uint8
PAND (Primitive AND) runs a bitwise AND operation on the PrimitiveU8 value. Consumes and returns a Go primitive
func (*PrimitiveU8) PANDNOT ¶
func (u8 *PrimitiveU8) PANDNOT(value uint8) uint8
PANDNOT (Primitive AND-NOT) runs a bitwise AND-NOT operation on the PrimitiveU8 value. Consumes and returns a Go primitive
func (*PrimitiveU8) PLShift ¶
func (u8 *PrimitiveU8) PLShift(value uint8) uint8
PLShift (Primitive Left Shift) runs a left shift operation on the PrimitiveU8 value. Consumes and returns a Go primitive
func (*PrimitiveU8) PNOT ¶
func (u8 *PrimitiveU8) PNOT() uint8
PNOT (Primitive NOT) runs a bitwise NOT operation on the PrimitiveU8 value. Returns a Go primitive
func (*PrimitiveU8) POR ¶
func (u8 *PrimitiveU8) POR(value uint8) uint8
POR (Primitive OR) runs a bitwise OR operation on the PrimitiveU8 value. Consumes and returns a Go primitive
func (*PrimitiveU8) PRShift ¶
func (u8 *PrimitiveU8) PRShift(value uint8) uint8
PRShift (Primitive Right Shift) runs a right shift operation on the PrimitiveU8 value. Consumes and returns a Go primitive
func (*PrimitiveU8) PXOR ¶
func (u8 *PrimitiveU8) PXOR(value uint8) uint8
PXOR (Primitive XOR) runs a bitwise XOR operation on the PrimitiveU8 value. Consumes and returns a Go primitive
func (*PrimitiveU8) RShift ¶
func (u8 *PrimitiveU8) RShift(other *PrimitiveU8) *PrimitiveU8
RShift runs a right shift operation on the PrimitiveU8 value. Consumes and returns a NEX primitive
func (*PrimitiveU8) String ¶
func (u8 *PrimitiveU8) String() string
String returns a string representation of the struct
func (*PrimitiveU8) WriteTo ¶
func (u8 *PrimitiveU8) WriteTo(writable Writable)
WriteTo writes the uint8 to the given writable
func (*PrimitiveU8) XOR ¶
func (u8 *PrimitiveU8) XOR(other *PrimitiveU8) *PrimitiveU8
XOR runs a bitwise XOR operation on the PrimitiveU8 value. Consumes and returns a NEX primitive
type QBuffer ¶
type QBuffer struct {
Value []byte
}
QBuffer is an implementation of rdv::qBuffer. Wraps a primitive Go byte slice. Same as Buffer but with a uint16 length field.
func (*QBuffer) Copy ¶
Copy returns a pointer to a copy of the qBuffer. Requires type assertion when used
func (*QBuffer) ExtractFrom ¶
ExtractFrom extracts the QBuffer from the given readable
type QResult ¶
type QResult struct {
Code uint32
}
QResult is an implementation of rdv::qResult. Determines the result of an operation. If the MSB is set the result is an error, otherwise success
func NewQResultError ¶
NewQResultError returns a new QResult set as an error
func NewQResultSuccess ¶
NewQResultSuccess returns a new QResult set as a success
func (*QResult) Copy ¶
Copy returns a pointer to a copy of the QResult. Requires type assertion when used
func (*QResult) ExtractFrom ¶
ExtractFrom extracts the QResult from the given readable
func (*QResult) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
type QUUID ¶
type QUUID struct {
Data []byte
}
QUUID is an implementation of rdv::qUUID. Encodes a UUID in little-endian byte order.
func (*QUUID) Equals ¶
Equals checks if the passed Structure contains the same data as the current instance
func (*QUUID) ExtractFrom ¶
ExtractFrom extracts the QUUID from the given readable
func (*QUUID) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
func (*QUUID) FromString ¶
FromString converts a UUID string to a qUUID
func (*QUUID) GetStringValue ¶
GetStringValue returns the UUID encoded in the qUUID
type RVConnectionData ¶
type RVConnectionData struct { Structure StationURL *StationURL SpecialProtocols *List[*PrimitiveU8] StationURLSpecialProtocols *StationURL Time *DateTime }
RVConnectionData is an implementation of rdv::RVConnectionData. Contains the locations and data of Rendez-Vous connection.
func NewRVConnectionData ¶
func NewRVConnectionData() *RVConnectionData
NewRVConnectionData returns a new RVConnectionData
func (*RVConnectionData) Copy ¶
func (rvcd *RVConnectionData) Copy() RVType
Copy returns a new copied instance of RVConnectionData
func (*RVConnectionData) Equals ¶
func (rvcd *RVConnectionData) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*RVConnectionData) ExtractFrom ¶
func (rvcd *RVConnectionData) ExtractFrom(readable Readable) error
ExtractFrom extracts the RVConnectionData from the given readable
func (*RVConnectionData) FormatToString ¶
func (rvcd *RVConnectionData) FormatToString(indentationLevel int) string
FormatToString pretty-prints the struct data using the provided indentation level
func (*RVConnectionData) String ¶
func (rvcd *RVConnectionData) String() string
String returns a string representation of the struct
func (*RVConnectionData) WriteTo ¶
func (rvcd *RVConnectionData) WriteTo(writable Writable)
WriteTo writes the RVConnectionData to the given writable
type RVType ¶
type RVType interface { WriteTo(writable Writable) ExtractFrom(readable Readable) error Copy() RVType Equals(other RVType) bool }
RVType represents a Quazal Rendez-Vous/NEX type. This includes primitives and custom types.
type Readable ¶
type Readable interface { StringLengthSize() int // Returns the size of the length field for rdv::String types. Only 2 and 4 are valid PIDSize() int // Returns the size of the length fields for nn::nex::PID types. Only 4 and 8 are valid UseStructureHeader() bool // Returns whether or not Structure types should use a header Remaining() uint64 // Returns the number of bytes left unread in the buffer ReadRemaining() []byte // Reads the remaining data from the buffer Read(length uint64) ([]byte, error) // Reads up to length bytes of data from the buffer. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveUInt8() (uint8, error) // Reads a primitive Go uint8. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveUInt16LE() (uint16, error) // Reads a primitive Go uint16. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveUInt32LE() (uint32, error) // Reads a primitive Go uint32. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveUInt64LE() (uint64, error) // Reads a primitive Go uint64. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveInt8() (int8, error) // Reads a primitive Go int8. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveInt16LE() (int16, error) // Reads a primitive Go int16. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveInt32LE() (int32, error) // Reads a primitive Go int32. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveInt64LE() (int64, error) // Reads a primitive Go int64. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveFloat32LE() (float32, error) // Reads a primitive Go float32. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveFloat64LE() (float64, error) // Reads a primitive Go float64. Returns an error if the read failed, such as if there was not enough data to read ReadPrimitiveBool() (bool, error) // Reads a primitive Go bool. Returns an error if the read failed, such as if there was not enough data to read }
Readable represents a struct that types can read from
type ResultRange ¶
type ResultRange struct { Structure Offset *PrimitiveU32 // Offset into the dataset Length *PrimitiveU32 // Number of items to return }
ResultRange is an implementation of rdv::ResultRange. Holds information about how to make queries which may return large data.
func (*ResultRange) Copy ¶
func (rr *ResultRange) Copy() RVType
Copy returns a new copied instance of ResultRange
func (*ResultRange) Equals ¶
func (rr *ResultRange) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*ResultRange) ExtractFrom ¶
func (rr *ResultRange) ExtractFrom(readable Readable) error
ExtractFrom extracts the ResultRange from the given readable
func (*ResultRange) FormatToString ¶
func (rr *ResultRange) FormatToString(indentationLevel int) string
FormatToString pretty-prints the struct data using the provided indentation level
func (*ResultRange) String ¶
func (rr *ResultRange) String() string
String returns a string representation of the struct
func (*ResultRange) WriteTo ¶
func (rr *ResultRange) WriteTo(writable Writable)
WriteTo writes the ResultRange to the given writable
type StationURL ¶
type StationURL struct {
// contains filtered or unexported fields
}
StationURL is an implementation of rdv::StationURL.
Contains location of a station to connect to, with data about how to connect.
func NewStationURL ¶
func NewStationURL(str string) *StationURL
NewStationURL returns a new StationURL
func (*StationURL) Address ¶
func (s *StationURL) Address() (string, bool)
Address gets the stations IP address.
Originally called nn::nex::StationURL::GetAddress
func (*StationURL) ConnectionID ¶
func (s *StationURL) ConnectionID() (uint32, bool)
ConnectionID gets the stations connection ID.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetConnectionID
func (*StationURL) Copy ¶
func (s *StationURL) Copy() RVType
Copy returns a new copied instance of StationURL
func (*StationURL) EncodeToString ¶
func (s *StationURL) EncodeToString() string
EncodeToString encodes the StationURL into a string
func (*StationURL) Equals ¶
func (s *StationURL) Equals(o RVType) bool
Equals checks if the input is equal in value to the current instance
func (*StationURL) ExtractFrom ¶
func (s *StationURL) ExtractFrom(readable Readable) error
ExtractFrom extracts the StationURL from the given readable
func (*StationURL) FormatToString ¶
func (s *StationURL) FormatToString(indentationLevel int) string
FormatToString pretty-prints the struct data using the provided indentation level
func (*StationURL) FromString ¶
func (s *StationURL) FromString(str string)
FromString parses the StationURL data from a string
func (*StationURL) IsBehindNAT ¶
func (s *StationURL) IsBehindNAT() bool
IsBehindNAT checks if the user is behind NAT
func (*StationURL) IsFastProbeResponseEnabled ¶
func (s *StationURL) IsFastProbeResponseEnabled() bool
IsFastProbeResponseEnabled checks if fast probe response is enabled
Originally called nn::nex::StationURL::GetFastProbeResponse
func (*StationURL) IsNATPMPSupported ¶
func (s *StationURL) IsNATPMPSupported() bool
IsNATPMPSupported checks whether PMP is enabled on the station.
Originally called nn::nex::StationURL::GetNatPMPSupport
func (*StationURL) IsProbeRequestInitiationEnabled ¶
func (s *StationURL) IsProbeRequestInitiationEnabled() bool
IsProbeRequestInitiationEnabled checks wheteher probing should be initiated.
Originally called nn::nex::StationURL::GetProbeRequestInitiation
func (*StationURL) IsPublic ¶
func (s *StationURL) IsPublic() bool
IsPublic checks if the station is a public address
func (*StationURL) IsRelayServerEnabled ¶
func (s *StationURL) IsRelayServerEnabled() bool
IsRelayServerEnabled checks whether the connection should use a relay server.
Originally called nn::nex::StationURL::GetUseRelayServer
func (*StationURL) IsUPnPSupported ¶
func (s *StationURL) IsUPnPSupported() bool
IsUPnPSupported checks whether UPnP is enabled on the station.
Originally called nn::nex::StationURL::GetUPnPSupport
func (*StationURL) NATFiltering ¶
func (s *StationURL) NATFiltering() (constants.NATFilteringProperties, bool)
NATFiltering gets the clients NAT filtering properties.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetNATFiltering
func (*StationURL) NATMapping ¶
func (s *StationURL) NATMapping() (constants.NATMappingProperties, bool)
NATMapping gets the clients NAT mapping properties.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetNATMapping
func (*StationURL) NodeID ¶
func (s *StationURL) NodeID() (uint16, bool)
NodeID gets the stations node ID.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetNodeId
func (*StationURL) ParamValue ¶
func (s *StationURL) ParamValue(name string) (string, bool)
ParamValue returns the value of the requested param.
Returns the string value and a bool indicating if the value existed or not.
Originally called nn::nex::StationURL::GetParamValue
func (*StationURL) PlatformType ¶
func (s *StationURL) PlatformType() (uint8, bool)
PlatformType gets the stations target platform. Legal values vary by developer and platforms.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetPlatformType
func (*StationURL) PortNumber ¶
func (s *StationURL) PortNumber() (uint16, bool)
PortNumber gets the stations port.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetPortNumber
func (*StationURL) PrincipalID ¶
func (s *StationURL) PrincipalID() (*PID, bool)
PrincipalID gets the stations target PID.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetPrincipalID
func (*StationURL) ProbeRequestID ¶
func (s *StationURL) ProbeRequestID() (uint32, bool)
ProbeRequestID gets the probe request ID.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetProbeRequestID
func (*StationURL) RVConnectionID ¶
func (s *StationURL) RVConnectionID() (uint32, bool)
RVConnectionID gets the stations Rendez-Vous connection ID.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetRVConnectionID
func (*StationURL) RelayAddress ¶
func (s *StationURL) RelayAddress() (string, bool)
RelayAddress gets the address for the relay
Originally called nn::nex::StationURL::GetRelayAddress
func (*StationURL) RelayPort ¶
func (s *StationURL) RelayPort() (uint16, bool)
RelayPort gets the stations relay port.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetRelayPort
func (*StationURL) RelayServerAddress ¶
func (s *StationURL) RelayServerAddress() (string, bool)
RelayServerAddress gets the address for the relay server
Originally called nn::nex::StationURL::GetRelayServerAddress
func (*StationURL) RelayServerPort ¶
func (s *StationURL) RelayServerPort() (uint16, bool)
RelayServerPort gets the stations relay server port.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetRelayServerPort
func (*StationURL) RemoveParam ¶
func (s *StationURL) RemoveParam(name string)
RemoveParam removes a StationURL parameter.
Originally called nn::nex::StationURL::Remove
func (*StationURL) SetAddress ¶
func (s *StationURL) SetAddress(address string)
SetAddress sets the stations IP address
func (*StationURL) SetConnectionID ¶
func (s *StationURL) SetConnectionID(connectionID uint32)
SetConnectionID sets the stations connection ID
Unsure how this differs from the Rendez-Vous connection ID
func (*StationURL) SetFastProbeResponse ¶
func (s *StationURL) SetFastProbeResponse(fast bool)
SetFastProbeResponse sets whether fast probe response should be enabled or not
func (*StationURL) SetNATFiltering ¶
func (s *StationURL) SetNATFiltering(filtering constants.NATFilteringProperties)
SetNATFiltering sets the clients NAT filtering properties
func (*StationURL) SetNATMapping ¶
func (s *StationURL) SetNATMapping(mapping constants.NATMappingProperties)
SetNATMapping sets the clients NAT mapping properties
func (*StationURL) SetNATPMPSupport ¶
func (s *StationURL) SetNATPMPSupport(supported bool)
SetNATPMPSupport sets whether PMP should be enabled or not.
Originally called nn::nex::StationURL::SetNatPMPSupport
func (*StationURL) SetNodeID ¶
func (s *StationURL) SetNodeID(nodeID uint16)
SetNodeID sets the stations node ID
Originally called nn::nex::StationURL::SetNodeId
func (*StationURL) SetParamValue ¶
func (s *StationURL) SetParamValue(name, value string)
SetParamValue sets a StationURL parameter
func (*StationURL) SetPlatformType ¶
func (s *StationURL) SetPlatformType(platformType uint8)
SetPlatformType sets the stations platform type
func (*StationURL) SetPortNumber ¶
func (s *StationURL) SetPortNumber(port uint16)
SetPortNumber sets the stations port
func (*StationURL) SetPrincipalID ¶
func (s *StationURL) SetPrincipalID(pid *PID)
SetPrincipalID sets the stations target PID
func (*StationURL) SetProbeRequestID ¶
func (s *StationURL) SetProbeRequestID(probeRequestID uint32)
SetProbeRequestID sets the probe request ID
func (*StationURL) SetProbeRequestInitiation ¶
func (s *StationURL) SetProbeRequestInitiation(probeinit bool)
SetProbeRequestInitiation sets whether probing should begin or not
func (*StationURL) SetRVConnectionID ¶
func (s *StationURL) SetRVConnectionID(connectionID uint32)
SetRVConnectionID sets the stations Rendez-Vous connection ID
Unsure how this differs from the connection ID
func (*StationURL) SetRelayAddress ¶
func (s *StationURL) SetRelayAddress(address string)
SetRelayAddress gets the address for the relay
func (*StationURL) SetRelayPort ¶
func (s *StationURL) SetRelayPort(port uint16)
SetRelayPort sets the port for the relay
func (*StationURL) SetRelayServerAddress ¶
func (s *StationURL) SetRelayServerAddress(address string)
SetRelayServerAddress sets the address for the relay server
func (*StationURL) SetRelayServerPort ¶
func (s *StationURL) SetRelayServerPort(port uint16)
SetRelayServerPort sets the port for the relay server
func (*StationURL) SetStreamID ¶
func (s *StationURL) SetStreamID(streamID uint8)
SetStreamID sets the stations stream ID
See VirtualPort
func (*StationURL) SetStreamType ¶
func (s *StationURL) SetStreamType(streamType constants.StreamType)
SetStreamType sets the stations stream type
See VirtualPort
func (*StationURL) SetType ¶
func (s *StationURL) SetType(flags uint8)
SetType sets the stations type flags
func (*StationURL) SetUPnPSupport ¶
func (s *StationURL) SetUPnPSupport(supported bool)
SetUPnPSupport sets whether UPnP should be enabled or not
func (*StationURL) SetURLType ¶
func (s *StationURL) SetURLType(urlType constants.StationURLType)
SetURLType sets the stations URL scheme type
func (*StationURL) SetUseRelayServer ¶
func (s *StationURL) SetUseRelayServer(useRelayServer bool)
SetUseRelayServer sets whether or not a relay server should be used
func (*StationURL) StreamID ¶
func (s *StationURL) StreamID() (uint8, bool)
StreamID gets the stations stream ID.
See VirtualPort.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetStreamID
func (*StationURL) StreamType ¶
func (s *StationURL) StreamType() (constants.StreamType, bool)
StreamType gets the stations stream type.
See VirtualPort.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetStreamType
func (*StationURL) String ¶
func (s *StationURL) String() string
String returns a string representation of the struct
func (*StationURL) Type ¶
func (s *StationURL) Type() (uint8, bool)
Type gets the stations type flags.
Returns a bool indicating if the parameter existed or not.
Originally called nn::nex::StationURL::GetType
func (*StationURL) URLType ¶
func (s *StationURL) URLType() constants.StationURLType
URLType returns the stations scheme type
Originally called nn::nex::StationURL::GetURLType
func (*StationURL) WriteTo ¶
func (s *StationURL) WriteTo(writable Writable)
WriteTo writes the StationURL to the given writable
type String ¶
type String struct {
Value string
}
String is an implementation of rdv::String. Wraps a primitive Go string.
func (*String) Copy ¶
Copy returns a pointer to a copy of the String. Requires type assertion when used
func (*String) ExtractFrom ¶
ExtractFrom extracts the String from the given readable
type Structure ¶
type Structure struct {
StructureVersion uint8
}
Structure represents a Quazal Rendez-Vous/NEX Structure (custom class) base struct.
func (*Structure) ExtractHeaderFrom ¶
ExtractHeaderFrom extracts the structure header from the given readable
func (*Structure) WriteHeaderTo ¶
WriteHeaderTo writes the structure header to the given writable
type Variant ¶
type Variant struct { TypeID *PrimitiveU8 Type RVType }
Variant is an implementation of rdv::Variant. This type can hold many other types, denoted by a type ID.
func (*Variant) Copy ¶
Copy returns a pointer to a copy of the Variant. Requires type assertion when used
func (*Variant) ExtractFrom ¶
ExtractFrom extracts the Variant from the given readable
func (*Variant) FormatToString ¶
FormatToString pretty-prints the struct data using the provided indentation level
type Writable ¶
type Writable interface { StringLengthSize() int // Returns the size of the length field for rdv::String types. Only 2 and 4 are valid PIDSize() int // Returns the size of the length fields for nn::nex::PID types. Only 4 and 8 are valid UseStructureHeader() bool // Returns whether or not Structure types should use a header CopyNew() Writable // Returns a new Writable with the same settings, but an empty buffer Write(data []byte) // Writes the provided data to the buffer WritePrimitiveUInt8(value uint8) // Writes a primitive Go uint8 WritePrimitiveUInt16LE(value uint16) // Writes a primitive Go uint16 WritePrimitiveUInt32LE(value uint32) // Writes a primitive Go uint32 WritePrimitiveUInt64LE(value uint64) // Writes a primitive Go uint64 WritePrimitiveInt8(value int8) // Writes a primitive Go int8 WritePrimitiveInt16LE(value int16) // Writes a primitive Go int16 WritePrimitiveInt32LE(value int32) // Writes a primitive Go int32 WritePrimitiveInt64LE(value int64) // Writes a primitive Go int64 WritePrimitiveFloat32LE(value float32) // Writes a primitive Go float32 WritePrimitiveFloat64LE(value float64) // Writes a primitive Go float64 WritePrimitiveBool(value bool) // Writes a primitive Go bool Bytes() []byte // Returns the data written t othe buffer }
Writable represents a struct that types can write to
Source Files ¶
- any_data_holder.go
- buffer.go
- class_version_container.go
- data.go
- datetime.go
- list.go
- map.go
- pid.go
- primitive_bool.go
- primitive_float32.go
- primitive_float64.go
- primitive_s16.go
- primitive_s32.go
- primitive_s64.go
- primitive_s8.go
- primitive_u16.go
- primitive_u32.go
- primitive_u64.go
- primitive_u8.go
- qbuffer.go
- qresult.go
- quuid.go
- readable.go
- result_range.go
- rv_connection_data.go
- rv_type.go
- station_url.go
- string.go
- structure.go
- variant.go
- writable.go