Struct gedcomx::SourceReference

#[non_exhaustive]
pub struct SourceReference {
    pub description: Uri,
    pub description_id: Option<Id>,
    pub attribution: Option<Attribution>,
    pub qualifiers: Vec<Qualifier>,
}

A reference to a source description.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Uri

Reference to a description of the target source.

MUST resolve to an instance of http://gedcomx.org/v1/SourceDescription.

description_id: Option<Id>

The id of the target source.

attribution: Option<Attribution>

The attribution of this source reference.

If not provided, the attribution of the containing resource of the source reference is assumed.

qualifiers: Vec<Qualifier>

Qualifiers for the reference, used to identify specific fragments of the source that are being referenced.

If present, use of a SourceReferenceQualifier is RECOMMENDED.

Implementations

impl SourceReference

pub fn new(
    description: Uri,
    description_id: Option<Id>,
    attribution: Option<Attribution>,
    qualifiers: Vec<Qualifier>
) -> Self

pub fn builder_with_raw(description: Uri) -> SourceReferenceBuilder

pub fn builder(
    description: &SourceDescription
) -> Result<SourceReferenceBuilder>

Errors

Will return GedcomxError::NoId if a conversion into SourceReference fails. This happens if description has no id set.

Trait Implementations

impl Clone for SourceReference

fn clone(&self) -> SourceReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceReference

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

Formats the value using the given formatter.

impl Default for SourceReference

fn default() -> SourceReference

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SourceReference> for SourceReference

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for SourceReference

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ SourceDescription> for SourceReference

type Error = GedcomxError

The type returned in the event of a conversion error.

fn try_from(s: &SourceDescription) -> Result<Self, Self::Error>

Performs the conversion.

impl YaDeserialize for SourceReference

fn deserialize<R: Read>(reader: &mut Deserializer<R>) -> Result<Self, String>

impl YaSerialize for SourceReference

fn serialize<W: Write>(&self, writer: &mut Serializer<W>) -> Result<(), String>

fn serialize_attributes(
    &self,
    source_attributes: Vec<OwnedAttribute>,
    source_namespace: Namespace
) -> Result<(Vec<OwnedAttribute>, Namespace), String>

impl StructuralPartialEq for SourceReference