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
  • Fields
  • name: &'a str
  • parent_uuid: Option<Uuid>
  • scope_type: ScopeType
  • attributes: ScopeAttributes
  • data: Option<Json>
  • metadata: Option<Json>
  • timestamp: Option<DateTime<Utc>>
  • Implementations
  • impl<'a> CreateScopeHandleParams<'a>
  • builder
  • Trait Implementations
  • impl<'a> Clone for CreateScopeHandleParams<'a>
  • clone
  • clone_from
  • impl<'a> Debug for CreateScopeHandleParams<'a>
  • fmt
ReferenceAPIsRust Library Referencenemo-relayapiscope

Struct Create Scope Handle Params

||View as Markdown|
Previous

Module scope

Next

Struct Emit Mark Event Params

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

pub struct CreateScopeHandleParams<'a> {
    pub name: &'a str,
    pub parent_uuid: Option<Uuid>,
    pub scope_type: ScopeType,
    pub attributes: ScopeAttributes,
    pub data: Option<Json>,
    pub metadata: Option<Json>,
    pub timestamp: Option<DateTime<Utc>>,
}

Builder parameters for NemoRelayContextState::create_scope_handle.

Fields

name: &'a str

Human-readable scope name.

parent_uuid: Option<Uuid>

Optional parent scope UUID.

scope_type: ScopeType

Semantic category of the scope.

attributes: ScopeAttributes

Scope attribute bitflags.

data: Option<Json>

Optional application payload stored on the handle.

metadata: Option<Json>

Optional metadata stored on the handle.

timestamp: Option<DateTime<Utc>>

Optional timestamp captured as the handle start time and reused by the emitted start event. When omitted, the current UTC time is used.

Implementations

impl<'a> CreateScopeHandleParams<'a>

impl<'a> CreateScopeHandleParams<'a>

builder

pub fn builder() -> CreateScopeHandleParamsBuilder<'a, ((), (), (), (), (), (), ())>

Create a builder for building CreateScopeHandleParams. On the builder, call .name(...), .parent_uuid(...)(optional), .scope_type(...), .attributes(...)(optional), .data(...)(optional), .metadata(...)(optional), .timestamp(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateScopeHandleParams.

Trait Implementations

impl<'a> Clone for CreateScopeHandleParams<'a>

impl<'a> Clone for CreateScopeHandleParams<'a>

clone

fn clone(&self) -> CreateScopeHandleParams<'a>

clone_from

fn clone_from(&mut self, source: &Self)

impl<'a> Debug for CreateScopeHandleParams<'a>

impl<'a> Debug for CreateScopeHandleParams<'a>

fmt

fn fmt(&self, f: &mut Formatter<'_>) -> Result