Skip to main content

Input

Input​

class Input

An input to a user transaction

BCS

The BCS serialized form for this type is defined by the following ABNF:

input = call-arg

call-arg   =  %d00 bytes        ; Pure
=/ %d01 object-arg   ; Object

object-arg =  %d00 object-reference     ; ImmutableOrOwned
=/ %d01 object-id u64 bool   ; Shared
=/ %d02 object-reference     ; Receiving

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.

newImmutableOrOwned(objectRef:)​

static func newImmutableOrOwned(objectRef: ObjectReference) -> Input

A move object that is either immutable or address owned

newPure(value:)​

static func newPure(value: Data) -> Input

For normal operations this is required to be a move primitive type and not contain structs or objects.

newReceiving(objectRef:)​

static func newReceiving(objectRef: ObjectReference) -> Input

newShared(objectId:initialSharedVersion:mutable:)​

static func newShared(objectId: ObjectId, initialSharedVersion: Version, mutable: Bool) -> Input

A move object whose owner is "Shared"

!=(_:_:)​

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.

==(_:_:)​

static func == (self: Input, other: Input) -> Bool

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.