Enum Document 

pub enum Document {
    V0(DocumentV0),
}

Variants

V0(DocumentV0)

Implementations

impl Document

pub fn generate_document_id( contract_id: &Identifier, owner_id: &Identifier, document_type_name: &str, entropy: &[u8], identity_contract_nonce: IdentityNonce, platform_version: &PlatformVersion, ) -> Result<Identifier, ProtocolError>

Derives the id of a document that is about to be created.

From generate_document_id version 1 the identity contract nonce of the create transition is part of the id. A nonce is consumed at most once per identity and contract, so an id can be produced at most once: a document that was deleted can not be created again under the same id with different content, and whatever referenced the id keeps pointing at that one document or at nothing.

The id therefore only exists once the nonce of the create transition is known, and it changes if the transition is rebuilt with another nonce.

pub fn set_id_for_creation( &mut self, document_type: DocumentTypeRef<'_>, entropy: &[u8; 32], identity_contract_nonce: IdentityNonce, platform_version: &PlatformVersion, ) -> Result<(), ProtocolError>

Gives a document that is about to be created the id its create transition will carry, from the entropy and the identity contract nonce that transition is going to use.

A client that needs the id before it sends the document (to reference it from another document, or to act on it afterwards) assigns the nonce first and calls this. The create transition must then be built with the same entropy and nonce.

pub fn generate_document_id_sha256_blocks( document_type_name: &str, platform_version: &PlatformVersion, ) -> Result<u16, ProtocolError>

The number of SHA-256 blocks deriving the id takes, which is what validating the id of a create is billed for.

The entropy only id has always been billed as 2 blocks and stays so. The nonce derived id is billed by what the double SHA-256 really hashes: the padded preimage (longer than before by the domain tag and the nonce) plus the one block of the second pass over the 32 byte digest. That is 4 blocks for a document type name of up to 60 bytes and 5 beyond that.

pub fn document_id_depends_on_nonce( platform_version: &PlatformVersion, ) -> Result<bool, ProtocolError>

Whether the id of a new document depends on the identity contract nonce of its create transition. When it does, the id a document carries before its create transition is built is only a placeholder.

pub fn generate_document_id_v0( contract_id: &Identifier, owner_id: &Identifier, document_type_name: &str, entropy: &[u8], ) -> Identifier

Generates the document ID

pub fn generate_document_id_v1( contract_id: &Identifier, owner_id: &Identifier, document_type_name: &str, entropy: &[u8], identity_contract_nonce: IdentityNonce, ) -> Identifier

Generates the document ID from the entropy and the identity contract nonce of the create transition

impl Document

pub fn try_into_asset_unlock_base_transaction_info( &self, transaction_index: WithdrawalTransactionIndex, platform_version: &PlatformVersion, ) -> Result<AssetUnlockBaseTransactionInfo, ProtocolError>

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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<'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 Display for Document

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

Formats the value using the given formatter.

impl DocumentCborMethodsV0 for Document

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

where Self: Sized,

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_value(&self) -> Result<CborValue, ProtocolError>

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

Serializes the Document to CBOR.

impl DocumentFromCreateTransition for Document

fn try_from_create_transition( document_create_transition: &DocumentCreateTransition, owner_id: Identifier, block_info: &BlockInfo, contract: &DataContract, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

where Self: Sized,

Attempts to create a new Document from the given DocumentCreateTransition reference, owner_id, and additional metadata.

fn try_from_owned_create_transition( document_create_transition: DocumentCreateTransition, owner_id: Identifier, block_info: &BlockInfo, contract: &DataContract, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

where Self: Sized,

Attempts to create a new Document from the given DocumentCreateTransition instance, owner_id, and additional metadata.

impl DocumentFromCreateTransitionV0 for Document

fn try_from_owned_create_transition_v0( v0: DocumentCreateTransitionV0, owner_id: Identifier, block_info: &BlockInfo, contract: &DataContract, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

where Self: Sized,

Attempts to create a new Document from the given DocumentCreateTransitionV0 instance, incorporating additional metadata such as ownership and block information.

fn try_from_create_transition_v0( v0: &DocumentCreateTransitionV0, owner_id: Identifier, block_info: &BlockInfo, contract: &DataContract, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

where Self: Sized,

Attempts to create a new Document from the given DocumentCreateTransitionV0 reference, incorporating additional metadata like ownership and block information.

impl DocumentFromReplaceTransition for Document

fn try_from_replace_transition( document_replace_transition: &DocumentReplaceTransition, owner_id: Identifier, created_at: Option<TimestampMillis>, created_at_block_height: Option<BlockHeight>, created_at_core_block_height: Option<CoreBlockHeight>, transferred_at: Option<TimestampMillis>, transferred_at_block_height: Option<BlockHeight>, transferred_at_core_block_height: Option<CoreBlockHeight>, creator_id: Option<Identifier>, block_info: &BlockInfo, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Attempts to create a new Document from the given DocumentReplaceTransition reference, incorporating owner_id, creation metadata, and additional blockchain-related information.

fn try_from_owned_replace_transition( document_replace_transition: DocumentReplaceTransition, owner_id: Identifier, created_at: Option<TimestampMillis>, created_at_block_height: Option<BlockHeight>, created_at_core_block_height: Option<CoreBlockHeight>, transferred_at: Option<TimestampMillis>, transferred_at_block_height: Option<BlockHeight>, transferred_at_core_block_height: Option<CoreBlockHeight>, creator_id: Option<Identifier>, block_info: &BlockInfo, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Attempts to create a new Document from the given DocumentReplaceTransition instance, incorporating owner_id, creation metadata, and additional blockchain-related information.

impl DocumentFromReplaceTransitionV0 for Document

fn try_from_replace_transition_v0( value: &DocumentReplaceTransitionV0, owner_id: Identifier, created_at: Option<TimestampMillis>, created_at_block_height: Option<BlockHeight>, created_at_core_block_height: Option<CoreBlockHeight>, transferred_at: Option<TimestampMillis>, transferred_at_block_height: Option<BlockHeight>, transferred_at_core_block_height: Option<CoreBlockHeight>, creator_id: Option<Identifier>, block_info: &BlockInfo, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Attempts to create a new Document from the given DocumentReplaceTransitionV0 reference. This operation is typically used to replace or update an existing document with new information.

fn try_from_owned_replace_transition_v0( value: DocumentReplaceTransitionV0, owner_id: Identifier, created_at: Option<TimestampMillis>, created_at_block_height: Option<BlockHeight>, created_at_core_block_height: Option<CoreBlockHeight>, transferred_at: Option<TimestampMillis>, transferred_at_block_height: Option<BlockHeight>, transferred_at_core_block_height: Option<CoreBlockHeight>, creator_id: Option<Identifier>, block_info: &BlockInfo, document_type: &DocumentTypeRef<'_>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Attempts to create a new Document from the given DocumentReplaceTransitionV0 instance. This function is similar to try_from_replace_transition_v0 but consumes the DocumentReplaceTransitionV0 instance, making it suitable for scenarios where the transition is owned and should not be reused after document creation.

impl DocumentMethodsV0 for Document

fn get_raw_for_contract( &self, key: &str, document_type_name: &str, contract: &DataContract, owner_id: Option<[u8; 32]>, platform_version: &PlatformVersion, ) -> Result<Option<Vec<u8>>, ProtocolError>

Return a value given the path to its key and the document type for a contract.

fn get_raw_for_document_type( &self, key_path: &str, document_type: DocumentTypeRef<'_>, owner_id: Option<[u8; 32]>, platform_version: &PlatformVersion, ) -> Result<Option<Vec<u8>>, ProtocolError>

Return a value given the path to its key for a document type.

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

fn increment_revision(&mut self) -> Result<(), ProtocolError>

fn is_equal_ignoring_time_based_fields( &self, rhs: &Self, also_ignore_fields: Option<Vec<&str>>, platform_version: &PlatformVersion, ) -> Result<bool, ProtocolError>

Checks to see if a document is equal without time based fields. Since these fields are set on the network this function can be useful to make sure that fields that were supplied have not changed, while ignoring those that are set network side. Time based fields that are ignored are created_at/updated_at created_at_block_height/updated_at_block_height created_at_core_block_height/updated_at_core_block_height

impl DocumentPlatformConversionMethodsV0 for Document

fn serialize( &self, document_type: DocumentTypeRef<'_>, data_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 Document from it.

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

Serializes the document.

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

where Self: Sized,

Reads a serialized document and creates a Document from it. This will return a ConsensusValidationResult instead when the error is happening in consensus (deserialization of a message from the network)

impl DocumentPlatformValueMethodsV0<'_> for Document

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

Convert the document to a map value.

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

Convert the document to a map value consuming the document.

impl DocumentV0Getters for Document

fn id(&self) -> Identifier

Returns the unique document ID.

fn id_ref(&self) -> &Identifier

fn owner_id(&self) -> Identifier

Returns the ID of the document’s owner.

fn owner_id_ref(&self) -> &Identifier

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

Returns the document’s properties (data).

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

Returns a mutable reference to the document’s properties (data).

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

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

Returns the document revision.

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

Returns the time in milliseconds that the document was created.

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

Returns the time in milliseconds that the document was last updated.

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

Returns the time in milliseconds that the document was last transferred.

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

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

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

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

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

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

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

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

The data contract version this document’s bytes conform to (the serialization format 3 stamp); None for pre-stamp documents.

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

The block time at which a moderator last wrote the document’s moderator fields.

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

The moderator who last wrote the document’s moderator fields.

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 Document

fn set_id(&mut self, id: Identifier)

Sets the unique document ID.

fn set_owner_id(&mut self, owner_id: Identifier)

Sets the ID of the document’s owner.

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

Sets the document’s properties (data).

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

Sets the document revision.

fn bump_revision(&mut self)

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

Sets the time in milliseconds that the document was created.

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

Sets the time in milliseconds that the document was last updated.

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

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

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

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

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

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

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

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.

fn set_contract_version(&mut self, contract_version: Option<u32>)

Sets the contract-version stamp: the data contract version this document’s bytes conform to.

fn set_moderated_at(&mut self, moderated_at: Option<TimestampMillis>)

Sets the block time at which a moderator last wrote the document’s moderator fields.

fn set_moderated_by(&mut self, moderated_by: Option<Identifier>)

Sets the moderator who last wrote the document’s moderator fields.

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 JsonConvertible for Document

Available on crate features json-conversion and serde-conversion only.

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

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for Document

impl TryFrom<StateTransitionProofResult> for Document

type Error = TryIntoError<StateTransitionProofResult>

The type returned in the event of a conversion error.

fn try_from(value: StateTransitionProofResult) -> Result<Self, Self::Error>

Performs the conversion.

impl ValueConvertible for Document

Available on crate features serde-conversion and value-conversion only.

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

where Self: Sized,

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

where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>

where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>

where Self: Sized,