Enum ContractUserModerationAction 

pub enum ContractUserModerationAction {
    Ban {
        identity_id: Identifier,
        reason: ContractModerationReason,
    },
    Unban {
        identity_id: Identifier,
    },
    Suspend {
        identity_id: Identifier,
        until: TimestampMillis,
        reason: ContractModerationReason,
    },
    Unsuspend {
        identity_id: Identifier,
    },
    Warn {
        identity_id: Identifier,
        reason: ContractModerationReason,
    },
    ClearWarnings {
        identity_id: Identifier,
    },
    DeleteDocument {
        document_type_name: String,
        document_id: Identifier,
        reason: ContractModerationReason,
    },
    RestoreDocument {
        document_type_name: String,
        document: BinaryData,
    },
    ChangeDocumentFields {
        document_type_name: String,
        document_id: Identifier,
        fields: BTreeMap<String, Value>,
        reason: ContractModerationReason,
    },
    DeleteSettledDocument {
        document_type_name: String,
        document_id: Identifier,
        reason: ContractModerationReason,
    },
    ApproveTeamAction {
        action_id: Identifier,
    },
}

What the moderator does on the contract: to one identity, or to one document.

Variants

Ban

Puts the identity on the banlist. Removes a suspension it may carry.

Fields

identity_id: Identifier

reason: ContractModerationReason

Why, stored with the banlist entry.

Unban

Takes the identity off the banlist.

Fields

identity_id: Identifier

Suspend

Puts the identity on the suspension list until until (block time, milliseconds), replacing a suspension it already carries.

Fields

identity_id: Identifier

until: TimestampMillis

reason: ContractModerationReason

Why, stored with the suspension list entry.

Unsuspend

Takes the identity off the suspension list, lapsed or not.

Fields

identity_id: Identifier

Warn

Adds a warning, with the block time and reason, to the identity’s entry on the warning list, which bars it from nothing. Refused once the entry holds SystemLimits::max_contract_warnings_per_identity warnings.

Fields

identity_id: Identifier

reason: ContractModerationReason

Why, stored with the warning.

ClearWarnings

Takes the identity off the warning list: every warning it carries goes.

Fields

identity_id: Identifier

DeleteDocument

Deletes a document of a document type that sets moderatorAbilities.delete, whoever owns it, except the contract owner and the moderators. The document’s owner gets no storage refund, and a ContractDocumentRemoval stays under the contract.

Fields

document_type_name: String

document_id: Identifier

reason: ContractModerationReason

Why, stored with the removal record.

RestoreDocument

Brings back a document a moderator deleted, as it was: the document serialized under its document type (Document::serialize), which must hash to what its removal record holds, within SystemLimits::contract_document_restore_window_ms of the removal. The document’s id, owner and content are all inside the bytes. The record stays, marked restored; the signer pays for the document’s storage, whose refund stays the owner’s.

Fields

document_type_name: String

document: BinaryData

The document as it was serialized when it was removed.

ChangeDocumentFields

Sets or removes fields of a document that only moderators write, the ones its document type lists under moderatorAbilities.changeFields, whoever owns it. Every other property, $updatedAt among them, stays as it was; $revision goes up by one, so a replace its owner built on the earlier revision is refused. The signer pays for the bytes the change adds, and a refund of the document’s storage stays the owner’s.

Fields

document_type_name: String

document_id: Identifier

fields: BTreeMap<String, Value>

Each field’s new value, by its top-level property name; null removes the field. Read from an object or JSON in its canonical form (ContractUserModerationAction::canonical_field_value), so a transition built by a client and read back signs the same bytes.

reason: ContractModerationReason

Why, checked against a seated team’s proposal like every other reason.

DeleteSettledDocument

Proposes the deletion of a settled document: one of a document type that says who must approve it (moderatorAbilities.deleteSettled), past the window its moderators delete in alone (moderatorAbilities.deleteWithin). Only a member of the contract’s seated team proposes, and the proposal is its approval. It is kept under the contract as a team action, by an id the proposer’s client computes (ContractTeamAction::settled_deletion_action_id), which the other members approve with Self::ApproveTeamAction. The approval that meets the rule, the leader among the approvals when the rule says so, deletes the document as a DeleteDocument would; a rule the proposer meets alone deletes it at once.

Fields

document_type_name: String

document_id: Identifier

reason: ContractModerationReason

Why: stored with the proposal and with the removal record the deletion leaves.

ApproveTeamAction

Approves a team action another member of the contract’s seated team proposed, by its id: what it does and why are the proposal’s.

Fields

action_id: Identifier

Implementations

impl ContractUserModerationAction

pub fn canonical_field_value(value: Value) -> Value

A field value in the one form its content has, the form clients build a change’s fields in: an integer as a U64, or an I64 when negative (U128 and I128 beyond them), 32 bytes as an Identifier and any other binary value as Bytes, maps and arrays recursively. The signed bytes carry the variant, which an object or JSON form loses (a JavaScript bigint reads back as the signed width, an identifier as plain bytes), so the fields are read back in this form and built in it.

pub fn identity_id(&self) -> Option<Identifier>

The identity the action targets. None for a document deletion: it names a document, and whose it is is only known once the document is read.

pub fn document(&self) -> Option<(&str, Identifier)>

The document a deletion targets, as its document type name and its id. None for an action on an identity, for a field change (Self::changed_document), for the approval of a settled document’s deletion (Self::settled_document), and for a restore, which carries the document itself: its id is only known once the bytes are decoded under the document type.

pub fn settled_document( &self, ) -> Option<(&str, Identifier, &ContractModerationReason)>

The settled document whose deletion a proposal targets, as its document type name and its id, with the reason. None for every other action.

pub fn approved_team_action(&self) -> Option<Identifier>

The team action an approval approves, by its id. None for every other action.

pub fn restored_document(&self) -> Option<(&str, &[u8])>

The document a restore brings back, as its document type name and its serialized bytes. None for every other action.

pub fn changed_document( &self, ) -> Option<(&str, Identifier, &BTreeMap<String, Value>)>

The document a field change targets, as its document type name and its id, with the fields it sets (a null value removes one). None for every other action.

pub fn document_type_name(&self) -> Option<&str>

The document type name a deletion, a restore, a field change or the approval of a settled document’s deletion names, None for an action on an identity.

pub fn until(&self) -> Option<TimestampMillis>

The suspension end for a suspend, None otherwise.

pub fn reason(&self) -> Option<&ContractModerationReason>

The reason a ban, a suspend, a warn, a document deletion, a field change or the approval of a settled document’s deletion carries, None for an action that takes an identity off a list, and for a restore.

pub fn name(&self) -> &'static str

The action’s name on the wire.

Trait Implementations

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

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 ContractUserModerationAction

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 ContractUserModerationAction

fn clone(&self) -> ContractUserModerationAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractUserModerationAction

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for ContractUserModerationAction

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 ContractUserModerationAction

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 ContractUserModerationAction

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractUserModerationAction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ContractUserModerationAction

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

Formats the value using the given formatter.

impl Encode for ContractUserModerationAction

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

Encode a given type.

impl JsonSafeFields for ContractUserModerationAction

Available on crate feature json-conversion only.

impl PartialEq for ContractUserModerationAction

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ContractUserModerationAction

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 ContractUserModerationAction