One Logo Pool Ball
App Frameworks · IOS API REFERENCE

Distributed

Build systems that run distributed code across multiple processes and devices.

26 types

32 callable entries

24 skipped

57% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

Functions and constants

get · iOS 16.0+

effectiveLabel

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

The effective label of this argument. This reflects the semantics of call sites of function declarations without explicit label definitions in Swift. For example, for a method declared like `func hi(a: String)` the effective label is `a` while for a method like `func hi(a b: String)` or `func hi(_ b: String)` the label is the explicitly declared one, so `a` and `_` respectively.

get · iOS 16.0+

name

TypeScript
get name(): string
Swift declaration
let name: String

The internal name of parameter this argument is accessible as in the function body. It is not part of the functions API and may change without breaking the target identifier. If the method did not declare an explicit `label`, it is used as the `effectiveLabel`.

init · iOS 16.0+

init

TypeScript
static init(label: (string) | null, name: string, value: unknown): RemoteCallArgument<unknown>
Swift declaration
init(label: String?, name: String, value: Value)
get · iOS 16.0+

label

TypeScript
get label(): (string) | null
Swift declaration
let label: String?

The "argument label" of the argument. The label is the name visible name used in external calls made to this target, e.g. for `func hello(label name: String)` it is `label`. If no label is specified (i.e. `func hi(name: String)`), the `label`, value is empty, however `effectiveLabel` is equal to the `name`. In most situations, using `effectiveLabel` is more useful to identify the user-visible name of this argument.

get · iOS 16.0+

value

TypeScript
get value(): unknown
Swift declaration
let value: Value

The value of the argument being passed to the call. As `RemoteCallArgument` is always used in conjunction with `recordArgument` and populated by the compiler, this Value will generally conform to a distributed actor system's `SerializationRequirement`.

Skipped declarations

24 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

DistributedActor.whenLocal(_:)

This protocol needs associated types that cannot yet cross the bridge.

DistributedActor.asLocalActor

The iOS SDK compiler rejected this binding: distributed actor-isolated property 'asLocalActor' can not be accessed from a nonisolated context

DistributedActorSystem.executeDistributedTarget(on:target:invocationDecoder:handler:)

This declaration needs Swift generic type arguments. (no canonical witness for Act)

DistributedActorCodingError.missingActorSystemUserInfo(_:)

Passing a Swift type itself is not supported.

DistributedActor.assumeIsolated(_:file:line:)

This protocol needs associated types that cannot yet cross the bridge.

buildDefaultDistributedRemoteActorExecutor(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Act)

LocalTestingDistributedActorSystem.resolve(id:as:)

Passing a Swift type itself is not supported.

LocalTestingDistributedActorSystem.assignID(_:)

Passing a Swift type itself is not supported.

LocalTestingDistributedActorSystem.actorReady(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Act)

LocalTestingDistributedActorSystem.remoteCall(on:target:invocation:throwing:returning:)

This declaration needs Swift generic type arguments. (no canonical witness for Act)

LocalTestingDistributedActorSystem.remoteCallVoid(on:target:invocation:throwing:)

This declaration needs Swift generic type arguments. (no canonical witness for Act)

LocalTestingDistributedActorSystem.invokeHandlerOnReturn(handler:resultBuffer:metatype:)

Passing a Swift type itself is not supported.

LocalTestingInvocationEncoder.recordGenericSubstitution(_:)

Passing a Swift type itself is not supported.

LocalTestingInvocationEncoder.recordErrorType(_:)

Passing a Swift type itself is not supported.

LocalTestingInvocationDecoder.decodeGenericSubstitutions()

Passing a Swift type itself is not supported.

LocalTestingInvocationDecoder.decodeErrorType()

Passing a Swift type itself is not supported.

LocalTestingInvocationDecoder.decodeReturnType()

Passing a Swift type itself is not supported.

CodingUserInfoKey.actorSystemKey

The containing type is outside the generated SDK type index.

protocol implementation DistributedActor

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation DistributedActorSystem

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation DistributedTargetInvocationEncoder

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation DistributedTargetInvocationDecoder

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation DistributedTargetInvocationResultHandler

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation DistributedActorSystemError

inherited protocol graph unavailable