For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • About NVIDIA NeMo Relay
    • Overview
    • Architecture
    • Ecosystem
    • Concepts
    • Release Notes
  • Getting Started
    • Agent Runtime Primer
    • Prerequisites
    • Installation
    • Configuration / Setup
    • Quick Start
  • NVIDIA NeMo Relay CLI
    • About
    • Basic Usage
    • Claude Code
    • Codex
    • Cursor
    • Hermes Agent
  • Supported Integrations
    • About
    • OpenClaw Plugin Guide
    • LangChain Integration Guide
    • LangGraph Integration Guide
    • Deep Agents Integration Guide
  • Instrument Applications
    • About
    • Adding Scopes and Marks
    • Instrument a Tool Call
    • Instrument an LLM Call
    • Add Middleware
    • Code Examples
  • Observability Plugin
    • About
    • Configuration
    • Agent Trajectory Interchange Format (ATIF)
    • Agent Trajectory Observability Format (ATOF)
    • OpenTelemetry
    • OpenInference
  • Adaptive Plugin
    • About
    • Configuration
    • Adaptive Cache Governor (ACG)
    • Adaptive Hints
  • NeMo Guardrails Plugin
    • About
    • Configuration
  • Integrate into Frameworks
    • About
    • Adding Scopes
    • Wrap Tool Calls
    • Wrap LLM Calls
    • Handle Non-Serializable Data
    • Using Codecs
    • Provider Codecs
    • Provider Response Codecs
    • Code Examples
  • Build Plugins
    • About
    • Define a Plugin
    • Validate Plugin Configuration
    • Plugin Configuration Files
    • Register Plugin Behavior
    • Design Plugin Configuration
    • NeMo Guardrails Example Plugin
    • Code Examples
  • Contribute
    • About
    • Development Setup
    • Workflow and Reviews
    • Testing and Documentation
  • Reference
    • APIs
      • Python Library Reference
      • Node.js Library Reference
      • Rust Library Reference
        • nemo-relay
          • api
            • event
            • llm
            • registry
            • runtime
            • scope
              • CreateScopeHandleParams
              • EmitMarkEventParams
              • EndScopeHandleParams
              • PopScopeParams
              • PushScopeParams
              • ScopeAttributes
              • ScopeHandle
              • HandleAttributes
              • ScopeType
              • event
              • get_handle
              • pop_scope
              • push_scope
            • subscriber
            • tool
          • codec
          • config_editor
          • error
          • json
          • observability
          • plugin
          • plugins
          • stream
          • editor_config
        • nemo-relay-adaptive
        • nemo-relay-ffi
    • Performance
  • Resources
    • Support and FAQs
    • Glossary
    • Troubleshooting Guide
    • Community
    • Legal
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
On this page
  • Parameters
  • Returns
  • Errors
  • Notes
ReferenceAPIsRust Library Referencenemo-relayapiscope

Function push_scope

||View as Markdown|
Previous

Function pop_scope

Next

Module subscriber

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi.

pub fn push_scope(params: PushScopeParams<'_>) -> Result<ScopeHandle>

Push a new scope onto the active scope stack.

This creates a new ScopeHandle, emits a scope-start event to global and scope-local subscribers, and makes the new scope the current top of stack.

Parameters

  • name: Human-readable scope name recorded on emitted lifecycle events.
  • scope_type: Semantic category for the new scope.
  • parent: Optional explicit parent scope. When None, the current top of stack is used as the parent.
  • attributes: Bitflags that modify scope behavior and observability.
  • data: Optional application payload stored on the returned handle.
  • metadata: Optional JSON metadata recorded on the emitted start event.
  • input: Optional JSON payload exported as the Agent Trajectory Observability Format (ATOF) data payload.
  • timestamp: Optional timestamp recorded as the handle start time and on the emitted start event. When None, the current UTC time is used.

Returns

A Result containing the newly created ScopeHandle.

Errors

Returns an error when the runtime owner check fails or when internal state cannot be read safely.

Notes

Scope-local subscribers attached to ancestor scopes observe the emitted start event before the function returns.