Struct TypedValueEncoding 

pub struct TypedValueEncoding;

The TypedValueEncoding stores the value of an RDF term as a union of possible types.

Value Spaces

Each RDF literal type has an associated value space (e.g., xsd:int has the value space of 32-bit integers). Transforming the transformation from the lexical space to the value space might be a lossy transformation. For example, the two distinct RDF terms "1"^^xsd::int and "01"^^xsd::int map to the same value. The TypedValueEncoding cannot distinguish between these two terms and therefore should only be used for query parts that do not rely on this distinction.

Future Plans

Currently, the TypedValue encoding has a fixed Arrow DataType. We plan to change that in the future such that users can provide custom encodings for domain-specific literals (e.g., geospatial coordinates).

Implementations

impl TypedValueEncoding

pub fn fields() -> UnionFields

pub fn string_fields() -> Fields

pub fn string_type() -> DataType

pub fn timestamp_fields() -> Fields

pub fn duration_fields() -> Fields

pub fn typed_literal_fields() -> Fields

pub fn encode_term( &self, term: Result<TermRef<'_>, ThinError>, ) -> Result<TypedValueScalar, DataFusionError>

Encodes the term as a TypedValueScalar.

Trait Implementations

impl Debug for TypedValueEncoding

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl TermDecoder<TypedValueEncoding> for BooleanTermValueDecoder

type Term<'data> = Boolean

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<BooleanTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<BooleanTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for DateTimeTermValueDecoder

type Term<'data> = DateTime

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<DateTimeTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<DateTimeTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for DefaultTypedValueDecoder

type Term<'data> = TypedValueRef<'data>

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<DefaultTypedValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<DefaultTypedValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for IntegerTermValueDecoder

type Term<'data> = Integer

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<IntegerTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<IntegerTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for NamedNodeRefTermValueDecoder

type Term<'data> = NamedNodeRef<'data>

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<NamedNodeRefTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<NamedNodeRefTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for NumericTermValueDecoder

type Term<'data> = Numeric

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<NumericTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<NumericTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for SimpleLiteralRefTermValueDecoder

type Term<'data> = SimpleLiteralRef<'data>

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<SimpleLiteralRefTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<SimpleLiteralRefTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermDecoder<TypedValueEncoding> for StringLiteralRefTermValueDecoder

type Term<'data> = StringLiteralRef<'data>

The resulting value type of decoding an RDF term.

fn decode_terms( array: &<TypedValueEncoding as TermEncoding>::Array, ) -> impl Iterator<Item = Result<<StringLiteralRefTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

fn decode_term( scalar: &<TypedValueEncoding as TermEncoding>::Scalar, ) -> Result<<StringLiteralRefTermValueDecoder as TermDecoder<TypedValueEncoding>>::Term<'_>, ThinError>

Allows extracting an iterator over all RDF terms in array that are compatible with this decoder (see TermDecoder for more information).

impl TermEncoder<TypedValueEncoding> for BlankNodeRefTermValueEncoder

type Term<'data> = BlankNodeRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<BlankNodeRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<BlankNodeRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for BlankNodeTermValueEncoder

type Term<'data> = BlankNode

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<BlankNodeTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<BlankNodeTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for BooleanTermValueEncoder

type Term<'data> = Boolean

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<BooleanTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<BooleanTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for DateTimeTermValueEncoder

type Term<'data> = DateTime

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<DateTimeTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<DateTimeTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for DayTimeDurationTermValueEncoder

type Term<'data> = DayTimeDuration

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<DayTimeDurationTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<DayTimeDurationTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for DecimalTermValueEncoder

type Term<'data> = Decimal

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<DecimalTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<DecimalTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for DefaultTypedValueEncoder

type Term<'data> = TypedValueRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<DefaultTypedValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<DefaultTypedValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for DoubleTermValueEncoder

type Term<'data> = Double

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<DoubleTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<DoubleTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for FloatTermValueEncoder

type Term<'data> = Float

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<FloatTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<FloatTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for IntTermValueEncoder

type Term<'data> = Int

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<IntTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<IntTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for IntegerTermValueEncoder

type Term<'data> = Integer

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<IntegerTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<IntegerTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for LiteralRefTermValueEncoder

type Term<'data> = LiteralRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<LiteralRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<LiteralRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for NamedNodeRefTermValueEncoder

type Term<'data> = NamedNodeRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<NamedNodeRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<NamedNodeRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for NamedNodeTermValueEncoder

type Term<'data> = NamedNode

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<NamedNodeTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<NamedNodeTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for NumericTypedValueEncoder

type Term<'data> = Numeric

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<NumericTypedValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<NumericTypedValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for OwnedStringLiteralTermValueEncoder

type Term<'data> = OwnedStringLiteral

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<OwnedStringLiteralTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<OwnedStringLiteralTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for SimpleLiteralRefTermValueEncoder

type Term<'data> = SimpleLiteralRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<SimpleLiteralRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<SimpleLiteralRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for StringLiteralRefTermValueEncoder

type Term<'data> = StringLiteralRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<StringLiteralRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<StringLiteralRefTermValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoder<TypedValueEncoding> for TermRefTypedValueEncoder

type Term<'data> = TermRef<'data>

The value type that is being encoded.

fn encode_terms<'data>( terms: impl IntoIterator<Item = Result<<TermRefTypedValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'data>, ThinError>>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Allows encoding an iterator over RDF terms in an Arrow array.

fn encode_term( term: Result<<TermRefTypedValueEncoder as TermEncoder<TypedValueEncoding>>::Term<'_>, ThinError>, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Allows encoding a scalar RDF term in an Arrow scalar.

impl TermEncoding for TypedValueEncoding

type Array = TypedValueArray

Represents a wrapper for Arrow arrays of this encoding. This can be used in conjunction with TermDecoder to obtain the values from an Arrow array.

type Scalar = TypedValueScalar

Represents a wrapper for Arrow scalars of this encoding. This can be used in conjunction with TermDecoder to obtain the values from an Arrow scalar.

fn name(&self) -> EncodingName

Returns the name of the encoding.

fn data_type(&self) -> DataType

Returns the DataType that is used for this encoding.

fn try_new_array( &self, array: Arc<dyn Array>, ) -> Result<<TypedValueEncoding as TermEncoding>::Array, DataFusionError>

Checks whether array contains a value with the correct encoding (i.e., type and possibly metadata checks). If yes, returns an instance of Self::Array. Otherwise, an error is returned.

fn try_new_scalar( &self, scalar: ScalarValue, ) -> Result<<TypedValueEncoding as TermEncoding>::Scalar, DataFusionError>

Checks whether scalar contains a value with the correct encoding (i.e., type and possibly metadata checks). If yes, returns an instance of Self::Scalar. Otherwise, an error is returned.

fn try_new_datum( &self, value: ColumnarValue, number_rows: usize, ) -> Result<EncodingDatum<Self>, DataFusionError>

Checks whether value contains a value with the correct encoding (i.e., type and possibly metadata checks). If yes, returns a datum that either wraps an array or a scalar. Otherwise, an error is returned.