Struct Parameter 

pub struct Parameter {
    pub name: String,
    pub kind: ParamType,
    pub required: bool,
    pub default: Option<String>,
    pub summary: Option<String>,
}

One declared parameter of a SPARQL script.

Fields

name: String

The variable it binds, and the argument a run passes it as.

kind: ParamType

What its value is.

required: bool

Whether a run must pass it.

default: Option<String>

The value an absent argument takes, in its lexical form.

summary: Option<String>

What it means, for the catalog.

Implementations

impl Parameter

pub fn value(&self, lexical: &str) -> Result<Value>

Check lexical against this parameter’s type and make it a term: a typed literal in its canonical form, or an IRI. Refused with InvalidArgument naming the parameter when it is not one.

use ikigai_script::sparql::{ParamType, Parameter, Value};
let days = Parameter {
    name: "days".into(),
    kind: ParamType::Datatype("http://www.w3.org/2001/XMLSchema#integer".into()),
    required: true,
    default: None,
    summary: None,
};
match days.value("007").unwrap() {
    Value::Literal(l) => assert_eq!(l.to_string(), "\"7\"^^<http://www.w3.org/2001/XMLSchema#integer>"),
    other => panic!("{other:?}"),
}
assert!(days.value("seven").is_err());
// Whatever a string parameter holds, it is ONE literal: the serializer escapes it.
let text = Parameter { kind: ParamType::Datatype("http://www.w3.org/2001/XMLSchema#string".into()), ..days };
match text.value("\" } ; DROP ALL ; #").unwrap() {
    Value::Literal(l) => assert_eq!(l.value(), "\" } ; DROP ALL ; #"),
    other => panic!("{other:?}"),
}

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Parameter

impl PartialEq for Parameter

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Parameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameter