Struct Literal 

pub struct Literal(/* private fields */);

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!(
    r#""1999-01-01"^^<http://www.w3.org/2001/XMLSchema#date>"#,
    Literal::new_typed_literal("1999-01-01", xsd::DATE).to_string()
);

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

Implementations

impl Literal

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

Builds an RDF simple literal.

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

Builds an RDF literal with a datatype.

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

Builds an RDF language-tagged string.

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

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 new_directional_language_tagged_literal( value: impl Into<String>, language: impl Into<String>, direction: impl Into<BaseDirection>, ) -> Result<Literal, LanguageTagParseError>

Builds an RDF directional language-tagged string.

pub fn new_directional_language_tagged_literal_unchecked( value: impl Into<String>, language: impl Into<String>, direction: impl Into<BaseDirection>, ) -> Literal

Builds an RDF directional 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 direction(&self) -> Option<BaseDirection>

The literal base direction if it is a directional language-tagged string.

The two possible base directions are left-to-right (ltr) and right-to-left (rtl).

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

👎Deprecated since 0.3.0:

Plain literal concept is removed in RDF 1.1

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>, Option<BaseDirection>)

Extract components from this literal (value, datatype, language tag and base direction).

Trait Implementations

impl Clone for Literal

fn clone(&self) -> Literal

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for Literal

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<Boolean> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Boolean) -> Literal

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Date> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Date) -> Literal

Converts to this type from the input type.

impl From<DateTime> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: DateTime) -> Literal

Converts to this type from the input type.

impl From<DayTimeDuration> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: DayTimeDuration) -> Literal

Converts to this type from the input type.

impl From<Decimal> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Decimal) -> Literal

Converts to this type from the input type.

impl From<Double> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Double) -> Literal

Converts to this type from the input type.

impl From<Duration> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Duration) -> Literal

Converts to this type from the input type.

impl From<Float> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Float) -> Literal

Converts to this type from the input type.

impl From<GDay> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: GDay) -> Literal

Converts to this type from the input type.

impl From<GMonth> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: GMonth) -> Literal

Converts to this type from the input type.

impl From<GMonthDay> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: GMonthDay) -> Literal

Converts to this type from the input type.

impl From<GYear> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: GYear) -> Literal

Converts to this type from the input type.

impl From<GYearMonth> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: GYearMonth) -> Literal

Converts to this type from the input type.

impl From<Integer> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Integer) -> Literal

Converts to this type from the input type.

impl From<Literal> for Expression

fn from(p: Literal) -> Self

Converts to this type from the input type.

impl From<Literal> for GroundTerm

fn from(literal: Literal) -> Self

Converts to this type from the input type.

impl From<Literal> for GroundTermPattern

fn from(literal: Literal) -> Self

Converts to this type from the input type.

impl From<Literal> for Term

fn from(literal: Literal) -> Term

Converts to this type from the input type.

impl From<Literal> for TermPattern

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>) -> Literal

Converts to this type from the input type.

impl From<String> for Literal

fn from(value: String) -> Literal

Converts to this type from the input type.

impl From<Time> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: Time) -> Literal

Converts to this type from the input type.

impl From<YearMonthDuration> for Literal

Available on crate feature oxsdatatypes only.

fn from(value: YearMonthDuration) -> Literal

Converts to this type from the input type.

impl From<bool> for Literal

fn from(value: bool) -> Literal

Converts to this type from the input type.

impl From<f32> for Literal

fn from(value: f32) -> Literal

Converts to this type from the input type.

impl From<f64> for Literal

fn from(value: f64) -> Literal

Converts to this type from the input type.

impl From<i128> for Literal

fn from(value: i128) -> Literal

Converts to this type from the input type.

impl From<i16> for Literal

fn from(value: i16) -> Literal

Converts to this type from the input type.

impl From<i32> for Literal

fn from(value: i32) -> Literal

Converts to this type from the input type.

impl From<i64> for Literal

fn from(value: i64) -> Literal

Converts to this type from the input type.

impl From<u16> for Literal

fn from(value: u16) -> Literal

Converts to this type from the input type.

impl From<u32> for Literal

fn from(value: u32) -> Literal

Converts to this type from the input type.

impl From<u64> for Literal

fn from(value: u64) -> Literal

Converts to this type from the input type.

impl FromStr for Literal

fn from_str(s: &str) -> Result<Literal, <Literal as FromStr>::Err>

Parses a literal from its NTriples serialization

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

assert_eq!(
    Literal::from_str("\"ex\\n\"")?,
    Literal::new_simple_literal("ex\n")
);
assert_eq!(
    Literal::from_str("\"ex\"@en")?,
    Literal::new_language_tagged_literal("ex", "en")?
);
assert_eq!(
    Literal::from_str("\"2020\"^^<http://www.w3.org/2001/XMLSchema#gYear>")?,
    Literal::new_typed_literal(
        "2020",
        NamedNode::new("http://www.w3.org/2001/XMLSchema#gYear")?
    )
);
assert_eq!(
    Literal::from_str("true")?,
    Literal::new_typed_literal("true", xsd::BOOLEAN)
);
assert_eq!(
    Literal::from_str("+122")?,
    Literal::new_typed_literal("+122", xsd::INTEGER)
);
assert_eq!(
    Literal::from_str("-122.23")?,
    Literal::new_typed_literal("-122.23", xsd::DECIMAL)
);
assert_eq!(
    Literal::from_str("-122e+1")?,
    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>(&self, state: &mut __H)

where __H: Hasher,

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<LiteralRef<'_>> for Literal

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Literal

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<Term> for Literal

type Error = TryFromTermError

The type returned in the event of a conversion error.

fn try_from(term: Term) -> Result<Literal, <Literal as TryFrom<Term>>::Error>

Performs the conversion.

impl Eq for Literal

impl StructuralPartialEq for Literal