Struct DocumentV0 

pub struct DocumentV0 {

    pub id: Identifier,
    pub owner_id: Identifier,
    pub properties: BTreeMap<String, Value>,
    pub revision: Option<Revision>,
    pub created_at: Option<TimestampMillis>,
    pub updated_at: Option<TimestampMillis>,
    pub transferred_at: Option<TimestampMillis>,
    pub created_at_block_height: Option<BlockHeight>,
    pub updated_at_block_height: Option<BlockHeight>,
    pub transferred_at_block_height: Option<BlockHeight>,
    pub created_at_core_block_height: Option<CoreBlockHeight>,
    pub updated_at_core_block_height: Option<CoreBlockHeight>,
    pub transferred_at_core_block_height: Option<CoreBlockHeight>,
    pub creator_id: Option<Identifier>,
}

Documents contain the data that goes into data contracts.

Fields

id: Identifier

The unique document ID.

owner_id: Identifier

The ID of the document’s owner.

properties: BTreeMap<String, Value>

The document’s properties (data).

revision: Option<Revision>

The document revision, if the document is mutable.

created_at: Option<TimestampMillis>

The time in milliseconds that the document was created, if it is set as required by the document type schema.

updated_at: Option<TimestampMillis>

The time in milliseconds that the document was last updated, if it is set as required by the document type schema.

transferred_at: Option<TimestampMillis>

The time in milliseconds that the document was last transferred, if it is set as required by the document type schema.

created_at_block_height: Option<BlockHeight>

The block that the document was created, if it is set as required by the document type schema.

updated_at_block_height: Option<BlockHeight>

The block that the document was last updated, if it is set as required by the document type schema.

transferred_at_block_height: Option<BlockHeight>

The block that the document was last transferred to a new identity, if it is set as required by the document type schema.

created_at_core_block_height: Option<CoreBlockHeight>

The core block that the document was created, if it is set as required by the document type schema.

updated_at_core_block_height: Option<CoreBlockHeight>

The core block that the document was last updated, if it is set as required by the document type schema.

transferred_at_core_block_height: Option<CoreBlockHeight>

The core block that the document was last transferred to a new identity, if it is set as required by the document type schema.

creator_id: Option<Identifier>

The creator id.

Trait Implementations

impl Clone for DocumentV0

fn clone(&self) -> DocumentV0

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentV0

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

Formats the value using the given formatter.

impl Default for DocumentV0

fn default() -> DocumentV0

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentV0

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocumentV0

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

Formats the value using the given formatter.

impl DocumentCborMethodsV0 for DocumentV0

fn from_cbor( document_cbor: &[u8], document_id: Option<[u8; 32]>, owner_id: Option<[u8; 32]>, _platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Reads a CBOR-serialized document and creates a Document from it. If Document and Owner IDs are provided, they are used, otherwise they are created.

fn to_cbor(&self) -> Result<Vec<u8>, ProtocolError>

Serializes the Document to CBOR.

fn to_cbor_value(&self) -> Result<CborValue, ProtocolError>

impl DocumentJsonMethodsV0<'_> for DocumentV0

fn to_json_with_identifiers_using_bytes( &self, _platform_version: &PlatformVersion, ) -> Result<JsonValue, ProtocolError>

fn to_json( &self, _platform_version: &PlatformVersion, ) -> Result<JsonValue, ProtocolError>

fn from_json_value<S, E>( document_value: JsonValue, _platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

where for<'de> S: Deserialize<'de> + TryInto<Identifier, Error = E>, E: Into<ProtocolError>,

impl DocumentPlatformConversionMethodsV0 for DocumentV0

fn serialize( &self, document_type: DocumentTypeRef<'_>, contract: &DataContract, platform_version: &PlatformVersion, ) -> Result<Vec<u8>, ProtocolError>

Serializes the document.

The serialization of a document follows the pattern: id 32 bytes + owner_id 32 bytes + encoded values byte arrays

fn from_bytes( serialized_document: &[u8], document_type: DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Reads a serialized document and creates a DocumentV0 from it.

fn from_bytes_in_consensus( serialized_document: &[u8], document_type: DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<ConsensusValidationResult<Self>, ProtocolError>

Reads a serialized document and creates a DocumentV0 from it.

fn serialize_specific_version( &self, document_type: DocumentTypeRef<'_>, contract: &DataContract, feature_version: FeatureVersion, ) -> Result<Vec<u8>, ProtocolError>

Serializes the document.

impl DocumentPlatformValueMethodsV0<'_> for DocumentV0

fn to_map_value(&self) -> Result<BTreeMap<String, Value>, ProtocolError>

fn into_map_value(self) -> Result<BTreeMap<String, Value>, ProtocolError>

fn into_value(self) -> Result<Value, ProtocolError>

fn to_object(&self) -> Result<Value, ProtocolError>

fn from_platform_value( document_value: Value, _platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

impl DocumentV0Getters for DocumentV0

fn id(&self) -> Identifier

Returns the document’s unique identifier.

Returns

An Identifier representing the unique ID of the document.

fn owner_id(&self) -> Identifier

Returns the identifier of the document’s owner.

Returns

An Identifier representing the owner’s ID.

fn properties(&self) -> &BTreeMap<String, Value>

Provides a reference to the document’s properties.

Returns

A reference to a BTreeMap<String, Value> containing the document’s properties.

fn properties_mut(&mut self) -> &mut BTreeMap<String, Value>

Provides a mutable reference to the document’s properties.

Returns

A mutable reference to a BTreeMap<String, Value> containing the document’s properties.

fn revision(&self) -> Option<Revision>

Returns the document’s revision, if it is part of the document. The document will have this field if it’s schema has this document type as mutable.

Returns

An Option<Revision> which is Some(Revision) if the document has a revision, or None if not.

fn created_at(&self) -> Option<TimestampMillis>

Returns the timestamp of when the document was created, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<TimestampMillis> representing the creation time in milliseconds, or None if not available.

fn updated_at(&self) -> Option<TimestampMillis>

Returns the timestamp of the last update to the document, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<TimestampMillis> representing the update time in milliseconds, or None if not available.

fn transferred_at(&self) -> Option<TimestampMillis>

Returns the timestamp of the last time the document was transferred, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<TimestampMillis> representing the transferred at time in milliseconds, or None if not available.

fn id_ref(&self) -> &Identifier

Provides a reference to the document’s unique identifier.

Returns

A reference to an Identifier representing the unique ID of the document.

fn owner_id_ref(&self) -> &Identifier

Provides a reference to the document’s owner identifier.

Returns

A reference to an Identifier representing the owner’s ID.

fn properties_consumed(self) -> BTreeMap<String, Value>

Consumes the document and returns its properties.

Returns

A BTreeMap<String, Value> containing the document’s properties.

fn created_at_block_height(&self) -> Option<u64>

Returns the block height at which the document was created, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<u64> representing the creation block height, or None if not available.

fn updated_at_block_height(&self) -> Option<u64>

Returns the block height at which the document was last updated, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<u64> representing the update block height, or None if not available.

fn transferred_at_block_height(&self) -> Option<u64>

Returns the block height of the last time the document was transferred, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<u64> representing the transfer block height, or None if not available.

fn created_at_core_block_height(&self) -> Option<u32>

Returns the core network block height at which the document was created, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<u32> representing the creation core block height, or None if not available.

fn updated_at_core_block_height(&self) -> Option<u32>

Returns the core network block height at which the document was last updated, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<u32> representing the update core block height, or None if not available.

fn transferred_at_core_block_height(&self) -> Option<u32>

Returns the core network block height of the last time the document was transferred, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<u32> representing the transfer core block height, or None if not available.

fn creator_id(&self) -> Option<Identifier>

Returns the creator identifier of the document, if it is part of the document. The document will have this field if it’s schema has it set as required.

Returns

An Option<Identifier> representing the creator’s ID, or None if not available.

fn get(&self, path: &str) -> Option<&Value>

Retrieves the field specified by the path. Returns None if the path is empty or if the field is not present.

impl DocumentV0Setters for DocumentV0

fn set_id(&mut self, id: Identifier)

Sets the document’s unique identifier.

Parameters

• id: An Identifier to set as the document’s unique ID.

fn set_owner_id(&mut self, owner_id: Identifier)

Sets the identifier of the document’s owner.

Parameters

• owner_id: An Identifier to set as the document’s owner ID.

fn set_properties(&mut self, properties: BTreeMap<String, Value>)

Sets the document’s properties.

Parameters

• properties: A BTreeMap<String, Value> containing the properties to set for the document.

fn set_revision(&mut self, revision: Option<Revision>)

Sets the document’s revision. This is applicable if the document’s schema indicates the document type as mutable.

Parameters

• revision: An Option<Revision> to set as the document’s revision. None indicates the document does not have a revision.

fn bump_revision(&mut self)

Bumps the document’s revision if it has one. This is applicable if the document’s schema indicates the document type as mutable.

fn set_created_at(&mut self, created_at: Option<TimestampMillis>)

Sets the timestamp of when the document was created. This is applicable if the document’s schema requires a creation timestamp.

Parameters

• created_at: An Option<TimestampMillis> to set as the document’s creation timestamp. None indicates the timestamp is not available.

fn set_updated_at(&mut self, updated_at: Option<TimestampMillis>)

Sets the timestamp of the last update to the document. This is applicable if the document’s schema requires an update timestamp.

Parameters

• updated_at: An Option<TimestampMillis> to set as the document’s last update timestamp. None indicates the timestamp is not available.

fn set_created_at_block_height(&mut self, created_at_block_height: Option<u64>)

Sets the block height at which the document was created. This is applicable if the document’s schema requires this information.

Parameters

• created_at_block_height: An Option<u64> to set as the document’s creation block height. None indicates the block height is not available.

fn set_updated_at_block_height(&mut self, updated_at_block_height: Option<u64>)

Sets the block height at which the document was last updated. This is applicable if the document’s schema requires this information.

Parameters

• updated_at_block_height: An Option<u64> to set as the document’s last update block height. None indicates the block height is not available.

fn set_created_at_core_block_height( &mut self, created_at_core_block_height: Option<u32>, )

Sets the core network block height at which the document was created. This is applicable if the document’s schema requires this information.

Parameters

• created_at_core_block_height: An Option<u32> to set as the document’s creation core block height. None indicates the core block height is not available.

fn set_updated_at_core_block_height( &mut self, updated_at_core_block_height: Option<u32>, )

Sets the core network block height at which the document was last updated. This is applicable if the document’s schema requires this information.

Parameters

• updated_at_core_block_height: An Option<u32> to set as the document’s last update core block height. None indicates the core block height is not available.

fn set_creator_id(&mut self, creator_id: Option<Identifier>)

Sets the creator identifier of the document. This is applicable if the document’s schema requires this information.

Parameters

• creator_id: An Option<Identifier> to set as the document’s creator ID. None indicates the creator ID is not available.

fn set_transferred_at(&mut self, transferred_at: Option<TimestampMillis>)

fn set_transferred_at_block_height( &mut self, transferred_at_block_height: Option<u64>, )

fn set_transferred_at_core_block_height( &mut self, transferred_at_core_block_height: Option<u32>, )

fn set(&mut self, path: &str, value: Value)

Set the value under the given path. The path supports syntax from the lodash JS library. Example: “root.people[0].name”. If parents are not present, they will be automatically created.

fn remove(&mut self, path: &str) -> Option<Value>

Removes the value under the given path. The path supports syntax from the lodash JS library. Example: “root.people[0].name”. If parents are not present, they will be automatically created.

fn set_u8(&mut self, property_name: &str, value: u8)

Sets a u8 value for the specified property name.

fn set_i8(&mut self, property_name: &str, value: i8)

Sets an i8 value for the specified property name.

fn set_u16(&mut self, property_name: &str, value: u16)

Sets a u16 value for the specified property name.

fn set_i16(&mut self, property_name: &str, value: i16)

Sets an i16 value for the specified property name.

fn set_u32(&mut self, property_name: &str, value: u32)

Sets a u32 value for the specified property name.

fn set_i32(&mut self, property_name: &str, value: i32)

Sets an i32 value for the specified property name.

fn set_u64(&mut self, property_name: &str, value: u64)

Sets a u64 value for the specified property name.

fn set_i64(&mut self, property_name: &str, value: i64)

Sets an i64 value for the specified property name.

fn set_bytes(&mut self, property_name: &str, value: Vec<u8>)

Sets a Vec<u8> (byte array) value for the specified property name.

impl From<DocumentV0> for Document

fn from(value: DocumentV0) -> Self

Converts to this type from the input type.

impl PartialEq for DocumentV0

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocumentV0

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl JsonSafeFields for DocumentV0

impl StructuralPartialEq for DocumentV0