modulepackage
0.0.0-20200318135517-5af53c29c67e
Repository: https://github.com/arangodb/go-velocypack.git
Documentation: pkg.go.dev
# Functions
EmptyArraySlice creates a slice of type Array, empty.
EmptyObjectSlice creates a slice of type Object, empty.
FalseSlice creates a slice of type Boolean with false value.
IllegalSlice creates a slice of type Illegal.
IsBuilderUnexpectedType returns true if the given error is an BuilderUnexpectedTypeError.
IsInvalidType returns true if the given error is an InvalidTypeError.
IsInvalidUnmarshal returns true if the given error is an InvalidUnmarshalError.
IsMarshaler returns true if the given error is an MarshalerError.
IsParse returns true if the given error is a ParseError.
IsUnmarshalType returns true if the given error is an UnmarshalTypeError.
IsUnsupportedType returns true if the given error is an UnsupportedTypeError.
Marshal writes the Velocypack encoding of v to a buffer and returns that buffer.
MaxKeySlice creates a slice of type MaxKey.
Merge creates a slice that contains all fields from all given slices.
MinKeySlice creates a slice of type MinKey.
NewArrayIterator initializes an iterator at position 0 of the given object slice.
NewArrayValue creates a new Value that opens a new array.
NewBinaryValue creates a new Value of type Binary with given value.
NewBoolValue creates a new Value of type Bool with given value.
No description provided by the author
NewDecoder creates a new Decoder that reads data from the given reader.
NewDoubleValue creates a new Value of type Double with given value.
NewDumper creates a new dumper around the given writer, with an optional options.
NewEncoder creates a new Encoder that writes output to the given writer.
NewIntValue creates a new Value of type Int with given value.
NewMaxKeyValue creates a new Value of type MaxKey.
NewMinKeyValue creates a new Value of type MinKey.
NewNullValue creates a new Value of type Null.
NewObjectIterator initializes an iterator at position 0 of the given object slice.
NewObjectValue creates a new Value that opens a new object.
NewParser initializes a new Parser with JSON from the given reader and it will store the parsers output in the given builder.
NewReflectValue creates a new Value with type derived from Go type of given reflect value.
NewSliceValue creates a new Value of from the given slice.
NewStringValue creates a new Value of type String with given value.
NewUIntValue creates a new Value of type UInt with given value.
NewUTCDateValue creates a new Value of type UTCDate with given value.
NewValue creates a new Value with type derived from Go type of given value.
NoneSlice creates a slice of type None.
NullSlice creates a slice of type Null.
ParseJSON parses JSON from the given reader and returns the VPack equivalent.
ParseJSONFromString parses the given JSON string and returns the VPack equivalent.
ParseJSONFromUTF8 parses the given JSON string and returns the VPack equivalent.
SliceFromHex creates a Slice by decoding the given hex string into a Slice.
SliceFromReader reads a slice from the given reader.
StringSlice creates a slice of type String with given string value.
TrueSlice creates a slice of type Boolean with true value.
Unmarshal reads v from the given Velocypack encoded data slice.
ZeroSlice creates a slice of type Smallint(0).
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
illegal value.
No description provided by the author
No description provided by the author
No description provided by the author
not yet initialized.
JSON null.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
BuilderKeyAlreadyWrittenError is returned when a call is made to Builder.Bytes without being closed.
BuilderKeyMustBeStringError is returned when a key is not of type string.
BuilderNeedOpenArrayError indicates an (invalid) attempt to open an array/object when that is not allowed.
BuilderNeedOpenCompoundError indicates an (invalid) attempt to close an array/object that is already closed.
BuilderNeedOpenObjectError indicates an (invalid) attempt to open an array/object when that is not allowed.
BuilderNeedSubValueError is returned when a RemoveLast is called without any value in an object/array.
BuilderNotClosedError is returned when a call is made to Builder.Bytes without being closed.
Cause is used to get the root cause of the given error.
No description provided by the author
IndexOutOfBoundsError indicates an index outside of array/object bounds.
InternalError indicates an error that the client cannot prevent.
InvalidUtf8SequenceError indicates an invalid UTF8 (string) sequence.
IsBuilderKeyAlreadyWritten returns true if the given error is an BuilderKeyAlreadyWrittenError.
IsBuilderKeyMustBeString returns true if the given error is an BuilderKeyMustBeStringError.
IsBuilderNeedOpenArray returns true if the given error is an BuilderNeedOpenArrayError.
IsBuilderNeedOpenCompound returns true if the given error is an BuilderNeedOpenCompoundError.
IsBuilderNeedOpenObject returns true if the given error is an BuilderNeedOpenObjectError.
IsBuilderNeedSubValue returns true if the given error is an BuilderNeedSubValueError.
IsBuilderNotClosed returns true if the given error is an BuilderNotClosedError.
IsDuplicateAttributeName returns true if the given error is an DuplicateAttributeNameError.
IsIndexOutOfBounds returns true if the given error is an IndexOutOfBoundsError.
IsInternal returns true if the given error is an InternalError.
IsInvalidUtf8Sequence returns true if the given error is an InvalidUtf8SequenceError.
IsNeedAttributeTranslator returns true if the given error is an NeedAttributeTranslatorError.
IsNoJSONEquivalent returns true if the given error is an NoJSONEquivalentError.
IsNumberOutOfRange returns true if the given error is an NumberOutOfRangeError.
NeedAttributeTranslatorError indicates a lack of object key translator (smallint|uint -> string).
NoJSONEquivalentError is returned when a Velocypack type cannot be converted to JSON.
NumberOutOfRangeError indicates an out of range error.
WithStack is called on every return of an error to add stacktrace information to the error.
# Structs
No description provided by the author
Builder is used to build VPack structures.
BuilderOptions contains options that influence how Builder builds slices.
BuilderUnexpectedTypeError is returned when a Builder function received an invalid type.
A Decoder decodes velocypack values into Go structures.
No description provided by the author
No description provided by the author
An Encoder encodes Go structures into velocypack values written to an output stream.
InvalidTypeError is returned when a Slice getter is called on a slice of a different type.
An InvalidUnmarshalError describes an invalid argument passed to Unmarshal.
MarshalerError is returned when a custom VPack Marshaler returns an error.
No description provided by the author
An ParseError is returned when JSON cannot be parsed correctly.
Parser is used to build VPack structures from JSON.
ParserOptions controls how the Parser builds Velocypack.
An UnmarshalTypeError describes a JSON value that was not appropriate for a value of a specific Go type.
UnsupportedTypeError is returned when a type is marshaled that cannot be marshaled.
Value is a helper structure used to build VPack structures.
# Interfaces
Marshaler is implemented by types that can convert themselves into Velocypack.
Unmarshaler is implemented by types that can convert themselves from Velocypack.
# Type aliases
RawSlice is a raw encoded Velocypack value.
Slice provides read only access to a VPack value.
No description provided by the author
No description provided by the author
No description provided by the author