types

package
v2.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2024 License: AGPL-3.0 Imports: 3 Imported by: 0

Documentation

Overview

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Package types implements all the types used by the Friends3DS protocol

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FriendComment

type FriendComment struct {
	types.Structure
	*types.Data
	PID        *types.PID
	Comment    *types.String
	ModifiedAt *types.DateTime
}

FriendComment is a type within the Friends3DS protocol

func NewFriendComment

func NewFriendComment() *FriendComment

NewFriendComment returns a new FriendComment

func (*FriendComment) Copy

func (fc *FriendComment) Copy() types.RVType

Copy returns a new copied instance of FriendComment

func (*FriendComment) Equals

func (fc *FriendComment) Equals(o types.RVType) bool

Equals checks if the given FriendComment contains the same data as the current FriendComment

func (*FriendComment) ExtractFrom

func (fc *FriendComment) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendComment from the given readable

func (*FriendComment) FormatToString

func (fc *FriendComment) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendComment using the provided indentation level

func (*FriendComment) String

func (fc *FriendComment) String() string

String returns the string representation of the FriendComment

func (*FriendComment) WriteTo

func (fc *FriendComment) WriteTo(writable types.Writable)

WriteTo writes the FriendComment to the given writable

type FriendInfo

type FriendInfo struct {
	types.Structure
	PID     *types.PID
	Unknown *types.DateTime
}

FriendInfo is a type within the Friends3DS protocol

func NewFriendInfo

func NewFriendInfo() *FriendInfo

NewFriendInfo returns a new FriendInfo

func (*FriendInfo) Copy

func (fi *FriendInfo) Copy() types.RVType

Copy returns a new copied instance of FriendInfo

func (*FriendInfo) Equals

func (fi *FriendInfo) Equals(o types.RVType) bool

Equals checks if the given FriendInfo contains the same data as the current FriendInfo

func (*FriendInfo) ExtractFrom

func (fi *FriendInfo) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendInfo from the given readable

func (*FriendInfo) FormatToString

func (fi *FriendInfo) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendInfo using the provided indentation level

func (*FriendInfo) String

func (fi *FriendInfo) String() string

String returns the string representation of the FriendInfo

func (*FriendInfo) WriteTo

func (fi *FriendInfo) WriteTo(writable types.Writable)

WriteTo writes the FriendInfo to the given writable

type FriendMii

type FriendMii struct {
	types.Structure
	*types.Data
	PID        *types.PID
	Mii        *Mii
	ModifiedAt *types.DateTime
}

FriendMii is a type within the Friends3DS protocol

func NewFriendMii

func NewFriendMii() *FriendMii

NewFriendMii returns a new FriendMii

func (*FriendMii) Copy

func (fm *FriendMii) Copy() types.RVType

Copy returns a new copied instance of FriendMii

func (*FriendMii) Equals

func (fm *FriendMii) Equals(o types.RVType) bool

Equals checks if the given FriendMii contains the same data as the current FriendMii

func (*FriendMii) ExtractFrom

func (fm *FriendMii) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendMii from the given readable

func (*FriendMii) FormatToString

func (fm *FriendMii) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendMii using the provided indentation level

func (*FriendMii) String

func (fm *FriendMii) String() string

String returns the string representation of the FriendMii

func (*FriendMii) WriteTo

func (fm *FriendMii) WriteTo(writable types.Writable)

WriteTo writes the FriendMii to the given writable

type FriendMiiList

type FriendMiiList struct {
	types.Structure
	*types.Data
	Unknown1 *types.PrimitiveU32
	MiiList  *MiiList
	Unknown2 *types.DateTime
}

FriendMiiList is a type within the Friends3DS protocol

func NewFriendMiiList

func NewFriendMiiList() *FriendMiiList

NewFriendMiiList returns a new FriendMiiList

func (*FriendMiiList) Copy

func (fml *FriendMiiList) Copy() types.RVType

Copy returns a new copied instance of FriendMiiList

func (*FriendMiiList) Equals

func (fml *FriendMiiList) Equals(o types.RVType) bool

Equals checks if the given FriendMiiList contains the same data as the current FriendMiiList

func (*FriendMiiList) ExtractFrom

func (fml *FriendMiiList) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendMiiList from the given readable

func (*FriendMiiList) FormatToString

func (fml *FriendMiiList) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendMiiList using the provided indentation level

func (*FriendMiiList) String

func (fml *FriendMiiList) String() string

String returns the string representation of the FriendMiiList

func (*FriendMiiList) WriteTo

func (fml *FriendMiiList) WriteTo(writable types.Writable)

WriteTo writes the FriendMiiList to the given writable

type FriendPersistentInfo

type FriendPersistentInfo struct {
	types.Structure
	*types.Data
	PID              *types.PID
	Region           *types.PrimitiveU8
	Country          *types.PrimitiveU8
	Area             *types.PrimitiveU8
	Language         *types.PrimitiveU8
	Platform         *types.PrimitiveU8
	GameKey          *GameKey
	Message          *types.String
	MessageUpdatedAt *types.DateTime
	MiiModifiedAt    *types.DateTime
	LastOnline       *types.DateTime
}

FriendPersistentInfo is a type within the Friends3DS protocol

func NewFriendPersistentInfo

func NewFriendPersistentInfo() *FriendPersistentInfo

NewFriendPersistentInfo returns a new FriendPersistentInfo

func (*FriendPersistentInfo) Copy

func (fpi *FriendPersistentInfo) Copy() types.RVType

Copy returns a new copied instance of FriendPersistentInfo

func (*FriendPersistentInfo) Equals

func (fpi *FriendPersistentInfo) Equals(o types.RVType) bool

Equals checks if the given FriendPersistentInfo contains the same data as the current FriendPersistentInfo

func (*FriendPersistentInfo) ExtractFrom

func (fpi *FriendPersistentInfo) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendPersistentInfo from the given readable

func (*FriendPersistentInfo) FormatToString

func (fpi *FriendPersistentInfo) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendPersistentInfo using the provided indentation level

func (*FriendPersistentInfo) String

func (fpi *FriendPersistentInfo) String() string

String returns the string representation of the FriendPersistentInfo

func (*FriendPersistentInfo) WriteTo

func (fpi *FriendPersistentInfo) WriteTo(writable types.Writable)

WriteTo writes the FriendPersistentInfo to the given writable

type FriendPicture

type FriendPicture struct {
	types.Structure
	*types.Data
	Unknown1    *types.PrimitiveU32
	PictureData *types.Buffer
	Unknown2    *types.DateTime
}

FriendPicture is a type within the Friends3DS protocol

func NewFriendPicture

func NewFriendPicture() *FriendPicture

NewFriendPicture returns a new FriendPicture

func (*FriendPicture) Copy

func (fp *FriendPicture) Copy() types.RVType

Copy returns a new copied instance of FriendPicture

func (*FriendPicture) Equals

func (fp *FriendPicture) Equals(o types.RVType) bool

Equals checks if the given FriendPicture contains the same data as the current FriendPicture

func (*FriendPicture) ExtractFrom

func (fp *FriendPicture) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendPicture from the given readable

func (*FriendPicture) FormatToString

func (fp *FriendPicture) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendPicture using the provided indentation level

func (*FriendPicture) String

func (fp *FriendPicture) String() string

String returns the string representation of the FriendPicture

func (*FriendPicture) WriteTo

func (fp *FriendPicture) WriteTo(writable types.Writable)

WriteTo writes the FriendPicture to the given writable

type FriendPresence

type FriendPresence struct {
	types.Structure
	*types.Data
	PID      *types.PID
	Presence *NintendoPresence
}

FriendPresence is a type within the Friends3DS protocol

func NewFriendPresence

func NewFriendPresence() *FriendPresence

NewFriendPresence returns a new FriendPresence

func (*FriendPresence) Copy

func (fp *FriendPresence) Copy() types.RVType

Copy returns a new copied instance of FriendPresence

func (*FriendPresence) Equals

func (fp *FriendPresence) Equals(o types.RVType) bool

Equals checks if the given FriendPresence contains the same data as the current FriendPresence

func (*FriendPresence) ExtractFrom

func (fp *FriendPresence) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendPresence from the given readable

func (*FriendPresence) FormatToString

func (fp *FriendPresence) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendPresence using the provided indentation level

func (*FriendPresence) String

func (fp *FriendPresence) String() string

String returns the string representation of the FriendPresence

func (*FriendPresence) WriteTo

func (fp *FriendPresence) WriteTo(writable types.Writable)

WriteTo writes the FriendPresence to the given writable

type FriendRelationship

type FriendRelationship struct {
	types.Structure
	*types.Data
	PID              *types.PID
	LFC              *types.PrimitiveU64
	RelationshipType *types.PrimitiveU8
}

FriendRelationship is a type within the Friends3DS protocol

func NewFriendRelationship

func NewFriendRelationship() *FriendRelationship

NewFriendRelationship returns a new FriendRelationship

func (*FriendRelationship) Copy

func (fr *FriendRelationship) Copy() types.RVType

Copy returns a new copied instance of FriendRelationship

func (*FriendRelationship) Equals

func (fr *FriendRelationship) Equals(o types.RVType) bool

Equals checks if the given FriendRelationship contains the same data as the current FriendRelationship

func (*FriendRelationship) ExtractFrom

func (fr *FriendRelationship) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the FriendRelationship from the given readable

func (*FriendRelationship) FormatToString

func (fr *FriendRelationship) FormatToString(indentationLevel int) string

FormatToString pretty-prints the FriendRelationship using the provided indentation level

func (*FriendRelationship) String

func (fr *FriendRelationship) String() string

String returns the string representation of the FriendRelationship

func (*FriendRelationship) WriteTo

func (fr *FriendRelationship) WriteTo(writable types.Writable)

WriteTo writes the FriendRelationship to the given writable

type GameKey

type GameKey struct {
	types.Structure
	*types.Data
	TitleID      *types.PrimitiveU64
	TitleVersion *types.PrimitiveU16
}

GameKey is a type within the Friends3DS protocol

func NewGameKey

func NewGameKey() *GameKey

NewGameKey returns a new GameKey

func (*GameKey) Copy

func (gk *GameKey) Copy() types.RVType

Copy returns a new copied instance of GameKey

func (*GameKey) Equals

func (gk *GameKey) Equals(o types.RVType) bool

Equals checks if the given GameKey contains the same data as the current GameKey

func (*GameKey) ExtractFrom

func (gk *GameKey) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the GameKey from the given readable

func (*GameKey) FormatToString

func (gk *GameKey) FormatToString(indentationLevel int) string

FormatToString pretty-prints the GameKey using the provided indentation level

func (*GameKey) String

func (gk *GameKey) String() string

String returns the string representation of the GameKey

func (*GameKey) WriteTo

func (gk *GameKey) WriteTo(writable types.Writable)

WriteTo writes the GameKey to the given writable

type Mii

type Mii struct {
	types.Structure
	*types.Data
	Name          *types.String
	ProfanityFlag *types.PrimitiveBool
	CharacterSet  *types.PrimitiveU8
	MiiData       *types.Buffer
}

Mii is a type within the Friends3DS protocol

func NewMii

func NewMii() *Mii

NewMii returns a new Mii

func (*Mii) Copy

func (m *Mii) Copy() types.RVType

Copy returns a new copied instance of Mii

func (*Mii) Equals

func (m *Mii) Equals(o types.RVType) bool

Equals checks if the given Mii contains the same data as the current Mii

func (*Mii) ExtractFrom

func (m *Mii) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the Mii from the given readable

func (*Mii) FormatToString

func (m *Mii) FormatToString(indentationLevel int) string

FormatToString pretty-prints the Mii using the provided indentation level

func (*Mii) String

func (m *Mii) String() string

String returns the string representation of the Mii

func (*Mii) WriteTo

func (m *Mii) WriteTo(writable types.Writable)

WriteTo writes the Mii to the given writable

type MiiList

type MiiList struct {
	types.Structure
	*types.Data
	Unknown1    *types.String
	Unknown2    *types.PrimitiveBool
	Unknown3    *types.PrimitiveU8
	MiiDataList *types.List[*types.Buffer]
}

MiiList is a type within the Friends3DS protocol

func NewMiiList

func NewMiiList() *MiiList

NewMiiList returns a new MiiList

func (*MiiList) Copy

func (ml *MiiList) Copy() types.RVType

Copy returns a new copied instance of MiiList

func (*MiiList) Equals

func (ml *MiiList) Equals(o types.RVType) bool

Equals checks if the given MiiList contains the same data as the current MiiList

func (*MiiList) ExtractFrom

func (ml *MiiList) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the MiiList from the given readable

func (*MiiList) FormatToString

func (ml *MiiList) FormatToString(indentationLevel int) string

FormatToString pretty-prints the MiiList using the provided indentation level

func (*MiiList) String

func (ml *MiiList) String() string

String returns the string representation of the MiiList

func (*MiiList) WriteTo

func (ml *MiiList) WriteTo(writable types.Writable)

WriteTo writes the MiiList to the given writable

type MyProfile

type MyProfile struct {
	types.Structure
	*types.Data
	Region   *types.PrimitiveU8
	Country  *types.PrimitiveU8
	Area     *types.PrimitiveU8
	Language *types.PrimitiveU8
	Platform *types.PrimitiveU8
	Unknown1 *types.PrimitiveU64
	Unknown2 *types.String
	Unknown3 *types.String
}

MyProfile is a type within the Friends3DS protocol

func NewMyProfile

func NewMyProfile() *MyProfile

NewMyProfile returns a new MyProfile

func (*MyProfile) Copy

func (mp *MyProfile) Copy() types.RVType

Copy returns a new copied instance of MyProfile

func (*MyProfile) Equals

func (mp *MyProfile) Equals(o types.RVType) bool

Equals checks if the given MyProfile contains the same data as the current MyProfile

func (*MyProfile) ExtractFrom

func (mp *MyProfile) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the MyProfile from the given readable

func (*MyProfile) FormatToString

func (mp *MyProfile) FormatToString(indentationLevel int) string

FormatToString pretty-prints the MyProfile using the provided indentation level

func (*MyProfile) String

func (mp *MyProfile) String() string

String returns the string representation of the MyProfile

func (*MyProfile) WriteTo

func (mp *MyProfile) WriteTo(writable types.Writable)

WriteTo writes the MyProfile to the given writable

type NintendoPresence

type NintendoPresence struct {
	types.Structure
	*types.Data
	ChangedFlags      *types.PrimitiveU32
	GameKey           *GameKey
	Message           *types.String
	JoinAvailableFlag *types.PrimitiveU32
	MatchmakeType     *types.PrimitiveU8
	JoinGameID        *types.PrimitiveU32
	JoinGameMode      *types.PrimitiveU32
	OwnerPID          *types.PID
	JoinGroupID       *types.PrimitiveU32
	ApplicationArg    *types.Buffer
}

NintendoPresence is a type within the Friends3DS protocol

func NewNintendoPresence

func NewNintendoPresence() *NintendoPresence

NewNintendoPresence returns a new NintendoPresence

func (*NintendoPresence) Copy

func (np *NintendoPresence) Copy() types.RVType

Copy returns a new copied instance of NintendoPresence

func (*NintendoPresence) Equals

func (np *NintendoPresence) Equals(o types.RVType) bool

Equals checks if the given NintendoPresence contains the same data as the current NintendoPresence

func (*NintendoPresence) ExtractFrom

func (np *NintendoPresence) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the NintendoPresence from the given readable

func (*NintendoPresence) FormatToString

func (np *NintendoPresence) FormatToString(indentationLevel int) string

FormatToString pretty-prints the NintendoPresence using the provided indentation level

func (*NintendoPresence) String

func (np *NintendoPresence) String() string

String returns the string representation of the NintendoPresence

func (*NintendoPresence) WriteTo

func (np *NintendoPresence) WriteTo(writable types.Writable)

WriteTo writes the NintendoPresence to the given writable

type PlayedGame

type PlayedGame struct {
	types.Structure
	GameKey *GameKey
	Unknown *types.DateTime
}

PlayedGame is a type within the Friends3DS protocol

func NewPlayedGame

func NewPlayedGame() *PlayedGame

NewPlayedGame returns a new PlayedGame

func (*PlayedGame) Copy

func (pg *PlayedGame) Copy() types.RVType

Copy returns a new copied instance of PlayedGame

func (*PlayedGame) Equals

func (pg *PlayedGame) Equals(o types.RVType) bool

Equals checks if the given PlayedGame contains the same data as the current PlayedGame

func (*PlayedGame) ExtractFrom

func (pg *PlayedGame) ExtractFrom(readable types.Readable) error

ExtractFrom extracts the PlayedGame from the given readable

func (*PlayedGame) FormatToString

func (pg *PlayedGame) FormatToString(indentationLevel int) string

FormatToString pretty-prints the PlayedGame using the provided indentation level

func (*PlayedGame) String

func (pg *PlayedGame) String() string

String returns the string representation of the PlayedGame

func (*PlayedGame) WriteTo

func (pg *PlayedGame) WriteTo(writable types.Writable)

WriteTo writes the PlayedGame to the given writable

Jump to

Keyboard shortcuts

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