CliSubprocessCore.TransportInfo (CliSubprocessCore v0.2.0)

Copy Markdown View Source

Facade helpers for transport metadata snapshots returned by core-owned lanes.

This module lets product SDKs inspect transport status and IO contracts without importing lower runtime modules.

Summary

Functions

Returns true when term is the transport-info representation used by the core.

OS process pids are not part of the public core metadata contract.

Transport owner pids are not part of the public core metadata contract.

Returns the transport status, or nil when unavailable.

Returns the retained stderr snapshot, or an empty string when unavailable.

Returns the execution-surface kind, or nil when unavailable.

Projects transport metadata to a public map without lower runtime handles.

Types

t()

@opaque t()

Functions

match?(arg1)

@spec match?(term()) :: boolean()

Returns true when term is the transport-info representation used by the core.

os_pid(term)

@spec os_pid(term()) :: nil

OS process pids are not part of the public core metadata contract.

pid(term)

@spec pid(term()) :: nil

Transport owner pids are not part of the public core metadata contract.

status(arg1)

@spec status(term()) :: :connected | :disconnected | :error | nil

Returns the transport status, or nil when unavailable.

stderr(arg1)

@spec stderr(term()) :: String.t()

Returns the retained stderr snapshot, or an empty string when unavailable.

surface_kind(arg1)

@spec surface_kind(term()) :: atom() | nil

Returns the execution-surface kind, or nil when unavailable.

to_map(info)

@spec to_map(term()) :: map()

Projects transport metadata to a public map without lower runtime handles.

Raw transport pids, OS pids, ports, and process-owned invocation details stay behind the lower runtime boundary. Callers that need observability should use the stable surface/status/capability fields returned here.