Struct ContractDocumentRemoval 

pub struct ContractDocumentRemoval {
    pub document_owner_id: Identifier,
    pub moderator_id: Identifier,
    pub reason: ContractModerationReason,
    pub removed_at: TimestampMillis,
    pub document_hash: [u8; 32],
    pub restoration: Option<ContractDocumentRestoration>,
    pub kept_fields: Vec<u8>,
}

The record a contract keeps of a document one of its moderators deleted.

The document itself is gone; this is what is left to say that it was removed, not lost: whose it was, who removed it, why and when, a hash of what it was, and the values of the fields its type keeps public (moderatorAbilities.deleteKeepsFields). It is stored under the contract, by document type then document id, paid for by the moderator, and never deleted. A document id commits to the nonce of its create transition and is produced at most once, so the removed id can not be created again; what can bring the document back is a moderator’s restore, within SystemLimits::contract_document_restore_window_ms of the removal, which marks the record restored and leaves it in place. A later deletion of the restored document replaces the record with a fresh one.

Fields

document_owner_id: Identifier

The identity that owned the document when it was removed.

moderator_id: Identifier

The contract owner or moderator that removed it.

reason: ContractModerationReason

Why the moderator removed it. The code is a number the moderator sets and nothing checks; the text may be empty.

removed_at: TimestampMillis

The time of the block that removed it, in milliseconds.

document_hash: [u8; 32]

A double SHA-256 of the document as it was serialized under its document type at the time of the removal (Document::serialize): what a restore must bring back, byte for byte.

restoration: Option<ContractDocumentRestoration>

Set once a moderator restored the document: it is live again, at its id, as it was.

kept_fields: Vec<u8>

The values the record keeps of the document, the fields its type lists under moderatorAbilities.deleteKeepsFields, as the record stores them: encoded as the document encodes its properties (see encode_kept_fields), so read, as a document is, under the document’s type (ContractDocumentRemoval::kept_values). What of the document stays public once it is gone. Empty on a type that lists none.

Implementations

impl ContractDocumentRemoval

pub fn is_restored(&self) -> bool

Whether the document was restored: the record then describes a removal that was undone, and the document is live again.

pub fn kept_values( &self, document_type: DocumentTypeRef<'_>, ) -> Result<BTreeMap<String, Value>, ProtocolError>

The values the record keeps, read under document_type, the removed document’s type, as its documents are: each path the type keeps to its value, a path the document held no value at left out (see decode_kept_fields). Empty when the record keeps none.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for ContractDocumentRemoval

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<'__de, __Context> BorrowDecodeUntrusted<'__de, __Context> for ContractDocumentRemoval

fn borrow_decode_untrusted<__D: BorrowUntrustedDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Borrow-decode with explicit untrusted field dispatch and resource handling.

impl Clone for ContractDocumentRemoval

fn clone(&self) -> ContractDocumentRemoval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractDocumentRemoval

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for ContractDocumentRemoval

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<__Context> DecodeUntrusted<__Context> for ContractDocumentRemoval

fn decode_untrusted<__D: UntrustedDecoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Decode with explicit untrusted field dispatch and resource handling.

impl Default for ContractDocumentRemoval

fn default() -> ContractDocumentRemoval

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractDocumentRemoval

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for ContractDocumentRemoval

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Eq for ContractDocumentRemoval

impl PartialEq for ContractDocumentRemoval

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ContractDocumentRemoval

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 ContractDocumentRemoval