github.com/cloudwego/dynamicgo@v0.2.6-0.20240519101509-707f41b6b834/proto/generic/README.md

<!-- Code generated by gomarkdoc. DO NOT EDIT -->

# generic

```go
import "github.com/cloudwego/dynamicgo/proto/generic"
```

## Index

- [generic](#generic)
  - [Index](#index)
  - [Variables](#variables)
  - [func FreeBytesToPool](#func-freebytestopool)
  - [func FreePathNode](#func-freepathnode)
  - [func NewBytesFromPool](#func-newbytesfrompool)
  - [type Node](#type-node)
    - [func NewComplexNode](#func-newcomplexnode)
    - [func NewNode](#func-newnode)
    - [func NewNodeBool](#func-newnodebool)
    - [func NewNodeByte](#func-newnodebyte)
    - [func NewNodeBytes](#func-newnodebytes)
    - [func NewNodeDouble](#func-newnodedouble)
    - [func NewNodeEnum](#func-newnodeenum)
    - [func NewNodeFixed32](#func-newnodefixed32)
    - [func NewNodeFixed64](#func-newnodefixed64)
    - [func NewNodeFloat](#func-newnodefloat)
    - [func NewNodeInt32](#func-newnodeint32)
    - [func NewNodeInt64](#func-newnodeint64)
    - [func NewNodeSfixed32](#func-newnodesfixed32)
    - [func NewNodeSfixed64](#func-newnodesfixed64)
    - [func NewNodeSint32](#func-newnodesint32)
    - [func NewNodeSint64](#func-newnodesint64)
    - [func NewNodeString](#func-newnodestring)
    - [func NewNodeUint32](#func-newnodeuint32)
    - [func NewNodeUint64](#func-newnodeuint64)
    - [func (Node) Binary](#func-node-binary)
    - [func (Node) Bool](#func-node-bool)
    - [func (\*Node) Check](#func-node-check)
    - [func (Node) Children](#func-node-children)
    - [func (Node) ElemType](#func-node-elemtype)
    - [func (Node) ErrCode](#func-node-errcode)
    - [func (Node) Error](#func-node-error)
    - [func (Node) Field](#func-node-field)
    - [func (Node) Fields](#func-node-fields)
    - [func (Node) Float64](#func-node-float64)
    - [func (Node) Fork](#func-node-fork)
    - [func (Node) GetByInt](#func-node-getbyint)
    - [func (Node) GetByStr](#func-node-getbystr)
    - [func (Node) Gets](#func-node-gets)
    - [func (Node) Index](#func-node-index)
    - [func (Node) Indexes](#func-node-indexes)
    - [func (Node) Int](#func-node-int)
    - [func (Node) IsErrNotFound](#func-node-iserrnotfound)
    - [func (Node) IsError](#func-node-iserror)
    - [func (Node) IsUnKnown](#func-node-isunknown)
    - [func (Node) KeyType](#func-node-keytype)
    - [func (Node) Len](#func-node-len)
    - [func (Node) Raw](#func-node-raw)
    - [func (\*Node) SetElemType](#func-node-setelemtype)
    - [func (\*Node) SetKeyType](#func-node-setkeytype)
    - [func (Node) String](#func-node-string)
    - [func (Node) Type](#func-node-type)
    - [func (Node) Uint](#func-node-uint)
  - [type Options](#type-options)
  - [type Path](#type-path)
    - [func NewPathFieldId](#func-newpathfieldid)
    - [func NewPathFieldName](#func-newpathfieldname)
    - [func NewPathIndex](#func-newpathindex)
    - [func NewPathIntKey](#func-newpathintkey)
    - [func NewPathStrKey](#func-newpathstrkey)
    - [func (Path) Id](#func-path-id)
    - [func (Path) Int](#func-path-int)
    - [func (Path) Str](#func-path-str)
    - [func (Path) ToRaw](#func-path-toraw)
    - [func (Path) Type](#func-path-type)
    - [func (Path) Value](#func-path-value)
  - [type PathNode](#type-pathnode)
    - [func NewPathNode](#func-newpathnode)
    - [func (PathNode) CopyTo](#func-pathnode-copyto)
    - [func (\*PathNode) Load](#func-pathnode-load)
    - [func (PathNode) Marshal](#func-pathnode-marshal)
    - [func (\*PathNode) ResetAll](#func-pathnode-resetall)
    - [func (\*PathNode) ResetValue](#func-pathnode-resetvalue)
  - [type PathType](#type-pathtype)
  - [type Value](#type-value)
    - [func NewComplexValue](#func-newcomplexvalue)
    - [func NewRootValue](#func-newrootvalue)
    - [func NewValue](#func-newvalue)
    - [func (Value) Field](#func-value-field)
    - [func (Value) FieldByName](#func-value-fieldbyname)
    - [func (Value) Fields](#func-value-fields)
    - [func (Value) Fork](#func-value-fork)
    - [func (Value) GetByInt](#func-value-getbyint)
    - [func (Value) GetByPath](#func-value-getbypath)
    - [func (Value) GetByPathWithAddress](#func-value-getbypathwithaddress)
    - [func (Value) GetByStr](#func-value-getbystr)
    - [func (Value) GetMany](#func-value-getmany)
    - [func (Value) Index](#func-value-index)
    - [func (Value) IntMap](#func-value-intmap)
    - [func (Value) Interface](#func-value-interface)
    - [func (Value) List](#func-value-list)
    - [func (Value) MarshalTo](#func-value-marshalto)
    - [func (\*Value) SetByPath](#func-value-setbypath)
    - [func (\*Value) SetMany](#func-value-setmany)
    - [func (Value) StrMap](#func-value-strmap)
    - [func (\*Value) UnsetByPath](#func-value-unsetbypath)


## Variables

<a name="UseNativeSkipForGet"></a>

```go
var (
    // UseNativeSkipForGet indicates to use native.Skip (instead of go.Skip) method to skip proto value
    // This only works for single-value searching API like GetByInt()/GetByRaw()/GetByStr()/Field()/Index()/GetByPath() methods.
    UseNativeSkipForGet = false

    // DefaultNodeSliceCap is the default capacity of a Node or NodePath slice
    // Usually, a Node or NodePath slice is used to store intermediate or consequential elements of a generic API like Children()|Interface()|SetMany()
    DefaultNodeSliceCap = 16
    DefaultTagSliceCap  = 8
)
```

<a name="StoreChildrenByIdShreshold"></a>

```go
var (
    // StoreChildrenByIdShreshold is the maximum id to store children node by id.
    StoreChildrenByIdShreshold = 256

    // StoreChildrenByIdShreshold is the minimum id to store children node by hash.
    StoreChildrenByIntHashShreshold = DefaultNodeSliceCap
)
```

<a name="FreeBytesToPool"></a>
## func [FreeBytesToPool](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L42>)

```go
func FreeBytesToPool(b []byte)
```



<a name="FreePathNode"></a>
## func [FreePathNode](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L252>)

```go
func FreePathNode(p *PathNode)
```

FreePathNode put a PathNode back to memory pool

<a name="NewBytesFromPool"></a>
## func [NewBytesFromPool](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L38>)

```go
func NewBytesFromPool() []byte
```



<a name="Node"></a>
## type [Node](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L14-L21>)



```go
type Node struct {
    // contains filtered or unexported fields
}
```

<a name="NewComplexNode"></a>
### func [NewComplexNode](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L317>)

```go
func NewComplexNode(t proto.Type, et proto.Type, kt proto.Type, src []byte) (ret Node)
```

NewComplexNode can deal with all the types, only if the src is a valid byte slice

<a name="NewNode"></a>
### func [NewNode](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L205>)

```go
func NewNode(t proto.Type, src []byte) Node
```

NewNode method: creates a new node from a byte slice

<a name="NewNodeBool"></a>
### func [NewNodeBool](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L214>)

```go
func NewNodeBool(val bool) Node
```



<a name="NewNodeByte"></a>
### func [NewNodeByte](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L220>)

```go
func NewNodeByte(val byte) Node
```



<a name="NewNodeBytes"></a>
### func [NewNodeBytes](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L310>)

```go
func NewNodeBytes(val []byte) Node
```



<a name="NewNodeDouble"></a>
### func [NewNodeDouble](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L298>)

```go
func NewNodeDouble(val float64) Node
```



<a name="NewNodeEnum"></a>
### func [NewNodeEnum](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L226>)

```go
func NewNodeEnum(val int32) Node
```



<a name="NewNodeFixed32"></a>
### func [NewNodeFixed32](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L250>)

```go
func NewNodeFixed32(val uint32) Node
```



<a name="NewNodeFixed64"></a>
### func [NewNodeFixed64](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L280>)

```go
func NewNodeFixed64(val uint64) Node
```



<a name="NewNodeFloat"></a>
### func [NewNodeFloat](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L292>)

```go
func NewNodeFloat(val float32) Node
```



<a name="NewNodeInt32"></a>
### func [NewNodeInt32](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L232>)

```go
func NewNodeInt32(val int32) Node
```



<a name="NewNodeInt64"></a>
### func [NewNodeInt64](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L262>)

```go
func NewNodeInt64(val int64) Node
```



<a name="NewNodeSfixed32"></a>
### func [NewNodeSfixed32](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L256>)

```go
func NewNodeSfixed32(val int32) Node
```



<a name="NewNodeSfixed64"></a>
### func [NewNodeSfixed64](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L286>)

```go
func NewNodeSfixed64(val int64) Node
```



<a name="NewNodeSint32"></a>
### func [NewNodeSint32](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L238>)

```go
func NewNodeSint32(val int32) Node
```



<a name="NewNodeSint64"></a>
### func [NewNodeSint64](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L268>)

```go
func NewNodeSint64(val int64) Node
```



<a name="NewNodeString"></a>
### func [NewNodeString](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L304>)

```go
func NewNodeString(val string) Node
```



<a name="NewNodeUint32"></a>
### func [NewNodeUint32](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L244>)

```go
func NewNodeUint32(val uint32) Node
```



<a name="NewNodeUint64"></a>
### func [NewNodeUint64](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L274>)

```go
func NewNodeUint64(val uint64) Node
```



<a name="Node.Binary"></a>
### func (Node) [Binary](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L168>)

```go
func (self Node) Binary() ([]byte, error)
```

Binary returns the bytes value contained by a BYTE node

<a name="Node.Bool"></a>
### func (Node) [Bool](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L52>)

```go
func (self Node) Bool() (bool, error)
```

Bool returns the bool value contained by a BOOL node

<a name="Node.Check"></a>
### func (*Node) [Check](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/error.go#L136>)

```go
func (self *Node) Check() error
```

Check checks if it is a ERROR node and returns corresponding error

<a name="Node.Children"></a>
### func (Node) [Children](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L348>)

```go
func (self Node) Children(out *[]PathNode, recurse bool, opts *Options, desc *proto.TypeDescriptor) (err error)
```

returns all the children of a node, when recurse is false, it switch to lazyload mode, only direct children are returned

<a name="Node.ElemType"></a>
### func (Node) [ElemType](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L38>)

```go
func (self Node) ElemType() proto.Type
```

ElemType returns the thrift type of a LIST/MAP node's element

<a name="Node.ErrCode"></a>
### func (Node) [ErrCode](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/error.go#L128>)

```go
func (self Node) ErrCode() meta.ErrCode
```

ErrCode return the meta.ErrCode of a ERROR node

<a name="Node.Error"></a>
### func (Node) [Error](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/error.go#L147>)

```go
func (self Node) Error() string
```

Error return error message if it is a ERROR node

<a name="Node.Field"></a>
### func (Node) [Field](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L481>)

```go
func (self Node) Field(id proto.FieldNumber, rootLayer bool, msgDesc *proto.MessageDescriptor) (v Node, f *proto.FieldDescriptor)
```



<a name="Node.Fields"></a>
### func (Node) [Fields](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L542>)

```go
func (self Node) Fields(ids []PathNode, rootLayer bool, msgDesc *proto.MessageDescriptor, opts *Options) error
```



<a name="Node.Float64"></a>
### func (Node) [Float64](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L132>)

```go
func (self Node) Float64() (float64, error)
```

Float64 returns the float64 value contained by a DOUBLE node

<a name="Node.Fork"></a>
### func (Node) [Fork](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L24>)

```go
func (self Node) Fork() Node
```

Fork forks the node to a new node, copy underlying data as well

<a name="Node.GetByInt"></a>
### func (Node) [GetByInt](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L451>)

```go
func (self Node) GetByInt(key int) (v Node)
```

Get int key of a MAP node

<a name="Node.GetByStr"></a>
### func (Node) [GetByStr](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L419>)

```go
func (self Node) GetByStr(key string) (v Node)
```

Get string key of a MAP node

<a name="Node.Gets"></a>
### func (Node) [Gets](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L674>)

```go
func (self Node) Gets(keys []PathNode, opts *Options) error
```



<a name="Node.Index"></a>
### func (Node) [Index](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L373>)

```go
func (self Node) Index(idx int) (v Node)
```

Get idx element of a LIST node

<a name="Node.Indexes"></a>
### func (Node) [Indexes](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L611>)

```go
func (self Node) Indexes(ins []PathNode, opts *Options) error
```



<a name="Node.Int"></a>
### func (Node) [Int](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L98>)

```go
func (self Node) Int() (int, error)
```

Int returns the int value contained by a INT32/SINT32/SFIX32/INT64/SINT64/SFIX64 node

<a name="Node.IsErrNotFound"></a>
### func (Node) [IsErrNotFound](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/error.go#L119>)

```go
func (self Node) IsErrNotFound() bool
```

IsErrorNotFound tells if the node is not-found-data error

<a name="Node.IsError"></a>
### func (Node) [IsError](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/error.go#L114>)

```go
func (self Node) IsError() bool
```

IsEmtpy tells if the node is PROTOBUF.ERROR

<a name="Node.IsUnKnown"></a>
### func (Node) [IsUnKnown](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/error.go#L109>)

```go
func (self Node) IsUnKnown() bool
```

IsEmpty tells if the node is proto.UNKNOWN

<a name="Node.KeyType"></a>
### func (Node) [KeyType](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L43>)

```go
func (self Node) KeyType() proto.Type
```

KeyType returns the thrift type of a MAP node's key

<a name="Node.Len"></a>
### func (Node) [Len](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L23>)

```go
func (self Node) Len() (int, error)
```

Len returns the element count of container-kind type (LIST/MAP)

<a name="Node.Raw"></a>
### func (Node) [Raw](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L40>)

```go
func (self Node) Raw() []byte
```

Return its underlying raw data

<a name="Node.SetElemType"></a>
### func (*Node) [SetElemType](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L95>)

```go
func (self *Node) SetElemType(et proto.Type)
```



<a name="Node.SetKeyType"></a>
### func (*Node) [SetKeyType](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L99>)

```go
func (self *Node) SetKeyType(kt proto.Type)
```



<a name="Node.String"></a>
### func (Node) [String](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L150>)

```go
func (self Node) String() (string, error)
```

String returns the string value contianed by a STRING node

<a name="Node.Type"></a>
### func (Node) [Type](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/node.go#L33>)

```go
func (self Node) Type() proto.Type
```

Type returns the proto type of the node

<a name="Node.Uint"></a>
### func (Node) [Uint](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L70>)

```go
func (self Node) Uint() (uint, error)
```

Uint returns the uint value contained by a UINT32/UINT64/FIX32/FIX64 node

<a name="Options"></a>
## type [Options](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/option.go#L37-L63>)

Opions for generic.Node

```go
type Options struct {
    // DisallowUnknown indicates to report error when read unknown fields.
    DisallowUnknown bool

    // MapStructById indicates to use FieldId instead of int as map key instead of when call Node.Interface() on STRUCT type.
    MapStructById bool

    // ClearDirtyValues indicates one multi-query (includeing
    // Fields()/GetMany()/Gets()/Indexies()) to clear out all nodes
    // in passed []PathNode first
    ClearDirtyValues bool

    // CastStringAsBinary indicates to cast STRING type to []byte when call Node.Interface()/Map().
    CastStringAsBinary bool

    WriteDefault bool // not implemented

    UseNativeSkip bool // not implemented

    NotScanParentNode bool // not implemented

    StoreChildrenById bool // not implemented

    StoreChildrenByHash bool // not implemented

    IterateStructByName bool // not implemented
}
```

<a name="Path"></a>
## type [Path](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L46-L50>)

Path represents the relative position of a sub node in a complex parent node

```go
type Path struct {
    // contains filtered or unexported fields
}
```

<a name="NewPathFieldId"></a>
### func [NewPathFieldId](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L161>)

```go
func NewPathFieldId(id proto.FieldNumber) Path
```

NewPathFieldId creates a PathFieldId path

<a name="NewPathFieldName"></a>
### func [NewPathFieldName](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L169>)

```go
func NewPathFieldName(name string) Path
```

NewPathFieldName creates a PathFieldName path

<a name="NewPathIndex"></a>
### func [NewPathIndex](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L178>)

```go
func NewPathIndex(index int) Path
```

NewPathIndex creates a PathIndex path

<a name="NewPathIntKey"></a>
### func [NewPathIntKey](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L195>)

```go
func NewPathIntKey(key int) Path
```

NewPathIntKey creates a PathIntKey path

<a name="NewPathStrKey"></a>
### func [NewPathStrKey](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L186>)

```go
func NewPathStrKey(key string) Path
```

NewPathStrKey creates a PathStrKey path

<a name="Path.Id"></a>
### func (Path) [Id](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L81>)

```go
func (self Path) Id() proto.FieldNumber
```

Id returns the field id of a PathFieldId path

<a name="Path.Int"></a>
### func (Path) [Int](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L67>)

```go
func (self Path) Int() int
```

Int returns the int value of a PathIndexPathIntKey path

<a name="Path.Str"></a>
### func (Path) [Str](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L53>)

```go
func (self Path) Str() string
```

Str returns the string value of a PathFieldNamePathStrKey path

<a name="Path.ToRaw"></a>
### func (Path) [ToRaw](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L114>)

```go
func (self Path) ToRaw(t proto.Type) []byte
```

ToRaw converts underlying value to protobuf-encoded bytes

<a name="Path.Type"></a>
### func (Path) [Type](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L95>)

```go
func (self Path) Type() PathType
```

Type returns the type of a Path

<a name="Path.Value"></a>
### func (Path) [Value](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L100>)

```go
func (self Path) Value() interface{}
```

Value returns the equivalent go interface of a Path

<a name="PathNode"></a>
## type [PathNode](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L203-L207>)

PathNode is a three node of DOM tree

```go
type PathNode struct {
    Path
    Node
    Next []PathNode
}
```

<a name="NewPathNode"></a>
### func [NewPathNode](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L216>)

```go
func NewPathNode() *PathNode
```

NewPathNode get a new PathNode from memory pool

<a name="PathNode.CopyTo"></a>
### func (PathNode) [CopyTo](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L221>)

```go
func (self PathNode) CopyTo(to *PathNode)
```

CopyTo deeply copy self and its children to a PathNode

<a name="PathNode.Load"></a>
### func (*PathNode) [Load](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L563>)

```go
func (self *PathNode) Load(recurse bool, opts *Options, desc *proto.TypeDescriptor) error
```

Load loads self's all children ( and children's children if recurse is true) into self.Next, no matter whether self.Next is empty or set before (will be reset). NOTICE: if opts.NotScanParentNode is true, the parent nodes (PathNode.Node) of complex (map/list/struct) type won't be assgined data

<a name="PathNode.Marshal"></a>
### func (PathNode) [Marshal](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L639>)

```go
func (self PathNode) Marshal(opt *Options) (out []byte, err error)
```



<a name="PathNode.ResetAll"></a>
### func (*PathNode) [ResetAll](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L242>)

```go
func (self *PathNode) ResetAll()
```

ResetAll resets self and its children, including path and node both

<a name="PathNode.ResetValue"></a>
### func (*PathNode) [ResetValue](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L234>)

```go
func (self *PathNode) ResetValue()
```

ResetValue resets self's node and its children's node

<a name="PathType"></a>
## type [PathType](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/path.go#L21>)

PathType is the type of path

```go
type PathType uint8
```

<a name="PathFieldId"></a>

```go
const (
    // PathFieldId represents a field id of MESSAGE type
    PathFieldId PathType = 1 + iota

    // PathFieldName represents a field name of MESSAGE type
    // NOTICE: it is only supported by Value
    PathFieldName

    // PathIndex represents a index of LIST type
    PathIndex

    // Path represents a string key of MAP type
    PathStrKey

    // Path represents a int key of MAP type
    PathIntKey

    // Path represents a raw-bytes key of MAP type
    // It is usually used for neither-string-nor-integer type key
    PathBinKey // not supported in protobuf MapKeyDescriptor
)
```

<a name="Value"></a>
## type [Value](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L17-L21>)



```go
type Value struct {
    Node
    Desc   *proto.TypeDescriptor
    IsRoot bool
}
```

<details><summary>Example (-arshal All)</summary>
<p>



```go
desc := getExample2Desc()
data := getExample2Data()
v := NewRootValue(desc, data)
p := PathNode{
	Node: v.Node,
}

if err := p.Load(true, opts, desc); err != nil {
	panic(err)
}

out, err := p.Marshal(opts)
if err != nil {
	panic(err)
}

msg, err := NewRootValue(desc, out).Interface(opts)
if err != nil {
	panic(err)
}
fmt.Printf("%#v", msg)
```

</p>
</details>

<a name="NewComplexValue"></a>
### func [NewComplexValue](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L64>)

```go
func NewComplexValue(desc *proto.TypeDescriptor, src []byte) Value
```

only for LIST/MAP parent Node

<a name="NewRootValue"></a>
### func [NewRootValue](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L47>)

```go
func NewRootValue(desc *proto.TypeDescriptor, src []byte) Value
```



<a name="NewValue"></a>
### func [NewValue](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L56>)

```go
func NewValue(desc *proto.TypeDescriptor, src []byte) Value
```

only for basic Node

<a name="Value.Field"></a>
### func (Value) [Field](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L1006>)

```go
func (self Value) Field(id proto.FieldNumber) (v Value)
```

Field returns a sub node at the given field id from a MESSAGE value.

<a name="Value.FieldByName"></a>
### func (Value) [FieldByName](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L948>)

```go
func (self Value) FieldByName(name string) (v Value)
```

FieldByName returns a sub node at the given field name from a MESSAGE value.

<a name="Value.Fields"></a>
### func (Value) [Fields](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L1045>)

```go
func (self Value) Fields(ids []PathNode, opts *Options) error
```



<a name="Value.Fork"></a>
### func (Value) [Fork](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L86>)

```go
func (self Value) Fork() Value
```

NewValueFromNode copy both Node and TypeDescriptor from another Value.

<a name="Value.GetByInt"></a>
### func (Value) [GetByInt](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L928>)

```go
func (self Value) GetByInt(key int) (v Value)
```

GetByInt returns a sub node at the given key from a MAP value.

<a name="Value.GetByPath"></a>
### func (Value) [GetByPath](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L286>)

```go
func (self Value) GetByPath(pathes ...Path) Value
```



<a name="Value.GetByPathWithAddress"></a>
### func (Value) [GetByPathWithAddress](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L291>)

```go
func (self Value) GetByPathWithAddress(pathes ...Path) (Value, []int)
```



<a name="Value.GetByStr"></a>
### func (Value) [GetByStr](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L918>)

```go
func (self Value) GetByStr(key string) (v Value)
```

GetByInt returns a sub node at the given key from a MAP value.

<a name="Value.GetMany"></a>
### func (Value) [GetMany](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L1019>)

```go
func (self Value) GetMany(pathes []PathNode, opts *Options) error
```

GetMany searches transversely and returns all the sub nodes along with the given pathes.

<details><summary>Example</summary>
<p>



```go
desc := getExample2Desc()
data := getExample2Data()
v := NewRootValue(desc, data)

ps := []PathNode{
	{Path: NewPathFieldId(1)},
	{Path: NewPathFieldId(3)},
	{Path: NewPathFieldId(32767)},
}

err := v.GetMany(ps, opts)
if err != nil {
	panic(err)
}
```

</p>
</details>

<a name="Value.Index"></a>
### func (Value) [Index](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L938>)

```go
func (self Value) Index(i int) (v Value)
```

Index returns a sub node at the given index from a LIST value.

<a name="Value.IntMap"></a>
### func (Value) [IntMap](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L239>)

```go
func (self Value) IntMap(opts *Options) (map[int]interface{}, error)
```



<a name="Value.Interface"></a>
### func (Value) [Interface](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L320>)

```go
func (self Value) Interface(opts *Options) (interface{}, error)
```

Interface returns the go interface value contained by a node. If the node is a MESSAGE, it will return map[proto.FieldNumber]interface{} or map[int]interface{}. If it is a map, it will return map[int|string]interface{}, which depends on the key type

<a name="Value.List"></a>
### func (Value) [List](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L185>)

```go
func (self Value) List(opts *Options) ([]interface{}, error)
```



<a name="Value.MarshalTo"></a>
### func (Value) [MarshalTo](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L834>)

```go
func (self Value) MarshalTo(to *proto.TypeDescriptor, opts *Options) ([]byte, error)
```

MarshalTo marshals self value into a sub value descripted by the to descriptor, alse called as "Cutting". Usually, the to descriptor is a subset of self descriptor.

<a name="Value.SetByPath"></a>
### func (*Value) [SetByPath](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L473>)

```go
func (self *Value) SetByPath(sub Node, path ...Path) (exist bool, err error)
```

SetByPath searches longitudinally and sets a sub value at the given path from the value. exist tells whether the node is already exists.

<details><summary>Example</summary>
<p>



```go
desc := getExample2Desc()
data := getExample2Data()
v := NewRootValue(desc, data)

p := binary.NewBinaryProtol([]byte{})
exp := "中文"
p.WriteString(exp)
buf := p.RawBuf()
vv := NewNode(proto.STRING, buf)

ps := []Path{NewPathFieldName("InnerBase2"), NewPathFieldName("Base"), NewPathFieldName("Extra"), NewPathStrKey("b")}
exist, err2 := v.SetByPath(vv, ps...)
if err2 != nil {
	panic(err2)
}
fmt.Println(exist) // false

// check inserted value
s2 := v.GetByPath(ps...)
if s2.Error() != "" {
	panic(s2.Error())
}
f2, _ := s2.String()
fmt.Println(f2) // 中文
```

</p>
</details>

<a name="Value.SetMany"></a>
### func (*Value) [SetMany](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L1058>)

```go
func (self *Value) SetMany(pathes []PathNode, opts *Options, root *Value, address []int, path ...Path) (err error)
```

SetMany: set a list of sub nodes at the given pathes from the value. root *Value: the root Node self *Value: the current Node (maybe root Node) address []int: the address from target Nodes to the root Node path ...Path: the path from root Node to target Nodes

<a name="Value.StrMap"></a>
### func (Value) [StrMap](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/cast.go#L278>)

```go
func (self Value) StrMap(opts *Options) (map[string]interface{}, error)
```



<a name="Value.UnsetByPath"></a>
### func (*Value) [UnsetByPath](<https://github.com/khan-yin/dynamicgo/blob/main/proto/generic/value.go#L598>)

```go
func (self *Value) UnsetByPath(path ...Path) error
```

UnsetByPath searches longitudinally and unsets a sub value at the given path from the value.

Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)