Struct oxrdf::Literal

pub struct Literal(_);

An owned RDF literal.

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

use oxrdf::Literal;
use oxrdf::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.

Literal::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 (value, datatype and language tag).

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<'a> From<&'a Literal> for LiteralRef<'a>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Boolean> for Literal

fn from(value: Boolean) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Date> for Literal

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<DateTime> for Literal

fn from(value: DateTime) -> Self

Converts to this type from the input type.

impl From<DayTimeDuration> for Literal

fn from(value: DayTimeDuration) -> Self

Converts to this type from the input type.

impl From<Decimal> for Literal

fn from(value: Decimal) -> Self

Converts to this type from the input type.

impl From<Double> for Literal

fn from(value: Double) -> Self

Converts to this type from the input type.

impl From<Duration> for Literal

fn from(value: Duration) -> Self

Converts to this type from the input type.

impl From<Float> for Literal

fn from(value: Float) -> Self

Converts to this type from the input type.

impl From<GDay> for Literal

fn from(value: GDay) -> Self

Converts to this type from the input type.

impl From<GMonth> for Literal

fn from(value: GMonth) -> Self

Converts to this type from the input type.

impl From<GMonthDay> for Literal

fn from(value: GMonthDay) -> Self

Converts to this type from the input type.

impl From<GYear> for Literal

fn from(value: GYear) -> Self

Converts to this type from the input type.

impl From<GYearMonth> for Literal

fn from(value: GYearMonth) -> Self

Converts to this type from the input type.

impl From<Integer> for Literal

fn from(value: Integer) -> Self

Converts to this type from the input type.

impl From<Literal> for Term

fn from(literal: Literal) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for Literal

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Time> for Literal

fn from(value: Time) -> Self

Converts to this type from the input type.

impl From<YearMonthDuration> for Literal

fn from(value: YearMonthDuration) -> Self

Converts to this type from the input type.

impl From<bool> for Literal

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Literal

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Literal

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i128> for Literal

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Literal

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Literal

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Literal

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<u16> for Literal

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Literal

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Literal

fn from(value: u64) -> Self

Converts to this type from the input type.

impl FromStr for Literal

fn from_str(s: &str) -> Result<Self, TermParseError>

Parses a literal from its NTriples or Turtle serialization

use oxrdf::{Literal, NamedNode, vocab::xsd};
use std::str::FromStr;

assert_eq!(Literal::from_str("\"ex\\n\"").unwrap(), Literal::new_simple_literal("ex\n"));
assert_eq!(Literal::from_str("\"ex\"@en").unwrap(), Literal::new_language_tagged_literal("ex", "en").unwrap());
assert_eq!(Literal::from_str("\"2020\"^^<http://www.w3.org/2001/XMLSchema#gYear>").unwrap(), Literal::new_typed_literal("2020", NamedNode::new("http://www.w3.org/2001/XMLSchema#gYear").unwrap()));
assert_eq!(Literal::from_str("true").unwrap(), Literal::new_typed_literal("true", xsd::BOOLEAN));
assert_eq!(Literal::from_str("+122").unwrap(), Literal::new_typed_literal("+122", xsd::INTEGER));
assert_eq!(Literal::from_str("-122.23").unwrap(), Literal::new_typed_literal("-122.23", xsd::DECIMAL));
assert_eq!(Literal::from_str("-122e+1").unwrap(), Literal::new_typed_literal("-122e+1", xsd::DOUBLE));

type Err = TermParseError

The associated error which can be returned from parsing.

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, Self: Sized,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Literal

impl StructuralEq for Literal

impl StructuralPartialEq for Literal