Struct gedcomx::Relationship [−][src]
#[non_exhaustive]pub struct Relationship {}Show fields
pub id: Option<Id>, pub lang: Option<Lang>, pub sources: Vec<SourceReference>, pub analysis: Option<ResourceReference>, pub notes: Vec<Note>, pub confidence: Option<ConfidenceLevel>, pub attribution: Option<Attribution>, pub extracted: Option<bool>, pub evidence: Vec<EvidenceReference>, pub media: Vec<SourceReference>, pub identifiers: Vec<Identifier>, pub relationship_type: Option<RelationshipType>, pub person1: ResourceReference, pub person2: ResourceReference, pub facts: Vec<Fact>,
Expand description
A relationship between two persons.
Note: When a relationship type implies direction, the relationship is said to be from person1 to person2. For example, in a parent-child relationship, the relationship is said to be “from a parent to a child”; therefore, the person1 property refers to the parent and the person2 property refers to the child.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Option<Id>
An identifier for the conclusion data. The id is to be used as a “fragment identifier” as defined by RFC 3986, Section 3.5.
lang: Option<Lang>
The locale identifier for the conclusion.
sources: Vec<SourceReference>
The list of references to the sources of related to this conclusion.
Note that the sources referenced from conclusions are also considered
to be sources of the entities that contain them. For example, a source
associated with the Name
of a Person
is also source for the
Person
.
analysis: Option<ResourceReference>
A reference to the analysis document explaining the analysis that went into this conclusion. If provided, MUST resolve to an instance of Document of type Analysis.
notes: Vec<Note>
A list of notes about this conclusion.
confidence: Option<ConfidenceLevel>
The level of confidence the contributor has about the data.
attribution: Option<Attribution>
The attribution of this conclusion. If not provided, the attribution of the containing data set (e.g. file) of the conclusion is assumed.
extracted: Option<bool>
Whether this subject is to be constrained as an extracted conclusion.
evidence: Vec<EvidenceReference>
References to other subjects that support this subject.
If provided, each reference MUST resolve to an instance of subject of the same type as this instance (e.g., if the subject is an instance of Person, all of its evidence references must resolve to instances of Person).
media: Vec<SourceReference>
References to multimedia resources for this subject, such as photos or videos, intended to provide additional context or illustration for the subject and not considered evidence supporting the identity of the subject or its supporting conclusions.
Media references SHOULD be ordered by priority such that applications that wish to display a single media item (such as an image) MAY choose the first applicable media reference. Note that the SourceReference is used for multimedia references and therefore MUST resolve to a SourceDescription of the resource, which in turn provides a reference to the resource itself.
identifiers: Vec<Identifier>
A list of identifiers for the subject.
relationship_type: Option<RelationshipType>
The type of the relationship.
person1: ResourceReference
Reference to the first person in the relationship.
MUST resolve to an instance of http://gedcomx.org/v1/Person.
person2: ResourceReference
Reference to the second person in the relationship.
MUST resolve to an instance of http://gedcomx.org/v1/Person.
facts: Vec<Fact>
The facts about the relationship.
Implementations
pub fn new(
id: Option<Id>,
lang: Option<Lang>,
sources: Vec<SourceReference>,
analysis: Option<ResourceReference>,
notes: Vec<Note>,
confidence: Option<ConfidenceLevel>,
attribution: Option<Attribution>,
extracted: Option<bool>,
evidence: Vec<EvidenceReference>,
media: Vec<SourceReference>,
identifiers: Vec<Identifier>,
relationship_type: Option<RelationshipType>,
person1: ResourceReference,
person2: ResourceReference,
facts: Vec<Fact>
) -> Self
Errors
Will return GedcomxError::NoId
if a
conversion into ResourceReference
fails.
This happens if either person1
or person2
has no id
set.
Trait Implementations
Returns the “default value” for a type. Read more
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
type Error = GedcomxError
type Error = GedcomxError
The type returned in the event of a conversion error.
Performs the conversion.
fn serialize_attributes(
&self,
source_attributes: Vec<OwnedAttribute>,
source_namespace: Namespace
) -> Result<(Vec<OwnedAttribute>, Namespace), String>
Auto Trait Implementations
impl RefUnwindSafe for Relationship
impl Send for Relationship
impl Sync for Relationship
impl Unpin for Relationship
impl UnwindSafe for Relationship
Blanket Implementations
Mutably borrows from an owned value. Read more