Softanza
StartFrançais
Softanza
StartFrançais
Reference · Systems & runtime

System programming

76 functions in 35 classes, grouped by what they do, each with the explanation the library gives of itself.

The story of this area, for a general reader: what a crafter does with it, an example run and its rated lanes, is on its Platform page.

The functions, by what they do

Testing and checking

  • IsDeclared A declared profile is any scope that is NOT the live machine. in stzSystemProfile
  • IsAndroid os family checks in stzOperatingSystem
  • IsDesktop os family checks in stzOperatingSystem
  • IsUnixLike os family checks in stzOperatingSystem
  • IsMicrosoft os family checks in stzOperatingSystem
  • HasSecretAuth the site holds a secret (directly, or by name in a store) rather than a ref. in stzDeploymentSite
  • HasChild TRUE if this object is managing a spawned child. in stzProcess
  • IsBigEndian is the single source) in stzProcess
  • IsLittleEndian 0 = little-endian, 1 = big-endian. in stzProcess
  • Can Does the actor hold this capability kind? in stzSystemActor
  • IsEffectful The one that decides whether a plan may cross: can this actor cause effects at all? in stzSystemActor
  • HasVar TRUE if the variable is set (even to an empty string is reported as unset by the OS get, which returns "" for both -- so Has means "get returns a non-empty value"). in stzEnvironment

Counting and measuring

Replacing and setting

  • SetReturnType return type control in stzSystemCall
  • SetWorld == 1. GENERATION ======================================================== SET the world this platform envelopes -- by HARVESTING its declarations into the platform's own records, right now. It does NOT hold the world: Haro copies an object into an attribute, so a held stzApp would be a dead snapshot the moment the caller touched it (see the aliasing note in the header). Call this AFTER the world is declared. The world is ASKED through its own accessors -- a platform never reaches into another object's attributes. (A constellation ADDs many worlds; a platform SETs its one.) in stzPlatform
  • SetProfile A stzPlatformProfile DESCRIBES the solution -- its constituents (a server, a superapp, an app, ...) and their target systems. The platform OWNS one and drives its lifecycle: Build() the platform and its constituents, THEN Deploy() them -- two separate, ordered operations. (SetProfile snapshots the profile, so configure it fully first -- the aliasing doctrine.) in stzPlatform
  • SetKdfRounds Tune the KDF cost. Default 100k; lower ONLY in tests. Must be set before RegisterIdentity (a stored hash is bound to the rounds used). in stzPlatform
  • SetKind the access config (Q-fluent: chainable via the ...Q suffix) in stzDeploymentSite
  • SetAuthRef auth is EITHER a plain reference string (e.g. "env/DEPLOY_KEY", back-compat) OR a stzSecret. When it is a secret, the site stores the OBJECT and displays only its redacted descriptor -- the key never lands in Config/ConfigJson. in stzDeploymentSite
  • SetCapacity what the host PROVIDES (its capacity). For a real host it is discovered via the provider API; for a fixed host it is declared here. in stzDeploymentSite
  • SetProvider name a provisioning provider -> this host can be CREATED/resized to meet a requirement (IaC-style), not just deployed to. in stzDeploymentSite
  • SetAuthFromStore reference the auth secret BY NAME from a central stzSecretStore. The site holds NO key and NO store object -- only the name (Haro copies objects on assignment, so a held store would be a private copy whose audit no one sees). The reveal is done through the SHARED store, passed by reference at reveal time (ResolveAuthVia), so the store's gate applies AND the store audits it. This is how a project keeps ONE complete audit trail across every reveal. in stzDeploymentSite
  • SetTarget Set the build target -- a stzSystemProfile (a deployment system), a friendly name (:LinuxServer, :ESP32), or a raw Zig triple ("x86_64-linux-gnu"). in stzBuilder
  • SetRingRoot Haro parts: lower to C, then compile through Zig in stzBuilder
  • SetActor the executing actor -- governs whether Deploy(:Production) COMMITS or only rehearses (only an effectful actor may cross the governed bridge to reality). in stzDelivery

and 13 more in the reference

Adding

  • PushWorld == 5. REGISTRY + ENFORCEMENT =========================================== in stzPlatform
  • AddCapability Request a capability for the attached world: oPlat.AddCapabilityQ(:camera).SetPurposes([ :scan-dish-photo ]) in stzPlatform
  • AddSource the declarative spec (fluent) in stzBuilder
  • AddApp the apps in stzPlatformProfile
  • AddDevice a firmware part's DEVICE model (pins + an automation rule) ------- pins: [ [ pinNo, label, role, value ], ... ] role = "sensor" | "actuator". in stzAppTopology
  • AddDataset define the model (Q-fluent) ------------------------------------- a named dataset -- the solution's real domain data. A menu dataset is [ [ name, desc, price ], ... ]; an orders dataset is [ [ dish, qty ], ... ]. in stzAppTopology
  • AddWasm Add a wasm part -- a prebuilt .wasm path, or a stzBuilder (which is built). in stzWebBundle

Splitting and extracting

  • Parts delegating reads into the owned profile in stzPlatform
  • PartNames every part that has been given a role, in declaration order (the remote backend serialises these so a hosting PROCESS can rebuild the model). in stzAppTopology

Converting

  • FromString Parse .stzsystem text into this profile. Defaults the role to deployment (a declared target) unless the text says otherwise, and fills class-default capabilities when no capabilities line is present. in stzSystemProfile
  • ToStzSystem the .stzsystem format (Law 1: a domain has a format) in stzSystemProfile
  • ParseOutputAsLines "string" type needs no conversion in stzSystemCall
  • ConvertOutputByType return type control in stzSystemCall
  • ParseOutputAsNumber return type control in stzSystemCall
  • ToCommand The full command line, as one string (rehearsable -- see it before you run it, the way the twin shows a plan before it commits). in stzBuilder
  • AsRuleGraph Project parts AND services into one graph, so a rule can ask the question neither side can answer alone: does a part that is BOUND TO A SITE (i.e. destined for production) depend on a service that is still a fake? See stzServiceRuleSet. in stzDelivery
  • ToStzPlatform the .stzplatform format in stzPlatformProfile
  • To Declare the deployment target (a friendly token or a stzSystemProfile). in stzAppProfile
  • ToBytes ToBytes: hex-decode the 32 hex chars (sans hyphens) into a list of 16 byte values. Pure Haro -- no engine call needed. in stzUUID

Showing, drawing and formatting

  • Show system info in stzOperatingSystem
  • Print system info in stzOperatingSystem

Reading and writing

  • LoadFrom Read a .stzsystem file INTO this profile (the mirror of Save). in stzSystemProfile
  • OpenFile utilities in stzSystemCall
  • OpenSession Returns a session token, or "" (Why() explains) on refusal. The secret is verified by re-deriving with the stored salt + rounds and a CONSTANT-TIME compare (StzEngineCryptoConstEqual). in stzPlatform
  • OpenCommonsOn == 3. THE COMMONS RUNTIME ============================================== Identity / sessions / messaging / stores over an OPEN stzDatabase. (The stored object shares the engine handle -- live; keep the original open while the platform runs.) in stzPlatform
  • ReadError wait / kill) in stzProcess
  • ReadOutput Reads the next available chunk of the child's stdout. Blocks until at least one byte arrives, or returns "" at end of stream. This is the STREAMING read -- call it in a loop. in stzProcess
  • ReadErrorAll wait / kill) in stzProcess
  • ReadOutputAll Reads the child's stdout to the end, returning all of it. in stzProcess

Walking and applying

  • Run main execution in stzSystemCall
  • Execute main execution in stzSystemCall
  • RunSilent silent execution in stzSystemCall
  • RunSilently silent execution in stzSystemCall
  • RunEngineSilent silent execution in stzSystemCall
  • RunAfter order the plan: pcPart runs AFTER pcDependsOn is verified (a plan-DAG edge). Simple deployments declare none; complex ones (a frontend after its backend) do. in stzDeployment
  • Apply The domain hook the generic twin calls to rehearse an operation. in stzEnvironmentState
  • ExecuteStepByStep Same commit, printing each step as it crosses. in stzUpdatePlan
  • ExecuteOperation Rehearse ONE operation: mutate the in-memory twin and record it. Touches nothing real (P1). in stzVirtualSystem

The explanations are the ones the library gives of itself, read from its documentation comments on 2026-10-01 04:14, from the library at commit 0e72e2e2c, by the library's own stzSelfDoc over 635 class sources.

The classes of this area

Narrations about this area