One Logo Pool Ball
USDKit · IOS API REFERENCE

USDToken

struct · iOS 27.0+ · SDK 27.1

struct USDToken

Members (13)

get · iOS 27.0+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

init · iOS 27.0+

init

TypeScript
static initStringLiteral(stringLiteral: string): USDToken
Swift declaration
init(stringLiteral: String)

Creates an instance initialized to the given string value. - Parameter value: The value of the new instance.

get · iOS 27.0+

debugDescription

TypeScript
get debugDescription(): string
Swift declaration
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.

static · iOS 27.0+

isValidIdentifier

TypeScript
static isValidIdentifier(name: string, namespaced?: boolean): boolean
Swift declaration
static func isValidIdentifier(_ name: String, namespaced: Bool = false) -> Bool

Returns a Boolean value that indicates whether the given string is a valid USD identifier. - Parameters: - name: The string to evaluate. - namespaced: Pass `true` to allow the `:` namespace separator. - Returns: `true` if `name` is a valid identifier; otherwise, `false`.

init · iOS 27.0+

init

TypeScript
static initNamespaceComponents(namespaceComponents: Array<USDToken>): USDToken
Swift declaration
init(namespaceComponents: [USDToken])

Creates a namespaced token by joining `components` with `:`. - Parameter namespaceComponents: The namespace components to join.

get · iOS 27.0+

namespaceComponents

TypeScript
get namespaceComponents(): Array<USDToken>
Swift declaration
var namespaceComponents: [USDToken] { get }

The token split into its namespace components, separated by `:`.

method · iOS 27.0+

strippingNamespacePrefix

TypeScript
strippingNamespacePrefix(prefix: USDToken): (USDToken) | null
Swift declaration
func strippingNamespacePrefix(_ prefix: USDToken) -> USDToken?

Returns this token with the given namespace prefix removed. Matching is done at namespace boundaries. - Parameter prefix: The namespace prefix to strip. - Returns: The token with `prefix` removed, or `nil` if the prefix does not match.

method · iOS 27.0+

strippingLeadingNamespace

TypeScript
strippingLeadingNamespace(): USDToken
Swift declaration
func strippingLeadingNamespace() -> USDToken

Returns this token with its leading namespace component removed. - Returns: The token with its leading namespace stripped, or the empty token if no namespace component exists.

get · iOS 27.0+

string

TypeScript
get string(): string
Swift declaration
var string: String { get }
get · iOS 27.0+

isEmpty

TypeScript
get isEmpty(): boolean
Swift declaration
var isEmpty: Bool { get }
get · iOS 27.0+

valueType

TypeScript
static get valueType(): USDPrim_Attribute_ValueType
Swift declaration
static var valueType: USDPrim.Attribute.ValueType { get }
init · iOS 27.0+

init

TypeScript
static init(): USDToken
Swift declaration
init()
init · iOS 27.0+

init

TypeScript
static init36178(name: string): USDToken
Swift declaration
init(_ name: String)

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →