package ndr

Import Path
	github.com/jcmturner/rpc/v2/ndr (on go.dev)

Dependency Relation
	imports 10 packages, and imported by 2 packages

Involved Source Files

	    arrays.go
	  d decoder.go
		Package ndr provides the ability to unmarshal NDR encoded byte steams into Go data structures

	    error.go
	    header.go
	    pipe.go
	    primitives.go
	    rawbytes.go
	    strings.go
	    tags.go
	    union.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type CommonHeader (struct)
		CommonHeader implements the NDR common header: https://msdn.microsoft.com/en-us/library/cc243889.aspx

		Fields (total 6)
			CharacterEncoding uint8
			Endianness binary.ByteOrder
			Filler []byte
			FloatRepresentation uint8
			HeaderLength uint16
			Version uint8

	 type Decoder (struct)
		Decoder unmarshals NDR byte stream data into a Go struct representation

		Methods (only one)
			(*Decoder) Decode(s interface{}) error
				Decode unmarshals the NDR encoded bytes into the pointer of a struct provided.

		As Outputs Of (at least one exported)
			func NewDecoder(r io.Reader) *Decoder

	 type Malformed (struct)
		Malformed implements the error interface for malformed NDR encoding errors.

		Fields (only one)
			EText string
		Methods (only one)
			( Malformed) Error() string
				Error implements the error interface on the Malformed struct.

		Implements (at least one exported)
			 Malformed : error
		As Outputs Of (at least one exported)
			func Errorf(format string, a ...interface{}) Malformed

	 type PrivateHeader (struct)
		PrivateHeader implements the NDR private header: https://msdn.microsoft.com/en-us/library/cc243919.aspx

		Fields (total 2)
			Filler []byte
			ObjectBufferLength uint32

	 type RawBytes (interface)
		RawBytes interface should be implemented if reading just a number of bytes from the NDR stream

		Methods (only one)
			( RawBytes) Size(interface{}) int
		Implemented By (at least one exported)
			 github.com/jcmturner/rpc/v2/mstypes.EncodedBlob

	 type Union (interface)
		Union interface must be implemented by structs that will be unmarshaled into from the NDR byte stream union representation.
		The union's discriminating tag will be passed to the SwitchFunc method.
		The discriminating tag field must have the struct tag: `ndr:"unionTag"`
		If the union is encapsulated the discriminating tag field must have the struct tag: `ndr:"encapsulated"`
		The possible value fields that can be selected from must have the struct tag: `ndr:"unionField"`

		Methods (only one)
			( Union) SwitchFunc(t interface{}) string
		Implemented By (at least one exported)
			 github.com/jcmturner/rpc/v2/mstypes.ClaimEntry


Package-Level Functions (total 2)

	 func Errorf(format string, a ...interface{}) Malformed
		Errorf formats an error message into a malformed NDR error.

	 func NewDecoder(r io.Reader) *Decoder
		NewDecoder creates a new instance of a NDR Decoder.


Package-Level Constants (total 17)

	const SizeBool = 1
		Byte sizes of primitive types

	const SizeChar = 1
		Byte sizes of primitive types

	const SizeDouble = 8
		Byte sizes of primitive types

	const SizeEnum = 2
		Byte sizes of primitive types

	const SizePtr = 4
		Byte sizes of primitive types

	const SizeSingle = 4
		Byte sizes of primitive types

	const SizeUint16 = 2
		Byte sizes of primitive types

	const SizeUint32 = 4
		Byte sizes of primitive types

	const SizeUint64 = 8
		Byte sizes of primitive types

	const SizeUint8 = 1
		Byte sizes of primitive types

	const TagConformant = "conformant"
		Struct tag values

	const TagEncapsulated = "encapsulated"
		Union related constants such as struct tag values

	const TagPipe = "pipe"
		Struct tag values

	const TagPointer = "pointer"
		Struct tag values

	const TagUnionField = "unionField"
		Union related constants such as struct tag values

	const TagUnionTag = "unionTag"
		Union related constants such as struct tag values

	const TagVarying = "varying"
		Struct tag values

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.