Struct Document

pub struct Document {
    pub last_update: Option<DateTime>,
    pub description: Option<String>,
    /* private fields */
}

TMF667 Document

Fields

last_update: Option<DateTime>

For trait HasLastUpdate

description: Option<String>

Description of document

Implementations

impl Document

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

Create a new document

Examples found in repository

examples/create_document.rs (line 9)

fn main() {
    let agreement = Agreement::new("My Aggreement");
    
    let doc = Document::new("My Document")
        .doc_type("PDF")
        .link(agreement);


    // doc.link_entity(agreement);

    dbg!(doc);
}

pub fn attachment(self, attachment: AttachmentRefOrValue) -> Document

Set the attachment for this document.

pub fn doc_type(self, type: impl Into<String>) -> Document

Set the document type

use tmflib::tmf667::document::Document;
let doc = Document::new("My Document")
    .doc_type("PDF");

Examples found in repository

examples/create_document.rs (line 10)

fn main() {
    let agreement = Agreement::new("My Aggreement");
    
    let doc = Document::new("My Document")
        .doc_type("PDF")
        .link(agreement);


    // doc.link_entity(agreement);

    dbg!(doc);
}

pub fn link<T: HasName>(self, entity: T) -> Document

Link another TMF entity during creation

Examples found in repository

examples/create_document.rs (line 11)

fn main() {
    let agreement = Agreement::new("My Aggreement");
    
    let doc = Document::new("My Document")
        .doc_type("PDF")
        .link(agreement);


    // doc.link_entity(agreement);

    dbg!(doc);
}

pub fn link_entity<T: HasName>(&mut self, entity: T)

Link another TMF entity into this document

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Document> for AttachmentRefOrValue

fn from(value: &Document) -> Self

Converts to this type from the input type.

impl From<AttachmentRefOrValue> for Document

fn from(value: AttachmentRefOrValue) -> Self

Converts to this type from the input type.

impl HasDescription for Document

fn description(self, description: impl Into<String>) -> Self

Builder pattern function to set the description on object creation

fn get_description(&self) -> String

Get the description by cloning it if set, returns empty string otherwise.

fn set_description(&mut self, description: impl Into<String>) -> Option<String>

Update the description by inserting a new value into the Option. Returns the old value if set otherwise None.

impl HasId for Document

fn generate_id(&mut self)

Generate and store a new ID. This will also regenerated the HREF field via generate_href()

fn generate_href(&mut self)

Generate a new HTML reference.

fn get_id(&self) -> String

Extract the id of this object into a new String

fn get_href(&self) -> String

Extract the HREF of this object into a new String

fn get_class() -> String

Get the class of this object. This is also used to form part of the URL via generate_href()

fn get_class_href() -> String

Get Class HREF, this represents the generate path to the class.

fn get_mod_path() -> String

Get the module path

fn set_id(&mut self, id: impl Into<String>)

Set the id on the object, also triggers generate_href().

fn id(self, id: impl Into<String>) -> Self

Builder pattern to set id on create() NB: This can be used to set an explicit id on create instead of auto-generate via [create]

fn get_uuid() -> String

Get a new UUID in simple format (no seperators)

fn create() -> Self

Create a new instance of a TMF object that has id and href fields.

impl HasLastUpdate for Document

fn set_last_update(&mut self, time: impl Into<String>)

Store a timestamp into last_update field (if available)

fn last_update(self, time: Option<String>) -> Self

Builder pattern for setting lastUpdate on create If time is None, current time is used via [‘get_timestamp()’]

fn get_timestamp() -> String

Geneate a timestamp for now(), useful for updating last_updated fields

fn create_with_time() -> Self

Create a new TMF object, also set last_update field to now()

impl HasName for Document

fn get_name(&self) -> String

Return name of object

fn set_name(&mut self, name: impl Into<String>)

Set the name, trimming any whitespace

fn name(self, name: impl Into<String>) -> Self

Builder pattern to set name on create, usually coverered by new()

fn find(&self, pattern: &str) -> bool

Match against the name

impl HasRelatedParty for Document

fn add_party(&mut self, party: RelatedParty)

Add a new party

fn get_party(&self, idx: usize) -> Option<&RelatedParty>

Get a specific party by index

fn remove_party(&mut self, idx: usize) -> Result<RelatedParty, String>

Remote a party

fn get_by_role(&self, role: String) -> Option<Vec<&RelatedParty>>

Get a list of RelatedParty entries by role

fn party(self, party: RelatedParty) -> Self

Builder pattern to add a party on create

impl Serialize for Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.