Struct Reference 

pub struct Reference {
    pub type: String,
    pub uri: Option<String>,
    pub name: Option<String>,
}

Represents a reference to a resource or prompt. Umbrella type for both ResourceReference and PromptReference from the spec schema.

See the schema for details

Fields

type: String

The type of content. Can be ref/resource or ref/prompt.

uri: Option<String>

The URI or URI template of the resource.

name: Option<String>

The name of the prompt or prompt template.

Implementations

impl Reference

pub fn resource(uri: &str) -> Self

Creates a ref/resource Reference

pub fn prompt(name: &str) -> Self

Creates a ref/resource Reference

pub fn validate(&self) -> Option<String>

Validates the reference object.

Example

use neva::types::Reference;
 
// valid ref/resource
let reference = Reference::resource("file://test");
assert!(reference.validate().is_none());

// valid ref/prompt
let reference = Reference::prompt("test");
assert!(reference.validate().is_none())

Trait Implementations

impl<'de> Deserialize<'de> for Reference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Reference

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

Formats the value using the given formatter.

impl Serialize for Reference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.