Struct ProvenanceRef 

pub struct ProvenanceRef {
    pub doi: Option<String>,
    pub pmid: Option<String>,
    pub title: Option<String>,
    pub span: Option<String>,
}

Phase β (v0.6): structured provenance reference attached to an annotation (or any future note-shaped object). At least one identifying field (doi, pmid, title) must be set when the provenance is present; an all-empty ProvenanceRef is rejected by validate_event_payload.

Fields

doi: Option<String>

pmid: Option<String>

title: Option<String>

span: Option<String>

Verbatim quote / extraction span from the source.

Implementations

impl ProvenanceRef

pub fn has_identifier(&self) -> bool

True iff at least one identifying field is set. Used by validate_event_payload to reject all-empty provenance: {} objects.

Trait Implementations

impl Clone for ProvenanceRef

fn clone(&self) -> ProvenanceRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProvenanceRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProvenanceRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProvenanceRef

fn eq(&self, other: &ProvenanceRef) -> 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 Serialize for ProvenanceRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProvenanceRef

impl StructuralPartialEq for ProvenanceRef