Skip to main content

Module protocol

Module protocol 

Source
Expand description

Ferry Remote Build Protocol v1 data and NDJSON events.

Structs§

CleanupConfirmation
Proof that provider-owned job material was removed or deliberately retained.
IosDeviceBuildRequest
Declarative request for an official physical-iPhone build.
IosDeviceBuildResult
Provider result after a physical-iPhone build reaches a build-terminal state.
ProtocolPath
Path string paired with explicit machine and root semantics.
ProtocolVersion
Semantic version of the remote-build wire protocol.
RemoteBuildEvent
One self-contained NDJSON event envelope.
RemoteDiagnostic
Sanitized, optionally file-bound worker diagnostic.
RemoteErrorInfo
Sanitized error embedded in an operation-finished event.

Enums§

BuildProfile
Optimization profile requested from the remote worker.
DiagnosticSeverity
Normalized diagnostic severity.
IosArtifactType
Physical-iPhone artifact type requested or advertised by a provider.
JobState
Lifecycle state of one provider job.
ProtocolPathSemantics
Explicit interpretation of a path carried by the wire protocol.
RemoteBuildEventKind
Typed Ferry Remote Build Protocol v1 event payload.

Constants§

CURRENT_PROTOCOL_VERSION
Current Ferry Remote Build Protocol version.
IOS_DEVICE_RUST_TARGET
Rust target used for physical iPhone builds.
IOS_DEVICE_SDK
Xcode SDK used for physical iPhone builds.
MAX_EVENT_LINE_BYTES
Largest single NDJSON event accepted by the decoder.
REMOTE_BUILD_EVENT_TYPES
Required Ferry Remote Build Protocol v1 event names.

Functions§

canonical_git_snapshot_request_template_sha256
Return the canonical request-template SHA-256 embedded in a Git snapshot descriptor.
canonical_request_bytes
Serialize one validated iPhone build request using the protocol’s deterministic field order.
canonical_request_sha256
Return lowercase SHA-256 of canonical_request_bytes.
canonical_retry_template_sha256_v1
Return the version-1 semantic retry SHA-256 for one validated request.