Struct gedcomx::Gedcomx [−][src]
#[non_exhaustive]pub struct Gedcomx { pub id: Option<Id>, pub lang: Option<Lang>, pub attribution: Option<Attribution>, pub persons: Vec<Person>, pub relationships: Vec<Relationship>, pub source_descriptions: Vec<SourceDescription>, pub agents: Vec<Agent>, pub events: Vec<Event>, pub documents: Vec<Document>, pub places: Vec<PlaceDescription>, pub groups: Vec<Group>, pub description: Option<Uri>, }
Expand description
A container for a set of GEDCOM X data.
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 data set.
lang: Option<Lang>
The locale identifier for the data set.
attribution: Option<Attribution>
The attribution of this data set.
persons: Vec<Person>
The list of persons contained in the data set.
relationships: Vec<Relationship>
The list of relationships contained in the data set.
source_descriptions: Vec<SourceDescription>
The list of source descriptions contained in the data set.
agents: Vec<Agent>
The list of agents contained in the data set.
events: Vec<Event>
The list of events contained in the data set.
documents: Vec<Document>
The list of documents contained in the data set.
places: Vec<PlaceDescription>
The list of places contained in the data set.
groups: Vec<Group>
The list of groups contained in the data set.
description: Option<Uri>
Reference to the description of this data set.
If provided, MUST resolve to an instance of SourceDescription.
Implementations
impl Gedcomx
[src]
impl Gedcomx
[src]pub fn new(
id: Option<Id>,
lang: Option<Lang>,
attribution: Option<Attribution>,
persons: Vec<Person>,
relationships: Vec<Relationship>,
source_descriptions: Vec<SourceDescription>,
agents: Vec<Agent>,
events: Vec<Event>,
documents: Vec<Document>,
places: Vec<PlaceDescription>,
groups: Vec<Group>,
description: Option<Uri>
) -> Self
[src]
id: Option<Id>,
lang: Option<Lang>,
attribution: Option<Attribution>,
persons: Vec<Person>,
relationships: Vec<Relationship>,
source_descriptions: Vec<SourceDescription>,
agents: Vec<Agent>,
events: Vec<Event>,
documents: Vec<Document>,
places: Vec<PlaceDescription>,
groups: Vec<Group>,
description: Option<Uri>
) -> Self
pub fn builder() -> GedcomxBuilder
[src]
impl Gedcomx
[src]
impl Gedcomx
[src]pub fn to_json_string(&self) -> Result<String>
[src]
pub fn to_json_string(&self) -> Result<String>
[src]Serialize the instance as a string of JSON.
Errors
Returns GedcomxError::JSONError
if serialization fails.
pub fn to_json_string_pretty(&self) -> Result<String>
[src]
pub fn to_json_string_pretty(&self) -> Result<String>
[src]Serialize the instance as a string of pretty-printed JSON.
Errors
Returns GedcomxError::JSONError
if serialization fails.
pub fn to_writer_as_json<W: Write>(&self, writer: W) -> Result<()>
[src]
pub fn to_writer_as_json<W: Write>(&self, writer: W) -> Result<()>
[src]Serialize the instance as JSON into the IO stream.
Errors
Returns GedcomxError::JSONError
if serialization fails.
pub fn to_writer_as_json_pretty<W: Write>(&self, writer: W) -> Result<()>
[src]
pub fn to_writer_as_json_pretty<W: Write>(&self, writer: W) -> Result<()>
[src]Serialize the instance as pretty-printed JSON into the IO stream.
Errors
Returns GedcomxError::JSONError
if serialization fails.
pub fn from_json_str(s: &str) -> Result<Self>
[src]
pub fn from_json_str(s: &str) -> Result<Self>
[src]Deserialize an instance of the type from a string of JSON text.
Errors
Returns GedcomxError::JSONError
if deserialization fails.
pub fn from_json_reader<R: Read>(rdr: R) -> Result<Self>
[src]
pub fn from_json_reader<R: Read>(rdr: R) -> Result<Self>
[src]Deserialize an instance of the type from an IO stream of JSON.
Errors
Returns GedcomxError::JSONError
if deserialization fails.
pub fn to_xml_string(&self) -> Result<String>
[src]
pub fn to_xml_string(&self) -> Result<String>
[src]Serialize the instance as a string of XML.
Errors
Returns GedcomxError::XMLError
if serialization fails.
pub fn to_xml_string_pretty(&self) -> Result<String>
[src]
pub fn to_xml_string_pretty(&self) -> Result<String>
[src]Serialize the instance as a string of pretty-printed XML.
Errors
Returns GedcomxError::XMLError
if serialization fails.
pub fn to_writer_as_xml<W: Write>(&self, writer: W) -> Result<()>
[src]
pub fn to_writer_as_xml<W: Write>(&self, writer: W) -> Result<()>
[src]Serialize the instance as XML into the IO stream.
Errors
Returns GedcomxError::XMLError
if serialization fails.
pub fn to_writer_as_xml_pretty<W: Write>(&self, writer: W) -> Result<()>
[src]
pub fn to_writer_as_xml_pretty<W: Write>(&self, writer: W) -> Result<()>
[src]Serialize the instance as pretty-printed XML into the IO stream.
Errors
Returns GedcomxError::XMLError
if serialization fails.
pub fn from_xml_str(s: &str) -> Result<Self>
[src]
pub fn from_xml_str(s: &str) -> Result<Self>
[src]Deserialize an instance of the type from a string of XML text.
Errors
Returns GedcomxError::XMLError
if deserialization fails.
pub fn from_xml_reader<R: Read>(rdr: R) -> Result<Self>
[src]
pub fn from_xml_reader<R: Read>(rdr: R) -> Result<Self>
[src]Deserialize an instance of the type from an IO stream of XML.
Errors
Returns GedcomxError::XMLError
if deserialization fails.
Trait Implementations
impl<'de> Deserialize<'de> for Gedcomx
[src]
impl<'de> Deserialize<'de> for Gedcomx
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl YaDeserialize for Gedcomx
[src]
impl YaDeserialize for Gedcomx
[src]fn deserialize<R: Read>(reader: &mut Deserializer<R>) -> Result<Self, String>
[src]
impl YaSerialize for Gedcomx
[src]
impl YaSerialize for Gedcomx
[src]fn serialize<W: Write>(&self, writer: &mut Serializer<W>) -> Result<(), String>
[src]
fn serialize_attributes(
&self,
source_attributes: Vec<OwnedAttribute>,
source_namespace: Namespace
) -> Result<(Vec<OwnedAttribute>, Namespace), String>
[src]
&self,
source_attributes: Vec<OwnedAttribute>,
source_namespace: Namespace
) -> Result<(Vec<OwnedAttribute>, Namespace), String>
impl StructuralPartialEq for Gedcomx
[src]
Auto Trait Implementations
impl RefUnwindSafe for Gedcomx
impl Send for Gedcomx
impl Sync for Gedcomx
impl Unpin for Gedcomx
impl UnwindSafe for Gedcomx
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,