Struct UpdateMetadataIntentData 

pub struct UpdateMetadataIntentData {
    pub field_name: String,
    pub field_value: String,
    pub expected_field_value: Option<String>,
}

A metadata update. Its values can hold the commit-log signer’s private key as hex, so they are wiped on drop and Debug shows only the field name.

Fields

field_name: String

field_value: String

expected_field_value: Option<String>

Compare-and-swap guard. When set, publishing abandons this intent unless the field’s currently committed value still equals this. None keeps the historical last-writer-wins behavior.

Implementations

impl UpdateMetadataIntentData

pub fn new(field_name: String, field_value: String) -> Self

pub fn new_guarded( field_name: String, field_value: String, expected_field_value: String, ) -> Self

A guarded update: publishing abandons the intent (marking it [xmtp_db::group_intent::IntentState::Superseded]) unless the committed value still equals expected_field_value.

pub fn new_update_group_name(group_name: String) -> Self

pub fn new_update_group_image_url_square(group_image_url_square: String) -> Self

pub fn new_update_group_description(group_description: String) -> Self

pub fn new_update_app_data( app_data: String, expected_app_data: Option<String>, ) -> Self

pub fn new_update_conversation_message_disappear_from_ns(from_ns: i64) -> Self

pub fn new_update_conversation_message_disappear_in_ns(in_ns: i64) -> Self

pub fn new_update_group_min_version_to_match_self(min_version: String) -> Self

pub fn new_update_commit_log_signer(commit_log_signer: Secret) -> Self

Trait Implementations

impl Clone for UpdateMetadataIntentData

fn clone(&self) -> UpdateMetadataIntentData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateMetadataIntentData

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

Formats the value using the given formatter.

impl Drop for UpdateMetadataIntentData

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<UpdateMetadataIntentData> for Vec<u8>

The returned bytes are the stored intent. The values move into a proto temporary that is wiped after encoding.

fn from(intent: UpdateMetadataIntentData) -> Self

Converts to this type from the input type.

impl TryFrom<Vec<u8>> for UpdateMetadataIntentData

fn try_from(data: Vec<u8>) -> Result<Self, Self::Error>

Decodes a stored intent. The input is wiped, and the values move out of the decoded proto.

type Error = IntentError

The type returned in the event of a conversion error.