imag/lib/domain/libimagcontact at 61738ac9ee8c99634f2e1153cdaffdfb3e021635 - matthiasbeyer/imag

History

Matthias Beyer 3d12998603 Update dependency: toml-query: 0.6 -> 0.7		2018-09-27 15:05:44 +02:00
..
src	Refactor libimagcontact to fit new store iterator interface	2018-05-01 17:44:00 +02:00
Cargo.toml	Update dependency: toml-query: 0.6 -> 0.7	2018-09-27 15:05:44 +02:00
README.md	Add basic documentation on how the lib works	2017-10-31 19:09:43 +01:00

README.md

libimagcontacts

The contact library basically only creates references to the actual vcard files, though it also can parse (via the vobject crate) the information and return it from an entry directly.

The architecture of indirections is as follows:


+--------------------------------+
|                                |
|     Store, as ContactStore     |
|                                |
+----------------+---------------+
                 |
                 | Provides access to
                 |
+----------------v---------------+
|                                |
|   (FileLock)Entry as Contact   |
|                                |
|      which is actually a:      |
|                                |
|     (FileLock)Entry as Ref     |
|                                |
+----------------+---------------+
                 |
                 | refers to
                 |
+----------------v---------------+
|                                |
|   vcard file (outside store)   |
|                                |
+----------------+---------------+
                 |
                 | contains
                 |
+----------------v---------------+
|                                |
|            vcard data          |
|                                |
+--------------------------------+