dmeta

Documentation

Index

• type ArrayField
• type Bytable
• type Field
• type Nillable
• type ObjectField
• type Sized
• type Validatable

Types

type ArrayField

type ArrayField interface {
	Field

	gojay.MarshalerJSONArray
	gojay.UnmarshalerJSONArray
}

type Bytable

type Bytable interface {
	ToJSONBytes() []byte

	// AppendBytes appends the JSON value of this type to the given writer.
	//
	// This method should include any encapsulating characters such as quotes or
	// brackets.  JSON field dividers separating this value from other values,
	// such as commas or colons should be appended by the caller of this method,
	// not the implementer.  Implementers of this method should only include those
	// dividers multiple values are encapsulated in this type itself, such as in a
	// struct or slice type.
	//
	// Example:
	//   Given a field of type `string`, with the value:
	//     foo := "hello"
	//   The bytes that should be written would be:
	//     []byte(`"hello"`).
	//
	//   Given a field of type `[]string` with the value
	//     foo := []string{"yes", "no"}
	//   The bytes that would be written would be:
	//     []byte(`["yes","no"]`)
	AppendJSONBytes(writer io.Writer) error
}

type Field

type Field interface {
	json.Marshaler
	json.Unmarshaler

	Sized
	Nillable
	Bytable
}

type Nillable

type Nillable interface {
	IsNil() bool
}

type ObjectField

type ObjectField interface {
	Field

	gojay.MarshalerJSONObject
	gojay.UnmarshalerJSONObject
}

type Sized

type Sized interface {
	// JSONSize returns the projected number of bytes required to store this value
	// as a JSON string.
	JSONSize() uint32
}

type Validatable

type Validatable interface {
	IsValid() bool
	Validate() error
}