Struct gedcomx::Group

#[non_exhaustive]
pub struct Group {

    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 names: Vec<TextValue>,
    pub date: Option<Date>,
    pub place: Option<PlaceReference>,
    pub roles: Vec<GroupRole>,
}

A group of of persons.

The concept of a “group” captures institutional associations between persons that may or may not have direct familial relations between each other. Examples of a group could include plantations, orphanages, or military units.

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.

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.

names: Vec<TextValue>

A list of names of the group. The list must contain at least one name.

date: Option<Date>

The date of applicability of the group.

place: Option<PlaceReference>

A reference to the place applicable to this group.

roles: Vec<GroupRole>

Information about how persons were associated with the group.

Implementations

impl Group

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>,
    names: Vec<TextValue>,
    date: Option<Date>,
    place: Option<PlaceReference>,
    roles: Vec<GroupRole>
) -> Self

pub fn builder<I: Into<TextValue>>(name: I) -> GroupBuilder

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl Default for Group

fn default() -> Group

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Group

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Group> for Group

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

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

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

This method tests for !=.

impl Serialize for Group

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ Group> for EvidenceReference

type Error = GedcomxError

The type returned in the event of a conversion error.

fn try_from(f: &Group) -> Result<Self, Self::Error>

Performs the conversion.

impl YaDeserialize for Group

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

impl YaSerialize for Group

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 Group