ToolArgument

Swift

Python Unavailable
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go Unavailable
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift

struct ToolArgument : struct ToolArgument struct [source] ¶ struct [source] ¶ struct ToolArgument

Bases:

One argument of a tool, in enough detail to generate its schema.

The schema and the reader are generated from the same declaration, which is what keeps a documented argument from being one the tool cannot actually receive.

Members

!=(_:_:)

!=(_:_:) ( lhs : Self , rhs : Self ) → Bool functionstatic ¶ functionstatic ¶ !=(_:_:)

Inherited from Equatable.!=(_:_:)

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.

Kind

Kind : enum Kind enum [source] ¶ enum [source] ¶ Kind

name

name : let name: String property [source] ¶ property [source] ¶ name

summary

summary : let summary: String property [source] ¶ property [source] ¶ summary

kind

kind : let kind: Kind property [source] ¶ property [source] ¶ kind

isRequired

isRequired : let isRequired: Bool property [source] ¶ property [source] ¶ isRequired

allowed

allowed : let allowed: [String] property [source] ¶ property [source] ¶ allowed: The only values accepted, when there is a fixed set. Reaches the schema as enum, so a client can offer them rather than guess.

defaultValue

defaultValue : let defaultValue: JSONValue? property [source] ¶ property [source] ¶ defaultValue: What the tool does when the argument is omitted, stated in the schema so a caller need not send it to find out.

minimum

minimum : let minimum: Double? property [source] ¶ property [source] ¶ minimum: Inclusive numeric bounds, enforced by the reader and published in the schema.

maximum

maximum : let maximum: Double? property [source] ¶ property [source] ¶ maximum

maximumItems

maximumItems : let maximumItems: Int? property [source] ¶ property [source] ¶ maximumItems: The most entries accepted in an array argument.

minimumItems

minimumItems : let minimumItems: Int? property [source] ¶ property [source] ¶ minimumItems: The fewest entries accepted in an array argument.

maximumLength

maximumLength : let maximumLength: Int? property [source] ¶ property [source] ¶ maximumLength: The most characters accepted in a string argument.

maximumUTF8Bytes

maximumUTF8Bytes : let maximumUTF8Bytes: Int? property [source] ¶ property [source] ¶ maximumUTF8Bytes: A byte ceiling disclosed explicitly because JSON Schema maxLength counts characters.

pattern

pattern : let pattern: String? property [source] ¶ property [source] ¶ pattern: A JSON Schema pattern applied before the value reaches tmux.

itemSchema

itemSchema : let itemSchema: JSONValue? property [source] ¶ property [source] ¶ itemSchema: The schema for each entry when an array contains structured values.

tmuxFormatControl

tmuxFormatControl : let tmuxFormatControl: TmuxFormatControl? property [source] ¶ property [source] ¶ tmuxFormatControl: The exact control applied before this value reaches tmux format expansion.