object and keep it.
public entry fun create_and_keep<T: key>(pub: &iota::package::Publisher, ctx: &mut iota::tx_context::TxContext)
Implementation
public entry fun create_and_keep<T: key>(pub: &Publisher, ctx: &mut TxContext) {
transfer::public_transfer(new<T>(pub, ctx), ctx.sender())
}
## Function `update_version`
Manually bump the version and emit an event with the updated version's contents.
public entry fun update_version<T: key>(display: &mut iota::display::Display<T>)
Implementation
public entry fun update_version<T: key>(display: &mut Display<T>) {
display.version = display.version + 1;
event::emit(VersionUpdated<T> {
version: display.version,
fields: *&display.fields,
id: display.id.to_inner(),
})
}
## Function `add`
Sets a custom name field with the value.
public entry fun add<T: key>(self: &mut iota::display::Display<T>, name: std::string::String, value: std::string::String)
Implementation
public entry fun add<T: key>(self: &mut Display<T>, name: String, value: String) {
self.add_internal(name, value)
}
## Function `add_multiple`
Sets multiple fields with values.
public entry fun add_multiple<T: key>(self: &mut iota::display::Display<T>, fields: vector<std::string::String>, values: vector<std::string::String>)
Implementation
public entry fun add_multiple<T: key>(
self: &mut Display<T>,
fields: vector<String>,
values: vector<String>,
) {
let len = fields.length();
assert!(len == values.length(), EVecLengthMismatch);
let mut i = 0;
while (i < len) {
self.add_internal(fields[i], values[i]);
i = i + 1;
};
}
## Function `edit`
Change the value of the field.
TODO (long run): version changes;
public entry fun edit<T: key>(self: &mut iota::display::Display<T>, name: std::string::String, value: std::string::String)
Implementation
public entry fun edit<T: key>(self: &mut Display<T>, name: String, value: String) {
let (_, _) = self.fields.remove(&name);
self.add_internal(name, value)
}
## Function `remove`
Remove the key from the Display.
public entry fun remove<T: key>(self: &mut iota::display::Display<T>, name: std::string::String)
Implementation
public entry fun remove<T: key>(self: &mut Display<T>, name: String) {
self.fields.remove(&name);
}
## Function `is_authorized`
Authorization check; can be performed externally to implement protection rules for Display.
public fun is_authorized<T: key>(pub: &iota::package::Publisher): bool
Implementation
public fun is_authorized<T: key>(pub: &Publisher): bool {
pub.from_package<T>()
}
## Function `version`
Read the version field.
public fun version<T: key>(d: &iota::display::Display<T>): u16
Implementation
public fun version<T: key>(d: &Display<T>): u16 {
d.version
}
## Function `fields`
Read the fields field.
public fun fields<T: key>(d: &iota::display::Display<T>): &iota::vec_map::VecMap<std::string::String, std::string::String>
Implementation
public fun fields<T: key>(d: &Display<T>): &VecMap<String, String> {
&d.fields
}
## Function `create_internal`
Internal function to create a new Display<T>.
fun create_internal<T: key>(ctx: &mut iota::tx_context::TxContext): iota::display::Display<T>
Implementation
fun create_internal<T: key>(ctx: &mut TxContext): Display<T> {
let uid = object::new(ctx);
event::emit(DisplayCreated<T> {
id: uid.to_inner(),
});
Display {
id: uid,
fields: vec_map::empty(),
version: 0,
}
}
## Function `add_internal`
Private method for inserting fields without security checks.
fun add_internal<T: key>(display: &mut iota::display::Display<T>, name: std::string::String, value: std::string::String)
Implementation
fun add_internal<T: key>(display: &mut Display<T>, name: String, value: String) {
display.fields.insert(name, value)
}