Struct Individual

Source

pub struct Individual {Show 19 fields
    pub id: Option<String>,
    pub href: Option<String>,
    pub aristocratic_title: Option<String>,
    pub birth_date: Option<DateTime>,
    pub full_name: Option<String>,
    pub gender: Option<String>,
    pub generation: Option<String>,
    pub given_name: Option<String>,
    pub legal_name: Option<String>,
    pub location: Option<String>,
    pub marital_status: Option<String>,
    pub middle_name: Option<String>,
    pub nationality: Option<String>,
    pub place_of_birth: Option<String>,
    pub preferred_given_name: Option<String>,
    pub title: Option<String>,
    pub contact_medium: Option<Vec<ContactMedium>>,
    pub related_party: Option<Vec<RelatedParty>>,
    pub party_characteristic: Option<Vec<Characteristic>>,
    /* private fields */
}

Expand description

An individual

Fields§

§id: Option<String>

Unique id for this individual

§href: Option<String>

HTML reference for this individual object

§aristocratic_title: Option<String>

Aristocratic Title, e.g. Lord, Lady, Count

§birth_date: Option<DateTime>

Date of Birth

§full_name: Option<String>

Full name of the individual

§gender: Option<String>

Gender

§generation: Option<String>

Generation

§given_name: Option<String>

Given Name

§legal_name: Option<String>

Legal Name

§location: Option<String>

Location

§marital_status: Option<String>

Marital Status

§middle_name: Option<String>

Middle Name

§nationality: Option<String>

Nationality

§place_of_birth: Option<String>

Birth Place

§preferred_given_name: Option<String>

Preferred Given Name

§title: Option<String>

Title, e.g.Mr, Mrs etc

§contact_medium: Option<Vec<ContactMedium>>

Methods for contacting this individual

§related_party: Option<Vec<RelatedParty>>

Parties related to this individual, e.g. company / organization

§party_characteristic: Option<Vec<Characteristic>>

Party Characteristics

Implementations§

Source §

impl Individual

Source

pub fn new(name: impl Into<String>) -> Individual

Create a new instance of indiviudal object

Examples found in repository ?

examples/create_individual_event.rs (line 10)

9fn main() {
10    let individual = Individual::new("John Quincy Smith");
11
12    let event = individual.to_event(IndividualEventType::IndividualCreateEvent);
13
14    dbg!(event);
15}

More examples

Hide additional examples

examples/create_individual.rs (line 9)

8fn main() {
9    let individual = Individual::new("John Bagford Smith")
10        .email("john.smith@example.com")
11        .mobile("0411 111 111")
12        .title("Mr")
13        .preferred("Baggie");
14
15    dbg!(individual);
16}

examples/create_permission.rs (line 16)

13fn main() {
14    #[cfg(all(feature = "tmf672", feature = "build-V4"))]
15    {
16        let user = Individual::new("A User");
17        let perm = Permission::new(RelatedParty::from(&user)).desc("A Description");
18
19        dbg!(perm);
20    }
21}

examples/create_party_role.rs (line 21)

20fn main() {
21    let individual = Individual::new("John Smith");
22    let organisation = Organization::new("A Customer".to_string());
23    let customer = Customer::new(organisation);
24    let mut role = PartyRole::new("Account Manager", RelatedParty::from(&individual));
25    role.add_party(RelatedParty::from(&customer));
26    dbg!(role);
27}

examples/convert_to_ref.rs (line 14)

10fn main() {
11    // Create a value of type i32
12    let cat = Category::new("Example Category");
13    let catalog = Catalog::new("Example Catalog");
14    let individual = Individual::new("Example Individual");
15
16    let cat_ref = cat.as_ref();
17    let catalog_ref = catalog.as_ref();
18    let individual_ref = individual.as_ref();
19
20    dbg!(cat_ref);
21    dbg!(catalog_ref);
22    dbg!(individual_ref);
23}

examples/create_message.rs (line 15)

12fn main() {
13    #[cfg(all(feature = "tmf681", feature = "build-V4"))]
14    {
15        let from = Individual::new("John Smith");
16        let to1 = Individual::new("Suzy Citizen");
17        let to2 = Individual::new("Ryan Ruckley").email("rruckley@gmail.com");
18
19        let message = CommunicationMessage::email("A Subject", "Some Content")
20            .from(&from)
21            .to(vec![&to1, &to2]);
22
23        dbg!(message);
24    }
25}

Additional examples can be found in:

Source

pub fn email(self, email: &str) -> Individual

Convenience function to add an email contact medium

§Example

use tmflib::tmf632::individual_v4::Individual;

let individual = Individual::new("John Smith")
    .email("john.smith@example.com");

Examples found in repository ?

examples/create_individual.rs (line 10)

8fn main() {
9    let individual = Individual::new("John Bagford Smith")
10        .email("john.smith@example.com")
11        .mobile("0411 111 111")
12        .title("Mr")
13        .preferred("Baggie");
14
15    dbg!(individual);
16}

More examples

Hide additional examples

examples/create_message.rs (line 17)

12fn main() {
13    #[cfg(all(feature = "tmf681", feature = "build-V4"))]
14    {
15        let from = Individual::new("John Smith");
16        let to1 = Individual::new("Suzy Citizen");
17        let to2 = Individual::new("Ryan Ruckley").email("rruckley@gmail.com");
18
19        let message = CommunicationMessage::email("A Subject", "Some Content")
20            .from(&from)
21            .to(vec![&to1, &to2]);
22
23        dbg!(message);
24    }
25}

examples/create_shopping_cart.rs (line 28)

21fn main() {
22    #[cfg(all(feature = "tmf663", feature = "build-V4"))]
23    {
24        let mut cart = ShoppingCart::new();
25        let offer = ProductOffering::new("MyProductOffer");
26        let por = ProductOfferingRef::from(offer);
27        let individual = Individual::new("John Smith")
28            .email("john.smith@example.com")
29            .mobile("0411 111 111");
30        let note1 = Note::from("Checking on stock levels");
31
32        let mut item = CartItem::from(por);
33        item.add_note(note1);
34        cart.add_item(item);
35        cart.add_party(RelatedParty::from(&individual));
36
37        dbg!(cart);
38    }
39}

examples/cart_to_order.rs (line 32)

26fn main() {
27    #[cfg(all(feature = "tmf663", feature = "build-V4"))]
28    {
29        let mut cart = ShoppingCart::new();
30        let offer = ProductOffering::new("MyProductOffer");
31        let individual = Individual::new("John Smith")
32            .email("john.smith@example.com")
33            .mobile("0411 111 111");
34        let note1 = Note::from("Checking on stock levels");
35
36        let mut item = CartItem::from(ProductOfferingRef::from(offer));
37        item.add_note(note1);
38        item.quantity = 11;
39        cart.add_item(item);
40        cart.add_party(RelatedParty::from(&individual));
41
42        let order = ProductOrder::from(cart);
43
44        dbg!(order);
45    }
46}

Source

pub fn title(self, title: impl Into<String>) -> Individual

Convenience function to set the title for an individual

§Example

use tmflib::tmf632::individual_v4::Individual;

let individual = Individual::new("John Smith")
    .title("Mr");

Examples found in repository ?

examples/create_individual.rs (line 12)

8fn main() {
9    let individual = Individual::new("John Bagford Smith")
10        .email("john.smith@example.com")
11        .mobile("0411 111 111")
12        .title("Mr")
13        .preferred("Baggie");
14
15    dbg!(individual);
16}

Source

pub fn gender(self, gender: impl Into<String>) -> Individual

Convenience function to set the gender for an individual

§Example

use tmflib::tmf632::individual_v4::Individual;

let individual = Individual::new("John Smith")
    .gender("Unspecified");

Source

pub fn preferred(self, preferred: impl Into<String>) -> Individual

Convenience function to set the preferred given name for an individual

§Example

use tmflib::tmf632::individual_v4::Individual;

let individual = Individual::new("John Smith")
    .gender("Unspecified");

Examples found in repository ?

examples/create_individual.rs (line 13)

8fn main() {
9    let individual = Individual::new("John Bagford Smith")
10        .email("john.smith@example.com")
11        .mobile("0411 111 111")
12        .title("Mr")
13        .preferred("Baggie");
14
15    dbg!(individual);
16}

Source

pub fn mobile(self, mobile: &str) -> Individual

Convenience funciton to add a mobile number contact medium

§Example

use tmflib::tmf632::individual_v4::Individual;

let individual = Individual::new("John Smith")
    .mobile("0411 111 111");

Examples found in repository ?

examples/create_individual.rs (line 11)

8fn main() {
9    let individual = Individual::new("John Bagford Smith")
10        .email("john.smith@example.com")
11        .mobile("0411 111 111")
12        .title("Mr")
13        .preferred("Baggie");
14
15    dbg!(individual);
16}

More examples

Hide additional examples

examples/create_shopping_cart.rs (line 29)

21fn main() {
22    #[cfg(all(feature = "tmf663", feature = "build-V4"))]
23    {
24        let mut cart = ShoppingCart::new();
25        let offer = ProductOffering::new("MyProductOffer");
26        let por = ProductOfferingRef::from(offer);
27        let individual = Individual::new("John Smith")
28            .email("john.smith@example.com")
29            .mobile("0411 111 111");
30        let note1 = Note::from("Checking on stock levels");
31
32        let mut item = CartItem::from(por);
33        item.add_note(note1);
34        cart.add_item(item);
35        cart.add_party(RelatedParty::from(&individual));
36
37        dbg!(cart);
38    }
39}

examples/cart_to_order.rs (line 33)

26fn main() {
27    #[cfg(all(feature = "tmf663", feature = "build-V4"))]
28    {
29        let mut cart = ShoppingCart::new();
30        let offer = ProductOffering::new("MyProductOffer");
31        let individual = Individual::new("John Smith")
32            .email("john.smith@example.com")
33            .mobile("0411 111 111");
34        let note1 = Note::from("Checking on stock levels");
35
36        let mut item = CartItem::from(ProductOfferingRef::from(offer));
37        item.add_note(note1);
38        item.quantity = 11;
39        cart.add_item(item);
40        cart.add_party(RelatedParty::from(&individual));
41
42        let order = ProductOrder::from(cart);
43
44        dbg!(order);
45    }
46}

Source

pub fn add_contact(&mut self, medium: ContactMedium)

Add a contact medium to the individual

Examples found in repository ?

examples/create_product_order.rs (line 36)

28fn main() {
29    #[cfg(all(feature = "tmf622", feature = "build-V4"))]
30    {
31        // This example simple creates in memory structures without reference to any persistence
32        let offer = ProductOffering::new("Sample Offering");
33        let org = Organization::new("ACustomer");
34        let customer = Customer::new(org);
35        let mut person = Individual::new("John Smith");
36        person.add_contact(ContactMedium::email("John.Smith@example.com"));
37        let mut order = ProductOrder::new();
38        order.add_order_item(ProductOrderItem::from(offer));
39        order.add_party(RelatedParty::from(&customer));
40        order.add_party(RelatedParty::from(&person));
41        dbg!(order);
42    }
43}