Skip to main content

Display

Display​

class Display

A typed view of an on-chain 0x2::display::Display<T> object.

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

fields()​

func fields() -> [String : String]

The display template as key/value pairs (e.g. name, link, image_url, description).

id()​

func id() -> ObjectId

The object's ID.

version()​

func version() -> UInt16

Version, bumped manually by the publisher on each update.

tryFromBcs(bytes:)​

static func tryFromBcs(bytes: Data) throws -> Display

Decode from BCS bytes, without validating the on-chain type tag.

tryFromObjectWithType(object:typeParam:)​

static func tryFromObjectWithType(object: Object, typeParam: TypeTag) throws -> Display

Decode from an on-chain object, validating its Move type tag, including that its type parameter equals type_param.