falloutBot/go-mc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix typo

Browse Source
This commit is contained in:
Tnze
2022-12-10 10:14:11 +08:00
parent 47f4fad152
commit fceaa33dc4
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
net/packet/util.go
View File

@ -86,7 +86,7 @@ func Array(ary any) Field {
return Ary[VarInt]{Ary: ary}
}
// Opt is a optional [Field] which sending/receiving or not is depending on its Has field.
// Opt is an optional [Field] which sending/receiving or not is depending on its Has field.
// When calling `WriteTo()` or `ReadFrom()`, if Has is true, the Field's `WriteTo` or `ReadFrom()` is called.
// Otherwise, it does nothing and return 0 and nil.
//
@ -152,13 +152,13 @@ type fieldPointer[T any] interface {
// Option is a helper type for encoding/decoding these kind of packet:
//
// +-----------+------------+----------------------------------------- +
// | Name | Type | Notes |
// +-----------+------------+------------------------------------------+
// | Has Value | Boolean | Whether or not the Value should be sent. |
// +-----------+------------+------------------------------------------+
// | Value | Optional T | Only exist when Has Value is true. |
// +-----------+------------+------------------------------------------+
// +-----------+------------+----------------------------------- +
// | Name | Type | Notes |
// +-----------+------------+------------------------------------+
// | Has Value | Boolean | Whether the Value should be sent. |
// +-----------+------------+------------------------------------+
// | Value | Optional T | Only exist when Has Value is true. |
// +-----------+------------+------------------------------------+
//
// # Usage
//
@ -205,7 +205,7 @@ func (o *Option[T, P]) ReadFrom(r io.Reader) (n int64, err error) {
return n1 + n2, err
}
// OptionDecoder is basiclly same with [Option], but support [FieldDecoder] only.
// OptionDecoder is basically same with [Option], but support [FieldDecoder] only.
// This allowed wrapping a [FieldDecoder] type (which isn't a [FieldEncoder]) to an Option.
type OptionDecoder[T any, P fieldPointer[T]] struct {
Has Boolean
@ -221,7 +221,7 @@ func (o *OptionDecoder[T, P]) ReadFrom(r io.Reader) (n int64, err error) {
return n1 + n2, err
}
// OptionEncoder is basiclly same with [Option], but support [FieldEncoder] only.
// OptionEncoder is basically same with [Option], but support [FieldEncoder] only.
// This allowed wrapping a [FieldEncoder] type (which isn't a [FieldDecoder]) to an Option.
type OptionEncoder[T FieldEncoder] struct {
Has Boolean