quad

Documentation

Overview

Package quad is deprecated. Use github.com/cayleygraph/quad.

Index

• Constants
• Variables
• func Copy(dst Writer, src Reader) (n int, err error)
• func CopyBatch(dst BatchWriter, src Reader, batchSize int) (int, error)
• func HashOf(v Value) []byte
• func HashTo(v Value, p []byte)
• func IsValidValue(v Value) bool
• func NativeOf(v Value) interface{}
• func RegisterFormat(f Format)
• func RegisterStringConversion(dataType IRI, fnc StringConversion)
• func StringOf(v Value) string
• func ToString(v Value) string
• type BNode
  • func RandomBlankNode() BNode
• type BatchReader
• type BatchWriter
• type Bool
• type ByQuadString
• type ByValueString
• type Direction
• type Equaler
• type Float
• type Format
  • func FormatByExt(name string) *Format
  • func FormatByMime(name string) *Format
  • func FormatByName(name string) *Format
  • func Formats() []Format
• type IRI
• type IRIFormat
• type IRIOptions
• type Int
• type LangString
• type Quad
  • func Make(subject, predicate, object, label interface{}) Quad
  • func MakeIRI(subject, predicate, object, label string) Quad
  • func MakeRaw(subject, predicate, object, label string) Quad
  • func ReadAll(r Reader) ([]Quad, error)
• type Quads
  • func NewReader(quads []Quad) *Quads
• type ReadCloser
• type ReadSkipCloser
• type Reader
• type Sequence
• type Skipper
• type String
• type StringConversion
• type Time
• type TypedString
• type TypedStringer
• type Value
  • func AsValue(v interface{}) (Value, bool)
  • func Raw(s string) Value
  • func StringToValue(v string) Value
• type WriteCloser
• type Writer
  • func IRIWriter(w Writer, opt IRIOptions) Writer
  • func ValuesWriter(w Writer, fnc func(d Direction, v Value) (Value, error)) Writer

Constants

const (
	Any       = quad.Any
	Subject   = quad.Subject
	Predicate = quad.Predicate
	Object    = quad.Object
	Label     = quad.Label
)

List of the valid directions of a quad.

const (
	// IRIDefault preserves current IRI formatting.
	IRIDefault = quad.IRIDefault
	// IRIShort changes IRI to use a short namespace prefix (ex: <rdf:type>).
	IRIShort = quad.IRIShort
	// IRIFull changes IRI to use full form (ex: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>).
	IRIFull = quad.IRIFull
)

const HashSize = quad.HashSize

HashSize is a size of the slice, returned by HashOf.

Deprecated: use github.com/cayleygraph/quad package instead.

Variables

var (
	ErrInvalid    = quad.ErrInvalid
	ErrIncomplete = quad.ErrIncomplete
)

var DefaultBatch = quad.DefaultBatch

var Directions = quad.Directions

Functions

func Copy

func Copy(dst Writer, src Reader) (n int, err error)

Copy will copy all quads from src to dst. It returns copied quads count and an error, if it failed.

Copy will try to cast dst to BatchWriter and will switch to CopyBatch implementation in case of success.

Deprecated: use github.com/cayleygraph/quad package instead.

func CopyBatch

func CopyBatch(dst BatchWriter, src Reader, batchSize int) (int, error)

CopyBatch will copy all quads from src to dst in a batches of batchSize. It returns copied quads count and an error, if it failed.

If batchSize <= 0 default batch size will be used.

Deprecated: use github.com/cayleygraph/quad package instead.

func HashOf

func HashOf(v Value) []byte

HashOf calculates a hash of value v.

Deprecated: use github.com/cayleygraph/quad package instead.

func HashTo

func HashTo(v Value, p []byte)

HashTo calculates a hash of value v, storing it in a slice p.

Deprecated: use github.com/cayleygraph/quad package instead.

func IsValidValue

func IsValidValue(v Value) bool

func NativeOf

func NativeOf(v Value) interface{}

NativeOf safely call v.Native, returning nil in case of nil Value.

Deprecated: use github.com/cayleygraph/quad package instead.

func RegisterFormat

func RegisterFormat(f Format)

RegisterFormat registers a new quad-file format.

Deprecated: use github.com/cayleygraph/quad package instead.

func RegisterStringConversion

func RegisterStringConversion(dataType IRI, fnc StringConversion)

RegisterStringConversion will register an automatic conversion of TypedString values with provided type to a native equivalent such as Int, Time, etc.

If fnc is nil, automatic conversion from selected type will be removed.

Deprecated: use github.com/cayleygraph/quad package instead.

func StringOf

func StringOf(v Value) string

StringOf safely call v.String, returning empty string in case of nil Value.

Deprecated: use github.com/cayleygraph/quad package instead.

func ToString

func ToString(v Value) string

ToString casts a values to String or falls back to StringOf.

Deprecated: use github.com/cayleygraph/quad package instead.

Types

type BNode

type BNode = quad.BNode

BNode is an RDF Blank Node (ex: _:name).

Deprecated: use github.com/cayleygraph/quad package instead.

func RandomBlankNode

func RandomBlankNode() BNode

RandomBlankNode returns a randomly generated Blank Node.

Deprecated: use github.com/cayleygraph/quad package instead.

type BatchReader

type BatchReader = quad.BatchReader

BatchReader is an interface for reading quads in batches.

ReadQuads reads at most len(buf) quads into buf. It returns number of quads that were read and an error. It returns an io.EOF if there is no more quads to read.

Deprecated: use github.com/cayleygraph/quad package instead.

type BatchWriter

type BatchWriter = quad.BatchWriter

BatchWriter is an interface for writing quads in batches.

Deprecated: use github.com/cayleygraph/quad package instead.

type Bool

type Bool = quad.Bool

Bool is a native wrapper for bool type.

It uses NQuad notation similar to TypedString.

Deprecated: use github.com/cayleygraph/quad package instead.

type ByQuadString

type ByQuadString = quad.ByQuadString

type ByValueString

type ByValueString = quad.ByValueString

type Direction

type Direction = quad.Direction

Direction specifies an edge's type.

Deprecated: use github.com/cayleygraph/quad package instead.

type Equaler

type Equaler = quad.Value

Equaler interface is implemented by values, that needs a special equality check.

Deprecated: use github.com/cayleygraph/quad package instead.

type Float

type Float = quad.Float

Float is a native wrapper for float64 type.

It uses NQuad notation similar to TypedString.

Deprecated: use github.com/cayleygraph/quad package instead.

type Format

type Format = quad.Format

Format is a description for quad-file formats.

Deprecated: use github.com/cayleygraph/quad package instead.

func FormatByExt

func FormatByExt(name string) *Format

FormatByExt returns a registered format by its file extension. Will return nil if format is not found.

Deprecated: use github.com/cayleygraph/quad package instead.

func FormatByMime

func FormatByMime(name string) *Format

FormatByMime returns a registered format by its MIME type. Will return nil if format is not found.

Deprecated: use github.com/cayleygraph/quad package instead.

func FormatByName

func FormatByName(name string) *Format

FormatByName returns a registered format by its name. Will return nil if format is not found.

Deprecated: use github.com/cayleygraph/quad package instead.

func Formats

func Formats() []Format

Formats returns a list of all supported quad formats.

Deprecated: use github.com/cayleygraph/quad package instead.

type IRI

type IRI = quad.IRI

IRI is an RDF Internationalized Resource Identifier (ex: <name>).

Deprecated: use github.com/cayleygraph/quad package instead.

type IRIFormat

type IRIFormat = quad.IRIFormat

IRIFormat is a format of IRI.

Deprecated: use github.com/cayleygraph/quad package instead.

type IRIOptions

type IRIOptions = quad.IRIOptions

IRIOptions is a set of option

Deprecated: use github.com/cayleygraph/quad package instead.

type Int

type Int = quad.Int

Int is a native wrapper for int64 type.

It uses NQuad notation similar to TypedString.

Deprecated: use github.com/cayleygraph/quad package instead.

type LangString

type LangString = quad.LangString

LangString is an RDF string with language (ex: "name"@lang).

Deprecated: use github.com/cayleygraph/quad package instead.

type Quad

type Quad = quad.Quad

Our quad struct, used throughout.

Deprecated: use github.com/cayleygraph/quad package instead.

func Make

func Make(subject, predicate, object, label interface{}) Quad

Make creates a quad with provided values.

Deprecated: use github.com/cayleygraph/quad package instead.

func MakeIRI

func MakeIRI(subject, predicate, object, label string) Quad

MakeIRI creates a quad with provided IRI values.

Deprecated: use github.com/cayleygraph/quad package instead.

func MakeRaw

func MakeRaw(subject, predicate, object, label string) Quad

MakeRaw creates a quad with provided raw values (nquads-escaped).

Deprecated: use Make pr MakeIRI instead.

func ReadAll

func ReadAll(r Reader) ([]Quad, error)

ReadAll reads all quads from r until EOF. It returns a slice with all quads that were read and an error, if any.

Deprecated: use github.com/cayleygraph/quad package instead.

type Quads

type Quads = quad.Quads

func NewReader

func NewReader(quads []Quad) *Quads

NewReader creates a quad reader from a quad slice.

Deprecated: use github.com/cayleygraph/quad package instead.

type ReadCloser

type ReadCloser = quad.ReadCloser

type ReadSkipCloser

type ReadSkipCloser = quad.ReadSkipCloser

type Reader

type Reader = quad.Reader

Reader is a minimal interface for quad readers. Used for quad deserializers and quad iterators.

ReadQuad reads next valid Quad. It returns io.EOF if no quads are left.

Deprecated: use github.com/cayleygraph/quad package instead.

type Sequence

type Sequence = quad.Sequence

Sequence is an object to generate a sequence of Blank Nodes.

Deprecated: use github.com/cayleygraph/quad package instead.

type Skipper

type Skipper = quad.Skipper

Skipper is an interface for quad reader that can skip quads efficiently without decoding them.

It returns io.EOF if no quads are left.

Deprecated: use github.com/cayleygraph/quad package instead.

type String

type String = quad.String

String is an RDF string value (ex: "name").

Deprecated: use github.com/cayleygraph/quad package instead.

type StringConversion

type StringConversion = quad.StringConversion

StringConversion is a function to convert string values with a specific IRI type to their native equivalents.

Deprecated: use github.com/cayleygraph/quad package instead.

type Time

type Time = quad.Time

Time is a native wrapper for time.Time type.

It uses NQuad notation similar to TypedString.

Deprecated: use github.com/cayleygraph/quad package instead.

type TypedString

type TypedString = quad.TypedString

TypedString is an RDF value with type (ex: "name"^^<type>).

Deprecated: use github.com/cayleygraph/quad package instead.

type TypedStringer

type TypedStringer interface {
	TypedString() TypedString
}

type Value

type Value = quad.Value

Value is a type used by all quad directions.

Deprecated: use github.com/cayleygraph/quad package instead.

func AsValue

func AsValue(v interface{}) (Value, bool)

AsValue converts native type into closest Value representation. It returns false if type was not recognized.

Deprecated: use github.com/cayleygraph/quad package instead.

func Raw

func Raw(s string) Value

Raw is a Turtle/NQuads-encoded value.

Deprecated: use IRI or String instead.

func StringToValue

func StringToValue(v string) Value

StringToValue is a function to convert strings to typed quad values.

Deprecated: use github.com/cayleygraph/quad package instead.

type WriteCloser

type WriteCloser = quad.WriteCloser

type Writer

type Writer = quad.Writer

Writer is a minimal interface for quad writers. Used for quad serializers and quad stores.

Deprecated: use github.com/cayleygraph/quad package instead.

func IRIWriter

func IRIWriter(w Writer, opt IRIOptions) Writer

IRIWriter is a writer implementation that converts all IRI values in quads according to the IRIOptions.

Deprecated: use github.com/cayleygraph/quad package instead.

func ValuesWriter

func ValuesWriter(w Writer, fnc func(d Direction, v Value) (Value, error)) Writer

ValuesWriter is a writer implementation that converts all quad values using the callback function.

Deprecated: use github.com/cayleygraph/quad package instead.