Struct oxigraph::model::Literal

pub struct Literal(_);

An owned RDF literal

The default string formatter is returning an N-Triples, Turtle and SPARQL compatible representation:

use oxigraph::model::Literal;
use oxigraph::model::vocab::xsd;

assert_eq!(
    "\"foo\\nbar\"",
    Literal::new_simple_literal("foo\nbar").to_string()
);

assert_eq!(
    "\"1999-01-01\"^^<http://www.w3.org/2001/XMLSchema#date>",
    Literal::new_typed_literal("1999-01-01", xsd::DATE).to_string()
);

assert_eq!(
    "\"foo\"@en",
    Literal::new_language_tagged_literal("foo", "en")?.to_string()
);

Implementations

impl Literal

pub fn new_simple_literal(value: impl Into<String>) -> Self

Builds an RDF simple literal

pub fn new_typed_literal(
    value: impl Into<String>,
    datatype: impl Into<NamedNode>
) -> Self

Builds an RDF literal with a datatype

pub fn new_language_tagged_literal(
    value: impl Into<String>,
    language: impl Into<String>
) -> Result<Self, LanguageTagParseError>

Builds an RDF language-tagged string

pub fn new_language_tagged_literal_unchecked(
    value: impl Into<String>,
    language: impl Into<String>
) -> Self

Builds an RDF language-tagged string

It is the responsibility of the caller to check that language is valid BCP47 language tag, and is lowercase.

new_language_tagged_literal is a safe version of this constructor and should be used for untrusted data.

pub fn value(&self) -> &str

The literal lexical form

pub fn language(&self) -> Option<&str>

The literal language tag if it is a language-tagged string.

Language tags are defined by the BCP47. They are normalized to lowercase by this implementation.

pub fn datatype(&self) -> NamedNodeRef<'_>

The literal datatype.

The datatype of language-tagged string is always rdf:langString. The datatype of simple literals is xsd:string.

pub fn is_plain(&self) -> bool

Checks if this literal could be seen as an RDF 1.0 plain literal.

It returns true if the literal is a language-tagged string or has the datatype xsd:string.

pub fn as_ref(&self) -> LiteralRef<'_>

pub fn destruct(self) -> (String, Option<NamedNode>, Option<String>)

Extract components from this literal

Trait Implementations

impl Clone for Literal

fn clone(&self) -> Literal

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Literal

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

Formats the value using the given formatter.

impl Display for Literal

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

Formats the value using the given formatter.

impl Eq for Literal

impl<'a> From<&'a Literal> for LiteralRef<'a>

fn from(node: &'a Literal) -> Self

Performs the conversion.

impl<'a> From<&'a Literal> for TermRef<'a>

fn from(literal: &'a Literal) -> Self

Performs the conversion.

impl<'a> From<&'a str> for Literal

fn from(value: &'a str) -> Self

Performs the conversion.

impl<'a> From<Cow<'a, str>> for Literal

fn from(value: Cow<'a, str>) -> Self

Performs the conversion.

impl From<Literal> for Term

fn from(literal: Literal) -> Self

Performs the conversion.

impl<'a> From<LiteralRef<'a>> for Literal

fn from(node: LiteralRef<'a>) -> Self

Performs the conversion.

impl From<String> for Literal

fn from(value: String) -> Self

Performs the conversion.

impl From<bool> for Literal

fn from(value: bool) -> Self

Performs the conversion.

impl From<f32> for Literal

fn from(value: f32) -> Self

Performs the conversion.

impl From<f64> for Literal

fn from(value: f64) -> Self

Performs the conversion.

impl From<i128> for Literal

fn from(value: i128) -> Self

Performs the conversion.

impl From<i16> for Literal

fn from(value: i16) -> Self

Performs the conversion.

impl From<i32> for Literal

fn from(value: i32) -> Self

Performs the conversion.

impl From<i64> for Literal

fn from(value: i64) -> Self

Performs the conversion.

impl From<u16> for Literal

fn from(value: u16) -> Self

Performs the conversion.

impl From<u32> for Literal

fn from(value: u32) -> Self

Performs the conversion.

impl From<u64> for Literal

fn from(value: u64) -> Self

Performs the conversion.

impl Hash for Literal

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Literal> for Literal

fn eq(&self, other: &Literal) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Literal) -> bool

This method tests for !=.

impl<'_> PartialEq<Literal> for LiteralRef<'_>

fn eq(&self, other: &Literal) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<LiteralRef<'_>> for Literal

fn eq(&self, other: &LiteralRef<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Literal

impl StructuralPartialEq for Literal

impl TTerm for Literal

fn kind(&self) -> TermKind

Returns the kind of this term (IRI, literal, blank node, variable).

fn value_raw(&self) -> RawValue<'_>

Return the "value" of this term, possibly split in two substrings. The second part might only be non-empty if this term is an IRI reference.

fn datatype(&self) -> Option<SimpleIri<'_>>

Return the datatype IRI of this term if it is a literal.

fn language(&self) -> Option<&str>

Return the language tag of this term if it is a language-tagged literal.

fn as_dyn(&self) -> &dyn TTerm

This method ensures that all implementations of TTerm can be turned into a trait object.

fn value(&self) -> MownStr<'_>

Return the "value" of this term, which depends on its kind: * for an IRI reference, its value; * for a literal, its lexical value; * for a blank node, its local identifier; * for a variable, its name.

fn is_absolute(&self) -> bool

All terms are absolute, except for: * relative IRI references, * literals whose datatype is a relative IRI reference.

impl TryCopyTerm for Literal

type Error = SophiaToOxigraphConversionError

The error type produced when failing to copy a given term

fn try_copy<T: ?Sized>(other: &T) -> Result<Self, Self::Error> where
    T: TTerm, 

Try to copy term into an instance of this type.