Skip to content
Open
14 changes: 13 additions & 1 deletion DOC_AUDIT_IGNORE.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ is_some: Rust std Option::is_some — appears in a third_party_skills.md example
repr: real method Call::repr / Message::repr (src/relay/call.rs) — enumerate_surface folds repr→__repr__ so the surface carries the reference's `__repr__` dunder (verified: port_surface records __repr__, not `repr`); the Rust spelling in relay/docs is the same method under its Rust name
message: real field accessor SignalWireRestError::message (src/rest/error.rs) — the Python reference's SignalWireRestError records only __init__ and exposes `message` as an instance attribute (not an enumerated method); enumerate_surface folds the Rust accessor away so both sides carry `[__init__]` and compare EQUAL. Used in examples/rest_audit_harness.rs error formatting
event_type: real field accessor RelayEvent::event_type() (src/relay/event.rs) — Python's relay events expose event_type as a payload dict field, not an enumerated method; MODULE_METHOD_DROPS folds the Rust accessor away so signalwire.relay.event classes carry only the reference's `from_payload`. Used in examples/relay_audit_harness.rs
is_final: real accessor CollectEvent::is_final() (src/relay/event.rs) — the reference dataclass field is the bare `final`; Rust cannot name a method `final` (reserved word), so the accessor is spelled `is_final` and enumerate_surface's METHOD_RENAMES folds it to `final` (wire key `params["final"]` preserved). The surface records `final`, not `is_final`, so the Rust spelling in examples/wire_relay_dump.rs fails to resolve by name. Reserved-word rename fold, Rule 2.

## Generated client-tree namespace sub-resource accessors (Rust pub-fn idiom for Python instance-attribute sub-resources)

Expand Down Expand Up @@ -196,19 +197,27 @@ section at the top of this file.
args: stdlib std::env::args
as_ref: stdlib AsRef::as_ref / Option::as_ref
current_dir: stdlib std::env::current_dir
current_exe: stdlib std::env::current_exe (the secret-scrub dump re-execs its own binary to capture the SDK Logger's real fd-2 output)
env: stdlib std::process::Command::env (set a child env var on the secret-scrub dump's re-exec)
exit: stdlib std::process::exit
from_millis: stdlib std::time::Duration::from_millis
from_secs: stdlib std::time::Duration::from_secs
from_slice: serde_json::from_slice
from_utf8: stdlib String::from_utf8
from_utf8_lossy: stdlib String::from_utf8_lossy
new: builder/constructor associated fn (AgentBase::new / AgentOptions::new / Duration::new / etc.) — the generic `new` associated-function name is not recorded as a surface method
null: stdlib std::process::Stdio::null
piped: stdlib std::process::Stdio::piped
set_hook: stdlib std::panic::set_hook (silence the panic backtrace for expected fail-loud add_verb panics in the strict-render dump)
set_var: stdlib std::env::set_var
spawn: stdlib std::thread::spawn
stderr: stdlib std::process::Command::stderr
stdin: stdlib std::process::Command::stdin
stdout: stdlib std::process::Command::stdout
to_string_pretty: serde_json::to_string_pretty
try_from: stdlib TryFrom::try_from (e.g. usize::try_from)
var: stdlib std::env::var
var_os: stdlib std::env::var_os
with_capacity: stdlib String::with_capacity / Vec::with_capacity

## External-crate / stdlib methods + serde variants (newly surfaced by the widened DOC-AUDIT)
Expand All @@ -232,6 +241,9 @@ inbound_call: test-harness free fn relay_mocktest::inbound_call (drive an inboun
scope: test-harness free fn relay_mocktest::scope (read the thread-local mock session scope; not port surface)
set_scope: test-harness free fn relay_mocktest::set_scope (set the thread-local mock session scope on a spawned pusher thread; not port surface)
sent_messages: RelayClient::sent_messages read accessor — a real port method (see PORT_ADDITIONS.md) the surface enumerator does not emit (Client method fold), referenced in the wire-relay dump example
ensure_redirect: test-harness free fn relay_mocktest::ensure_redirect (point connect() at the mock via the SIGNALWIRE_RELAY_* redirect vars; not port surface)
harness: test-harness free fn relay_mocktest::harness (resolve/spawn the shared mock_relay and read its ports; not port surface)
scope_to_client: test-harness free fn relay_mocktest::scope_to_client (bind the thread-local mock session scope to a connected client; not port surface)

## Doc-local fn definitions — language-level entry-point / helper, not port surface

Expand All @@ -240,4 +252,4 @@ language-level `fn main` entry point or a fragment-local helper), not
references to a port API.

create_agent: doc-local helper fn defined in docs/cloud_functions_guide.md (item-only fragment `fn create_agent()`), not a port symbol
main: doc-local `fn main` entry point in getting-started fragments (rest/docs + relay/docs), not a port symbol
main: doc-local `fn main` entry point in the getting-started code fragments (rest/docs + relay/docs) a Rust program entry point written inline in the example, distinct from the `Section.main` POM field the surface exposes under that bare name
Loading
Loading