{ "schema": 1, "project": { "name": "GPUI Box", "repository": "https://github.com/fran0220/gpui-box", "releaseVersion": "0.2.0", "releaseStatus": "released", "rustVersion": "1.97", "edition": "2024" }, "packages": [ { "name": "gpui-box", "crate": "gpui", "manifest": "crates/gpui/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "The independent GPUI Box distribution derived from Zed GPUI", "readme": "README.md", "features": { "bench": [ "test-support", "dep:criterion", "dep:hdrhistogram" ], "default": [ "font-kit", "wayland", "x11", "windows-manifest" ], "input-latency-histogram": [ "dep:hdrhistogram" ], "inspector": [ "gpui_macros/inspector" ], "leak-detection": [ "backtrace" ], "profiler": [], "screen-capture": [ "scap", "dep:windows-capture" ], "test-support": [ "leak-detection", "collections/test-support", "http_client/test-support", "wayland", "x11", "proptest" ], "wayland": [], "windows-manifest": [ "dep:embed-resource" ], "x11": [ "scap?/x11" ] }, "dependencies": [ { "alias": "accesskit", "package": "accesskit", "kind": "normal", "optional": false, "features": [] }, { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "async-channel", "package": "async-channel", "kind": "normal", "optional": false, "features": [] }, { "alias": "async-task", "package": "async-task", "kind": "normal", "optional": false, "features": [] }, { "alias": "backtrace", "package": "backtrace", "kind": "normal", "optional": true, "features": [] }, { "alias": "backtrace", "package": "backtrace", "kind": "dev", "optional": false, "features": [] }, { "alias": "bitflags", "package": "bitflags", "kind": "normal", "optional": false, "features": [] }, { "alias": "chrono", "package": "chrono", "kind": "normal", "optional": false, "features": [] }, { "alias": "collections", "package": "gpui-box-collections", "kind": "normal", "optional": false, "features": [] }, { "alias": "collections", "package": "gpui-box-collections", "kind": "dev", "optional": false, "features": [ "test-support" ] }, { "alias": "criterion", "package": "criterion", "kind": "normal", "optional": true, "features": [] }, { "alias": "ctor", "package": "ctor", "kind": "normal", "optional": false, "features": [] }, { "alias": "derive_more", "package": "derive_more", "kind": "normal", "optional": false, "features": [] }, { "alias": "embed-resource", "package": "embed-resource", "kind": "build", "optional": true, "features": [] }, { "alias": "env_logger", "package": "env_logger", "kind": "dev", "optional": false, "features": [] }, { "alias": "etagere", "package": "etagere", "kind": "normal", "optional": false, "features": [] }, { "alias": "futures", "package": "futures", "kind": "normal", "optional": false, "features": [] }, { "alias": "futures-concurrency", "package": "futures-concurrency", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_macros", "package": "gpui-box-macros", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_platform", "package": "gpui-box-platform", "kind": "dev", "optional": false, "features": [ "font-kit", "wayland", "x11" ] }, { "alias": "gpui_shared_string", "package": "gpui-box-shared-string", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_util", "package": "gpui-box-util", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_util", "package": "gpui-box-util", "kind": "dev", "optional": false, "features": [] }, { "alias": "hdrhistogram", "package": "hdrhistogram", "kind": "normal", "optional": true, "features": [] }, { "alias": "heapless", "package": "heapless", "kind": "normal", "optional": false, "features": [] }, { "alias": "http_client", "package": "gpui-box-http-client", "kind": "normal", "optional": false, "features": [] }, { "alias": "image", "package": "image", "kind": "normal", "optional": false, "features": [] }, { "alias": "inventory", "package": "inventory", "kind": "normal", "optional": false, "features": [] }, { "alias": "itertools", "package": "itertools", "kind": "normal", "optional": false, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] }, { "alias": "lyon", "package": "lyon", "kind": "normal", "optional": false, "features": [] }, { "alias": "lyon", "package": "lyon", "kind": "dev", "optional": false, "features": [ "extra" ] }, { "alias": "num_cpus", "package": "num_cpus", "kind": "normal", "optional": false, "features": [] }, { "alias": "parking", "package": "parking", "kind": "normal", "optional": false, "features": [] }, { "alias": "parking_lot", "package": "parking_lot", "kind": "normal", "optional": false, "features": [] }, { "alias": "pin-project", "package": "pin-project", "kind": "normal", "optional": false, "features": [] }, { "alias": "pollster", "package": "pollster", "kind": "normal", "optional": false, "features": [] }, { "alias": "postage", "package": "postage", "kind": "normal", "optional": false, "features": [] }, { "alias": "profiling", "package": "profiling", "kind": "normal", "optional": false, "features": [] }, { "alias": "proptest", "package": "proptest", "kind": "normal", "optional": true, "features": [] }, { "alias": "rand", "package": "rand", "kind": "normal", "optional": false, "features": [] }, { "alias": "rand", "package": "rand", "kind": "dev", "optional": false, "features": [] }, { "alias": "raw-window-handle", "package": "raw-window-handle", "kind": "normal", "optional": false, "features": [] }, { "alias": "refineable", "package": "gpui-box-refineable", "kind": "normal", "optional": false, "features": [] }, { "alias": "regex", "package": "regex", "kind": "normal", "optional": false, "features": [] }, { "alias": "resvg", "package": "resvg", "kind": "normal", "optional": false, "features": [] }, { "alias": "ropey", "package": "ropey", "kind": "normal", "optional": false, "features": [ "simd" ] }, { "alias": "scheduler", "package": "gpui-box-scheduler", "kind": "normal", "optional": false, "features": [] }, { "alias": "scheduler", "package": "gpui-box-scheduler", "kind": "dev", "optional": false, "features": [ "test-support" ] }, { "alias": "schemars", "package": "schemars", "kind": "normal", "optional": false, "features": [] }, { "alias": "seahash", "package": "seahash", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "slotmap", "package": "slotmap", "kind": "normal", "optional": false, "features": [] }, { "alias": "smallvec", "package": "smallvec", "kind": "normal", "optional": false, "features": [] }, { "alias": "spin", "package": "spin", "kind": "normal", "optional": false, "features": [] }, { "alias": "stacksafe", "package": "stacksafe", "kind": "normal", "optional": false, "features": [] }, { "alias": "strum", "package": "strum", "kind": "normal", "optional": false, "features": [] }, { "alias": "sum_tree", "package": "gpui-box-sum-tree", "kind": "normal", "optional": false, "features": [] }, { "alias": "taffy", "package": "taffy", "kind": "normal", "optional": false, "features": [] }, { "alias": "thiserror", "package": "thiserror", "kind": "normal", "optional": false, "features": [] }, { "alias": "ttf-parser", "package": "ttf-parser", "kind": "normal", "optional": false, "features": [] }, { "alias": "unicode-bidi", "package": "unicode-bidi", "kind": "normal", "optional": false, "features": [] }, { "alias": "unicode-linebreak", "package": "unicode-linebreak", "kind": "normal", "optional": false, "features": [] }, { "alias": "unicode-segmentation", "package": "unicode-segmentation", "kind": "normal", "optional": false, "features": [] }, { "alias": "url", "package": "url", "kind": "normal", "optional": false, "features": [] }, { "alias": "usvg", "package": "usvg", "kind": "normal", "optional": false, "features": [] }, { "alias": "util_macros", "package": "gpui-box-util-macros", "kind": "normal", "optional": false, "features": [] }, { "alias": "uuid", "package": "uuid", "kind": "normal", "optional": false, "features": [] }, { "alias": "waker-fn", "package": "waker-fn", "kind": "normal", "optional": false, "features": [] }, { "alias": "web-time", "package": "web-time", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 2773 }, { "name": "gpui-box-android", "crate": "gpui_android", "manifest": "crates/gpui_android/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Android Activity and native surface backend for GPUI Box", "readme": null, "features": { "host-check": [] }, "dependencies": [ { "alias": "accesskit", "package": "accesskit", "kind": "normal", "optional": false, "features": [] }, { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "futures", "package": "futures", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_wgpu", "package": "gpui-box-wgpu", "kind": "normal", "optional": false, "features": [] }, { "alias": "jni", "package": "jni", "kind": "normal", "optional": false, "features": [] }, { "alias": "raw-window-handle", "package": "raw-window-handle", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "uuid", "package": "uuid", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 42 }, { "name": "gpui-box-app-host", "crate": "app_host", "manifest": "tools/app-host/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "MIT", "publish": false, "description": null, "readme": null, "features": { "capture": [ "gpui_platform/test-support", "dep:gpui-kit-testkit" ] }, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "base64", "package": "base64", "kind": "normal", "optional": false, "features": [] }, { "alias": "env_logger", "package": "env_logger", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit", "package": "gpui-kit", "kind": "normal", "optional": false, "features": [ "syntax" ] }, { "alias": "gpui-kit-semantics", "package": "gpui-kit-semantics", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-testkit", "package": "gpui-kit-testkit", "kind": "normal", "optional": true, "features": [ "test-support" ] }, { "alias": "gpui-kit-theme", "package": "gpui-kit-theme", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_platform", "package": "gpui-box-platform", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 31 }, { "name": "gpui-box-browser-gallery", "crate": "browser_gallery", "manifest": "examples/browser-gallery/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "MIT", "publish": false, "description": null, "readme": null, "features": {}, "dependencies": [], "symbolCount": 1 }, { "name": "gpui-box-collections", "crate": "collections", "manifest": "crates/collections/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "GPUI Box collection types", "readme": null, "features": { "test-support": [] }, "dependencies": [ { "alias": "gpui_util", "package": "gpui-box-util", "kind": "normal", "optional": false, "features": [] }, { "alias": "indexmap", "package": "indexmap", "kind": "normal", "optional": false, "features": [] }, { "alias": "rustc-hash", "package": "rustc-hash", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 30 }, { "name": "gpui-box-gallery", "crate": "gallery", "manifest": "examples/gallery/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "MIT", "publish": false, "description": null, "readme": null, "features": {}, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit", "package": "gpui-kit", "kind": "normal", "optional": false, "features": [ "fixtures" ] }, { "alias": "gpui-kit-assets", "package": "gpui-kit-assets", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-semantics", "package": "gpui-kit-semantics", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-testkit", "package": "gpui-kit-testkit", "kind": "normal", "optional": false, "features": [ "test-support" ] }, { "alias": "gpui-kit-theme", "package": "gpui-kit-theme", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_platform", "package": "gpui-box-platform", "kind": "normal", "optional": false, "features": [ "test-support" ] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 7 }, { "name": "gpui-box-headless-visual", "crate": "headless_visual", "manifest": "tools/headless-visual/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "MIT", "publish": false, "description": null, "readme": null, "features": {}, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [ "test-support" ] }, { "alias": "gpui-kit", "package": "gpui-box-kit", "kind": "normal", "optional": false, "features": [ "fixtures", "terminal" ] }, { "alias": "gpui-kit-semantics", "package": "gpui-box-kit-semantics", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-testkit", "package": "gpui-box-kit-testkit", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-theme", "package": "gpui-box-kit-theme", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_platform", "package": "gpui-box-platform", "kind": "normal", "optional": false, "features": [ "test-support" ] }, { "alias": "gpui_wgpu", "package": "gpui-box-wgpu", "kind": "normal", "optional": false, "features": [ "test-support" ] }, { "alias": "image", "package": "image", "kind": "normal", "optional": false, "features": [ "png" ] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 1 }, { "name": "gpui-box-http-client", "crate": "http_client", "manifest": "crates/http_client/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "HTTP client abstractions for GPUI Box", "readme": null, "features": { "test-support": [] }, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "async-compression", "package": "async-compression", "kind": "normal", "optional": false, "features": [] }, { "alias": "bytes", "package": "bytes", "kind": "normal", "optional": false, "features": [] }, { "alias": "derive_more", "package": "derive_more", "kind": "normal", "optional": false, "features": [] }, { "alias": "futures", "package": "futures", "kind": "normal", "optional": false, "features": [] }, { "alias": "http", "package": "http", "kind": "normal", "optional": false, "features": [] }, { "alias": "http-body", "package": "http-body", "kind": "normal", "optional": false, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] }, { "alias": "parking_lot", "package": "parking_lot", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_urlencoded", "package": "serde_urlencoded", "kind": "normal", "optional": false, "features": [] }, { "alias": "url", "package": "url", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 48 }, { "name": "gpui-box-ios", "crate": "gpui_ios", "manifest": "crates/gpui_ios/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "UIKit host integration for GPUI Box (native acceptance pending)", "readme": null, "features": { "platform-check": [] }, "dependencies": [ { "alias": "accesskit", "package": "accesskit", "kind": "normal", "optional": false, "features": [] }, { "alias": "accesskit_consumer", "package": "accesskit_consumer", "kind": "normal", "optional": false, "features": [] }, { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "cc", "package": "cc", "kind": "build", "optional": false, "features": [] }, { "alias": "futures", "package": "futures", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-box-mobile-reference", "package": "gpui-box-mobile-reference", "kind": "dev", "optional": false, "features": [] }, { "alias": "gpui-kit", "package": "gpui-box-kit", "kind": "dev", "optional": false, "features": [] }, { "alias": "gpui_wgpu", "package": "gpui-box-wgpu", "kind": "normal", "optional": false, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] }, { "alias": "raw-window-handle", "package": "raw-window-handle", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "dev", "optional": false, "features": [] }, { "alias": "tempfile", "package": "tempfile", "kind": "dev", "optional": false, "features": [] }, { "alias": "uuid", "package": "uuid", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 19 }, { "name": "gpui-box-kit", "crate": "gpui_kit", "manifest": "crates/gpui-kit/Cargo.toml", "cohort": "kit", "layer": 1, "version": "0.2.0", "license": "MIT", "publish": true, "description": "GPUI Box Kit design-system components and interaction primitives", "readme": null, "features": { "default": [ "native-media", "terminal" ], "dotlottie": [ "dep:base64", "dep:image", "dep:rasterlottie", "dep:zip" ], "fixtures": [], "native-media": [ "media/native-playback" ], "syntax": [ "dep:tree-sitter", "dep:tree-sitter-json" ], "terminal": [ "dep:alacritty_terminal" ] }, "dependencies": [ { "alias": "base64", "package": "base64", "kind": "normal", "optional": true, "features": [] }, { "alias": "chrono", "package": "chrono", "kind": "normal", "optional": false, "features": [] }, { "alias": "chrono-tz", "package": "chrono-tz", "kind": "dev", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "dev", "optional": false, "features": [ "test-support" ] }, { "alias": "gpui-kit", "package": "gpui-box-kit", "kind": "dev", "optional": false, "features": [ "fixtures" ] }, { "alias": "gpui-kit-assets", "package": "gpui-kit-assets", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-semantics", "package": "gpui-kit-semantics", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-testkit", "package": "gpui-box-kit-testkit", "kind": "dev", "optional": false, "features": [ "test-support" ] }, { "alias": "gpui-kit-theme", "package": "gpui-kit-theme", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-tokens", "package": "gpui-kit-tokens", "kind": "normal", "optional": false, "features": [] }, { "alias": "image", "package": "image", "kind": "normal", "optional": true, "features": [] }, { "alias": "media", "package": "gpui-box-media", "kind": "normal", "optional": false, "features": [] }, { "alias": "proptest", "package": "proptest", "kind": "dev", "optional": false, "features": [] }, { "alias": "pulldown-cmark", "package": "pulldown-cmark", "kind": "normal", "optional": false, "features": [] }, { "alias": "rasterlottie", "package": "rasterlottie", "kind": "normal", "optional": true, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "smallvec", "package": "smallvec", "kind": "normal", "optional": false, "features": [] }, { "alias": "tree-sitter", "package": "tree-sitter", "kind": "normal", "optional": true, "features": [] }, { "alias": "tree-sitter-json", "package": "tree-sitter-json", "kind": "normal", "optional": true, "features": [] }, { "alias": "unicode-segmentation", "package": "unicode-segmentation", "kind": "normal", "optional": false, "features": [] }, { "alias": "web-time", "package": "web-time", "kind": "normal", "optional": false, "features": [] }, { "alias": "zip", "package": "zip", "kind": "normal", "optional": true, "features": [] } ], "symbolCount": 4975 }, { "name": "gpui-box-kit-assets", "crate": "gpui_kit_assets", "manifest": "crates/gpui-kit-assets/Cargo.toml", "cohort": "kit", "layer": 1, "version": "0.2.0", "license": "MIT", "publish": true, "description": "Licensed fonts and generic icon assets for GPUI Box Kit", "readme": null, "features": {}, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "tracing", "package": "tracing", "kind": "normal", "optional": false, "features": [] }, { "alias": "ttf-parser", "package": "ttf-parser", "kind": "dev", "optional": false, "features": [] } ], "symbolCount": 29 }, { "name": "gpui-box-kit-semantics", "crate": "gpui_kit_semantics", "manifest": "crates/gpui-kit-semantics/Cargo.toml", "cohort": "kit", "layer": 1, "version": "0.2.0", "license": "MIT", "publish": true, "description": "GPUI Box Kit per-frame semantic trees for testing native GPUI interfaces", "readme": null, "features": {}, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "dev", "optional": false, "features": [ "test-support" ] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "dev", "optional": false, "features": [] } ], "symbolCount": 80 }, { "name": "gpui-box-kit-testkit", "crate": "gpui_kit_testkit", "manifest": "crates/gpui-kit-testkit/Cargo.toml", "cohort": "kit", "layer": 1, "version": "0.2.0", "license": "MIT", "publish": true, "description": "GPUI Box Kit semantic assertions, window capture, and visual diff helpers", "readme": null, "features": { "test-support": [ "gpui/test-support" ] }, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-semantics", "package": "gpui-kit-semantics", "kind": "normal", "optional": false, "features": [] }, { "alias": "png", "package": "png", "kind": "normal", "optional": false, "features": [] }, { "alias": "raw-window-handle", "package": "raw-window-handle", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "tempfile", "package": "tempfile", "kind": "dev", "optional": false, "features": [] }, { "alias": "thiserror", "package": "thiserror", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 67 }, { "name": "gpui-box-kit-theme", "crate": "gpui_kit_theme", "manifest": "crates/gpui-kit-theme/Cargo.toml", "cohort": "kit", "layer": 1, "version": "0.2.0", "license": "MIT", "publish": true, "description": "GPUI adapter for GPUI Box Kit semantic design tokens", "readme": null, "features": {}, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit-tokens", "package": "gpui-kit-tokens", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "dev", "optional": false, "features": [] } ], "symbolCount": 96 }, { "name": "gpui-box-kit-tokens", "crate": "gpui_kit_tokens", "manifest": "crates/gpui-kit-tokens/Cargo.toml", "cohort": "kit", "layer": 1, "version": "0.2.0", "license": "MIT", "publish": true, "description": "Typed, GPUI-independent design tokens for GPUI Box Kit", "readme": null, "features": {}, "dependencies": [ { "alias": "jsonschema", "package": "jsonschema", "kind": "dev", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "thiserror", "package": "thiserror", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 165 }, { "name": "gpui-box-linux", "crate": "gpui_linux", "manifest": "crates/gpui_linux/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "GPUI Box platform integration for Linux and FreeBSD", "readme": null, "features": { "default": [ "wayland", "x11" ], "screen-capture": [ "gpui/screen-capture", "scap" ], "test-support": [ "gpui/test-support" ], "wayland": [ "bitflags", "gpui_wgpu", "ashpd/wayland", "calloop-wayland-source", "wayland-backend", "wayland-client", "wayland-cursor", "wayland-protocols", "wayland-protocols-plasma", "wayland-protocols-wlr", "filedescriptor", "xkbcommon/wayland", "open", "gpui/wayland" ], "x11": [ "gpui_wgpu", "ashpd", "as-raw-xcb-connection", "x11rb", "xkbcommon/x11", "xim", "x11-clipboard", "filedescriptor", "open", "scap?/x11" ] }, "dependencies": [], "symbolCount": 135 }, { "name": "gpui-box-macos", "crate": "gpui_macos", "manifest": "crates/gpui_macos/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "GPUI Box platform integration for macOS", "readme": null, "features": { "default": [ "gpui/default" ], "font-kit": [ "dep:font-kit" ], "runtime_shaders": [], "screen-capture": [ "gpui/screen-capture" ], "test-support": [ "gpui/test-support" ] }, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 59 }, { "name": "gpui-box-macros", "crate": "gpui_macros", "manifest": "crates/gpui_macros/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Procedural macros for GPUI Box", "readme": null, "features": { "inspector": [] }, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "dev", "optional": false, "features": [ "inspector", "test-support" ] }, { "alias": "heck", "package": "heck", "kind": "normal", "optional": false, "features": [] }, { "alias": "proc-macro2", "package": "proc-macro2", "kind": "normal", "optional": false, "features": [] }, { "alias": "quote", "package": "quote", "kind": "normal", "optional": false, "features": [] }, { "alias": "syn", "package": "syn", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 36 }, { "name": "gpui-box-mcp", "crate": "mcp", "manifest": "tools/mcp/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "MIT", "publish": true, "description": "Remote and checkout Model Context Protocol server for GPUI Box development", "readme": "../../docs/mcp.md", "features": {}, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "axum", "package": "axum", "kind": "normal", "optional": false, "features": [ "http1", "json", "tokio" ] }, { "alias": "futures", "package": "futures", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "tokio", "package": "tokio", "kind": "normal", "optional": false, "features": [ "net", "rt-multi-thread", "signal", "sync", "time" ] } ], "symbolCount": 0 }, { "name": "gpui-box-media", "crate": "media", "manifest": "crates/media/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Native media playback and platform media bindings for GPUI Box", "readme": null, "features": { "default": [ "native-playback" ], "native-playback": [ "dep:bindgen", "dep:cc", "dep:core-foundation", "dep:core-video", "dep:ctor", "dep:foreign-types", "dep:metal", "dep:objc", "dep:url", "dep:windows", "dep:windows-core" ] }, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 34 }, { "name": "gpui-box-platform", "crate": "gpui_platform", "manifest": "crates/gpui_platform/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Cross-platform integration for GPUI Box", "readme": null, "features": { "default": [ "native-platform", "font-kit" ], "font-kit": [ "gpui_macos?/font-kit" ], "native-platform": [ "dep:gpui_android", "dep:gpui_ios", "dep:gpui_linux", "dep:gpui_macos", "dep:gpui_web", "dep:gpui_windows" ], "runtime_shaders": [ "gpui_macos/runtime_shaders" ], "screen-capture": [ "gpui/screen-capture", "gpui_macos/screen-capture", "gpui_windows/screen-capture", "gpui_linux/screen-capture" ], "test-support": [ "gpui/test-support", "gpui_macos/test-support", "gpui_windows/test-support", "dep:gpui_wgpu", "gpui_wgpu/test-support" ], "wayland": [ "gpui_linux/wayland" ], "web-multithreaded": [ "gpui_web/multithreaded" ], "x11": [ "gpui_linux/x11" ] }, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_wgpu", "package": "gpui-box-wgpu", "kind": "normal", "optional": true, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 12 }, { "name": "gpui-box-refineable", "crate": "refineable", "manifest": "crates/refineable/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "A macro for creating 'refinement' types that can be used to partially initialize or mutate a complex struct", "readme": null, "features": {}, "dependencies": [ { "alias": "derive_refineable", "package": "gpui-box-refineable-derive", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 9 }, { "name": "gpui-box-refineable-derive", "crate": "derive_refineable", "manifest": "crates/refineable/derive_refineable/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "A derive macro for creating refinement types in Rust", "readme": null, "features": {}, "dependencies": [ { "alias": "proc-macro2", "package": "proc-macro2", "kind": "normal", "optional": false, "features": [] }, { "alias": "quote", "package": "quote", "kind": "normal", "optional": false, "features": [] }, { "alias": "syn", "package": "syn", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 1 }, { "name": "gpui-box-scheduler", "crate": "scheduler", "manifest": "crates/scheduler/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Task scheduler for GPUI Box", "readme": null, "features": { "test-support": [] }, "dependencies": [ { "alias": "async-task", "package": "async-task", "kind": "normal", "optional": false, "features": [] }, { "alias": "backtrace", "package": "backtrace", "kind": "normal", "optional": false, "features": [] }, { "alias": "chrono", "package": "chrono", "kind": "normal", "optional": false, "features": [] }, { "alias": "flume", "package": "flume", "kind": "normal", "optional": false, "features": [] }, { "alias": "futures", "package": "futures", "kind": "normal", "optional": false, "features": [] }, { "alias": "parking_lot", "package": "parking_lot", "kind": "normal", "optional": false, "features": [] }, { "alias": "rand", "package": "rand", "kind": "normal", "optional": false, "features": [] }, { "alias": "web-time", "package": "web-time", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 86 }, { "name": "gpui-box-shared-string", "crate": "gpui_shared_string", "manifest": "crates/gpui_shared_string/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Shared string types for GPUI Box", "readme": null, "features": {}, "dependencies": [ { "alias": "schemars", "package": "schemars", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "smol_str", "package": "smol_str", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 0 }, { "name": "gpui-box-sum-tree", "crate": "sum_tree", "manifest": "crates/sum_tree/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "A sum tree data structure, a concurrency-friendly B-tree", "readme": null, "features": { "test-support": [ "proptest" ] }, "dependencies": [ { "alias": "ctor", "package": "ctor", "kind": "dev", "optional": false, "features": [] }, { "alias": "heapless", "package": "heapless", "kind": "normal", "optional": false, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] }, { "alias": "proptest", "package": "proptest", "kind": "normal", "optional": true, "features": [] }, { "alias": "proptest", "package": "proptest", "kind": "dev", "optional": false, "features": [] }, { "alias": "rand", "package": "rand", "kind": "dev", "optional": false, "features": [] }, { "alias": "rayon", "package": "rayon", "kind": "normal", "optional": false, "features": [] }, { "alias": "tracing", "package": "tracing", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 106 }, { "name": "gpui-box-util", "crate": "gpui_util", "manifest": "crates/gpui_util/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Utility types for GPUI Box", "readme": null, "features": {}, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 21 }, { "name": "gpui-box-util-macros", "crate": "util_macros", "manifest": "crates/util_macros/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "Utility macros for GPUI Box", "readme": null, "features": { "perf-enabled": [] }, "dependencies": [ { "alias": "quote", "package": "quote", "kind": "normal", "optional": false, "features": [] }, { "alias": "syn", "package": "syn", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 4 }, { "name": "gpui-box-web", "crate": "gpui_web", "manifest": "crates/gpui_web/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "GPUI Box platform integration for the web", "readme": null, "features": { "default": [], "multithreaded": [ "dep:wasm_thread" ] }, "dependencies": [], "symbolCount": 26 }, { "name": "gpui-box-webview", "crate": "gpui_webview", "manifest": "crates/gpui-webview/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "MIT", "publish": true, "description": "Caller-owned native browser engine hosts for GPUI Box", "readme": null, "features": {}, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "base64", "package": "base64", "kind": "dev", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui_platform", "package": "gpui-box-platform", "kind": "dev", "optional": false, "features": [] }, { "alias": "raw-window-handle", "package": "raw-window-handle", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "dev", "optional": false, "features": [] }, { "alias": "url", "package": "url", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 20 }, { "name": "gpui-box-wgpu", "crate": "gpui_wgpu", "manifest": "crates/gpui_wgpu/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "wgpu renderer for GPUI Box", "readme": null, "features": { "default": [], "font-kit": [ "dep:font-kit" ], "test-support": [ "gpui/test-support", "dep:image" ] }, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "bytemuck", "package": "bytemuck", "kind": "normal", "optional": false, "features": [] }, { "alias": "collections", "package": "gpui-box-collections", "kind": "normal", "optional": false, "features": [] }, { "alias": "cosmic-text", "package": "cosmic-text", "kind": "normal", "optional": false, "features": [] }, { "alias": "criterion", "package": "criterion", "kind": "dev", "optional": false, "features": [] }, { "alias": "env_logger", "package": "env_logger", "kind": "dev", "optional": false, "features": [] }, { "alias": "etagere", "package": "etagere", "kind": "normal", "optional": false, "features": [] }, { "alias": "font-kit", "package": "zed-font-kit", "kind": "normal", "optional": true, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui", "package": "gpui-box", "kind": "dev", "optional": false, "features": [ "test-support" ] }, { "alias": "gpui_util", "package": "gpui-box-util", "kind": "normal", "optional": false, "features": [] }, { "alias": "image", "package": "image", "kind": "normal", "optional": true, "features": [] }, { "alias": "image", "package": "image", "kind": "dev", "optional": false, "features": [] }, { "alias": "itertools", "package": "itertools", "kind": "normal", "optional": false, "features": [] }, { "alias": "log", "package": "log", "kind": "normal", "optional": false, "features": [] }, { "alias": "naga", "package": "naga", "kind": "dev", "optional": false, "features": [ "wgsl-in" ] }, { "alias": "parking_lot", "package": "parking_lot", "kind": "normal", "optional": false, "features": [] }, { "alias": "profiling", "package": "profiling", "kind": "normal", "optional": false, "features": [] }, { "alias": "raw-window-handle", "package": "raw-window-handle", "kind": "normal", "optional": false, "features": [] }, { "alias": "smallvec", "package": "smallvec", "kind": "normal", "optional": false, "features": [] }, { "alias": "swash", "package": "swash", "kind": "normal", "optional": false, "features": [] }, { "alias": "unicode-bidi", "package": "unicode-bidi", "kind": "normal", "optional": false, "features": [] }, { "alias": "unicode-segmentation", "package": "unicode-segmentation", "kind": "normal", "optional": false, "features": [] }, { "alias": "wgpu", "package": "wgpu", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 59 }, { "name": "gpui-box-windows", "crate": "gpui_windows", "manifest": "crates/gpui_windows/Cargo.toml", "cohort": "framework", "layer": 0, "version": "0.2.0", "license": "Apache-2.0", "publish": true, "description": "GPUI Box platform integration for Windows", "readme": null, "features": { "default": [ "gpui/default" ], "screen-capture": [ "gpui/screen-capture", "scap" ], "test-support": [ "gpui/test-support" ] }, "dependencies": [ { "alias": "gpui", "package": "gpui-box", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 22 }, { "name": "perf", "crate": "perf", "manifest": "tooling/perf/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "Apache-2.0", "publish": false, "description": "A tool for measuring Zed test performance, with too many Clippy lints", "readme": null, "features": {}, "dependencies": [ { "alias": "collections", "package": "gpui-box-collections", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 15 }, { "name": "xtask", "crate": "xtask", "manifest": "xtask/Cargo.toml", "cohort": "tool", "layer": 2, "version": "0.2.0", "license": "MIT", "publish": false, "description": null, "readme": null, "features": {}, "dependencies": [ { "alias": "anyhow", "package": "anyhow", "kind": "normal", "optional": false, "features": [] }, { "alias": "gpui-kit", "package": "gpui-kit", "kind": "normal", "optional": false, "features": [ "fixtures" ] }, { "alias": "gpui-kit-tokens", "package": "gpui-kit-tokens", "kind": "normal", "optional": false, "features": [] }, { "alias": "proc-macro2", "package": "proc-macro2", "kind": "normal", "optional": false, "features": [ "span-locations" ] }, { "alias": "pulldown-cmark", "package": "pulldown-cmark", "kind": "normal", "optional": false, "features": [ "html" ] }, { "alias": "quote", "package": "quote", "kind": "normal", "optional": false, "features": [] }, { "alias": "serde", "package": "serde", "kind": "normal", "optional": false, "features": [ "derive" ] }, { "alias": "serde_json", "package": "serde_json", "kind": "normal", "optional": false, "features": [] }, { "alias": "sha2", "package": "sha2", "kind": "normal", "optional": false, "features": [] }, { "alias": "syn", "package": "syn", "kind": "normal", "optional": false, "features": [ "visit" ] }, { "alias": "toml", "package": "toml", "kind": "normal", "optional": false, "features": [] } ], "symbolCount": 17 } ], "symbols": [ { "id": "app_host::references::EntityDispatch", "name": "EntityDispatch", "kind": "type", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub type EntityDispatch = fn (& Entity, & str, & Value, bool, & mut Window, & mut App, & Registration<'_>) -> Result;", "cfg": [] }, { "id": "app_host::references::Registration", "name": "Registration", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub struct Registration<'a> { registry : & 'a Registry, scope : Scope, anchor : Option, ancestor : Option>, }", "cfg": [] }, { "id": "app_host::references::Registration::borrow_focus", "name": "borrow_focus", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn borrow_focus (& self, reference : & Value, cx : & App) -> Result", "cfg": [], "target": "Registration<'_>" }, { "id": "app_host::references::Registration::entity", "name": "entity", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn entity

(& self, kind : & 'static str, parent : & Entity

, target : & Entity, current : fn (& P, & App) -> Option>, command_allowed : fn (& P, & App) -> bool, dispatch : EntityDispatch,) -> Result", "cfg": [], "target": "Registration<'_>" }, { "id": "app_host::references::Registration::focus", "name": "focus", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn focus

(& self, parent : & Entity

, target : & FocusHandle, current : fn (& P, & FocusHandle, & App) -> bool, command_allowed : fn (& P, & App) -> bool,) -> Result", "cfg": [], "target": "Registration<'_>" }, { "id": "app_host::references::Registry", "name": "Registry", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Default)] pub struct Registry (Rc>);", "cfg": [] }, { "id": "app_host::references::Registry::invoke", "name": "invoke", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn invoke (& self, owner : EffectOwner, reference : & Value, method : & str, args : & Value, query : bool, window : & mut Window, cx : & mut App,) -> Result", "cfg": [], "target": "Registry" }, { "id": "app_host::references::Registry::new", "name": "new", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "Registry" }, { "id": "app_host::references::Registry::reconcile", "name": "reconcile", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn reconcile (& self, root : & Node, owner_for : impl Fn (& Node) -> Option, parent_for : impl Fn (& Node) -> Option, cx : & App,)", "cfg": [], "target": "Registry" }, { "id": "app_host::references::Registry::registration", "name": "registration", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn registration (& self, node : & Node, owner : EffectOwner) -> Registration<'_>", "cfg": [], "target": "Registry" }, { "id": "app_host::references::Registry::release", "name": "release", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn release (& self, reference : & Value, owner : EffectOwner) -> Result<()>", "cfg": [], "target": "Registry" }, { "id": "app_host::references::Registry::revoke", "name": "revoke", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn revoke (& self)", "cfg": [], "target": "Registry" }, { "id": "app_host::references::Registry::source", "name": "source", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "references", "path": "app_host::references", "source": "tools/app-host/src/references.rs", "summary": "", "documentation": "", "signature": "pub fn source (& self, reference : & Value, instance : u64) -> Result<(String, Option)>", "cfg": [], "target": "Registry" }, { "id": "app_host::resources::MAX_BYTES", "name": "MAX_BYTES", "kind": "constant", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub const MAX_BYTES: usize", "cfg": [] }, { "id": "app_host::resources::MAX_ENCODED", "name": "MAX_ENCODED", "kind": "constant", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub const MAX_ENCODED: usize", "cfg": [] }, { "id": "app_host::resources::MAX_OWNER_BYTES", "name": "MAX_OWNER_BYTES", "kind": "constant", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub const MAX_OWNER_BYTES: usize", "cfg": [] }, { "id": "app_host::resources::MAX_OWNER_COUNT", "name": "MAX_OWNER_COUNT", "kind": "constant", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub const MAX_OWNER_COUNT: usize", "cfg": [] }, { "id": "app_host::resources::Registration", "name": "Registration", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Deserialize)] # [serde (deny_unknown_fields)] pub struct Registration { pub key : String, pub mime : String, pub data : String, }", "cfg": [] }, { "id": "app_host::resources::ResourceBytes", "name": "ResourceBytes", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "A revocable lease, not ownership of resource bytes. Consumers must parse synchronously within with_bytes and enforce format-specific work limits. In particular, authorizing these bytes does not authorize external references.", "documentation": "A revocable lease, not ownership of resource bytes. Consumers must parse\nsynchronously within with_bytes and enforce format-specific work limits.\nIn particular, authorizing these bytes does not authorize external references.", "signature": "# [doc = \" A revocable lease, not ownership of resource bytes. Consumers must parse\"] # [doc = \" synchronously within with_bytes and enforce format-specific work limits.\"] # [doc = \" In particular, authorizing these bytes does not authorize external references.\"] pub struct ResourceBytes (Lease);", "cfg": [] }, { "id": "app_host::resources::ResourceBytes::with_bytes", "name": "with_bytes", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub fn with_bytes (& self, cx : & App, use_bytes : impl FnOnce (& [u8]) -> Result) -> Result", "cfg": [], "target": "ResourceBytes" }, { "id": "app_host::resources::ResourceRef", "name": "ResourceRef", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Debug, Deserialize, Serialize, PartialEq, Eq)] # [serde (deny_unknown_fields)] pub struct ResourceRef { pub key : String, }", "cfg": [] }, { "id": "app_host::resources::ResourceStore", "name": "ResourceStore", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub struct ResourceStore (Rc>);", "cfg": [] }, { "id": "app_host::resources::ResourceStore::clear", "name": "clear", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "Call from Host's release observer while App can still evict GPU atlases.", "documentation": "Call from Host's release observer while App can still evict GPU atlases.", "signature": "pub fn clear (& mut self, cx : & mut App)", "cfg": [], "target": "ResourceStore" }, { "id": "app_host::resources::ResourceStore::reconcile", "name": "reconcile", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "Active authorized mount → generation principal, supplied only by host. Many mounts share one immutable bucket and one generation quota.", "documentation": "Active authorized mount → generation principal, supplied only by host.\nMany mounts share one immutable bucket and one generation quota.", "signature": "pub fn reconcile (& mut self, approved : & HashMap, cx : & mut App)", "cfg": [], "target": "ResourceStore" }, { "id": "app_host::resources::ResourceStore::register", "name": "register", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "Atomic registration: rejection consumes no count/byte quota and may be retried.", "documentation": "Atomic registration: rejection consumes no count/byte quota and may be retried.", "signature": "pub fn register (& mut self, owner : EffectOwner, registration : Registration,) -> Result", "cfg": [], "target": "ResourceStore" }, { "id": "app_host::resources::ResourceStore::revoke", "name": "revoke", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub fn revoke (& mut self, owner : EffectOwner, cx : & mut App)", "cfg": [], "target": "ResourceStore" }, { "id": "app_host::resources::Resources", "name": "Resources", "kind": "struct", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "App contains only a weak view; the Host owns the lifetime via ResourceStore.", "documentation": "App contains only a weak view; the Host owns the lifetime via ResourceStore.", "signature": "# [doc = \" App contains only a weak view; the Host owns the lifetime via ResourceStore.\"] pub struct Resources (Weak>);", "cfg": [] }, { "id": "app_host::resources::Resources::bytes", "name": "bytes", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub fn bytes (reference : & ResourceRef, cx : & App) -> Result", "cfg": [], "target": "Resources" }, { "id": "app_host::resources::Resources::image", "name": "image", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub fn image (reference : & ResourceRef, cx : & App) -> Result", "cfg": [], "target": "Resources" }, { "id": "app_host::resources::Resources::install", "name": "install", "kind": "method", "package": "gpui-box-app-host", "crate": "app_host", "module": "resources", "path": "app_host::resources", "source": "tools/app-host/src/resources.rs", "summary": "", "documentation": "", "signature": "pub fn install (cx : & mut App) -> ResourceStore", "cfg": [], "target": "Resources" }, { "id": "app_host::review_fonts::register_emoji_review_font", "name": "register_emoji_review_font", "kind": "function", "package": "gpui-box-app-host", "crate": "app_host", "module": "review_fonts", "path": "app_host::review_fonts", "source": "tools/app-host/src/review_fonts.rs", "summary": "Add the pinned Noto Color Emoji review fixture to a caller-owned text system.", "documentation": "Add the pinned Noto Color Emoji review fixture to a caller-owned text system.\n\nThis does not enable system font discovery or change default fallback policy.\nCall once per fresh capture text system, before constructing the headless app.", "signature": "pub fn register_emoji_review_font (text_system : & dyn gpui::PlatformTextSystem) -> gpui::Result<()>", "cfg": [] }, { "id": "browser_gallery::start", "name": "start", "kind": "function", "package": "gpui-box-browser-gallery", "crate": "browser_gallery", "module": "", "path": "browser_gallery", "source": "examples/browser-gallery/src/lib.rs", "summary": "", "documentation": "", "signature": "pub fn start ()", "cfg": [] }, { "id": "collections::collections::HashMap", "name": "HashMap", "kind": "type", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub type HashMap = FxHashMap;", "cfg": [] }, { "id": "collections::collections::HashSet", "name": "HashSet", "kind": "type", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub type HashSet = FxHashSet;", "cfg": [] }, { "id": "collections::collections::IndexMap", "name": "IndexMap", "kind": "type", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub type IndexMap = indexmap::IndexMap;", "cfg": [] }, { "id": "collections::collections::IndexSet", "name": "IndexSet", "kind": "type", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub type IndexSet = indexmap::IndexSet;", "cfg": [] }, { "id": "collections::collections::TypeIdHashMap", "name": "TypeIdHashMap", "kind": "type", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub type TypeIdHashMap = std::collections::HashMap;", "cfg": [] }, { "id": "collections::collections::TypeIdHashSet", "name": "TypeIdHashSet", "kind": "type", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub type TypeIdHashSet = std::collections::HashSet;", "cfg": [] }, { "id": "collections::collections::reexport-1", "name": "indexmap :: Equivalent", "kind": "reexport", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub use indexmap::Equivalent;", "cfg": [] }, { "id": "collections::collections::reexport-2", "name": "rustc_hash :: { FxBuildHasher , FxHashMap , FxHashSet , FxHasher }", "kind": "reexport", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub use rustc_hash::{ FxBuildHasher, FxHashMap, FxHashSet, FxHasher };", "cfg": [] }, { "id": "collections::collections::reexport-3", "name": "std :: collections :: *", "kind": "reexport", "package": "gpui-box-collections", "crate": "collections", "module": "collections", "path": "collections::collections", "source": "crates/collections/src/collections.rs", "summary": "", "documentation": "", "signature": "pub use std::collections::*;", "cfg": [] }, { "id": "collections::vecmap::Entry", "name": "Entry", "kind": "enum", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub enum Entry<'a, K, V> { Occupied (OccupiedEntry<'a, K, V>), Vacant (VacantEntry<'a, K, V>), }", "cfg": [] }, { "id": "collections::vecmap::Entry::key", "name": "key", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn key (& self) -> & K", "cfg": [], "target": "Entry<'a, K, V>" }, { "id": "collections::vecmap::Entry::or_insert", "name": "or_insert", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert (self, value : V) -> & 'a mut V", "cfg": [], "target": "Entry<'a, K, V>" }, { "id": "collections::vecmap::Entry::or_insert_default", "name": "or_insert_default", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert_default (self) -> & 'a mut V where V : Default,", "cfg": [], "target": "Entry<'a, K, V>" }, { "id": "collections::vecmap::Entry::or_insert_with", "name": "or_insert_with", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert_with (self, default : F) -> & 'a mut V where F : FnOnce () -> V,", "cfg": [], "target": "Entry<'a, K, V>" }, { "id": "collections::vecmap::Entry::or_insert_with_key", "name": "or_insert_with_key", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert_with_key (self, default : F) -> & 'a mut V where F : FnOnce (& K) -> V,", "cfg": [], "target": "Entry<'a, K, V>" }, { "id": "collections::vecmap::EntryRef", "name": "EntryRef", "kind": "enum", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub enum EntryRef<'key, 'map, K, V> { Occupied (OccupiedEntry<'map, K, V>), Vacant (VacantEntryRef<'key, 'map, K, V>), }", "cfg": [] }, { "id": "collections::vecmap::EntryRef::key", "name": "key", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn key (& self) -> & K", "cfg": [], "target": "EntryRef<'key, 'map, K, V>" }, { "id": "collections::vecmap::EntryRef::or_insert", "name": "or_insert", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert (self, value : V) -> & 'map mut V", "cfg": [], "target": "EntryRef<'key, 'map, K, V>" }, { "id": "collections::vecmap::EntryRef::or_insert_default", "name": "or_insert_default", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert_default (self) -> & 'map mut V where V : Default,", "cfg": [], "target": "EntryRef<'key, 'map, K, V>" }, { "id": "collections::vecmap::EntryRef::or_insert_with", "name": "or_insert_with", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert_with (self, default : F) -> & 'map mut V where F : FnOnce () -> V,", "cfg": [], "target": "EntryRef<'key, 'map, K, V>" }, { "id": "collections::vecmap::EntryRef::or_insert_with_key", "name": "or_insert_with_key", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn or_insert_with_key (self, default : F) -> & 'map mut V where F : FnOnce (& K) -> V,", "cfg": [], "target": "EntryRef<'key, 'map, K, V>" }, { "id": "collections::vecmap::Iter", "name": "Iter", "kind": "struct", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub struct Iter<'a, K, V> { iter : std::iter::Zip, std::slice::Iter<'a, V>>, }", "cfg": [] }, { "id": "collections::vecmap::OccupiedEntry", "name": "OccupiedEntry", "kind": "struct", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub struct OccupiedEntry<'a, K, V> { key : & 'a K, value : & 'a mut V, }", "cfg": [] }, { "id": "collections::vecmap::VacantEntry", "name": "VacantEntry", "kind": "struct", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub struct VacantEntry<'a, K, V> { map : & 'a mut VecMap, key : K, }", "cfg": [] }, { "id": "collections::vecmap::VacantEntryRef", "name": "VacantEntryRef", "kind": "struct", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub struct VacantEntryRef<'key, 'map, K, V> { map : & 'map mut VecMap, key : & 'key K, }", "cfg": [] }, { "id": "collections::vecmap::VecMap", "name": "VecMap", "kind": "struct", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "A collection that provides a map interface but is backed by vectors.", "documentation": "A collection that provides a map interface but is backed by vectors.\n\nThis is suitable for small key-value stores where the item count is not\nlarge enough to overcome the overhead of a more complex algorithm.\n\nIf this meets your use cases, then [`VecMap`] should be a drop-in\nreplacement for [`std::collections::HashMap`] or [`crate::HashMap`]. Note\nthat we are adding APIs on an as-needed basis. If the API you need is not\npresent yet, please add it!\n\nBecause it uses vectors as a backing store, the map also iterates over items\nin insertion order, like [`crate::IndexMap`].\n\nThis struct uses a struct-of-arrays (SoA) representation which tends to be\nmore cache efficient and promotes autovectorization when using simple key or\nvalue types.", "signature": "# [doc = \" A collection that provides a map interface but is backed by vectors.\"] # [doc = \"\"] # [doc = \" This is suitable for small key-value stores where the item count is not\"] # [doc = \" large enough to overcome the overhead of a more complex algorithm.\"] # [doc = \"\"] # [doc = \" If this meets your use cases, then [`VecMap`] should be a drop-in\"] # [doc = \" replacement for [`std::collections::HashMap`] or [`crate::HashMap`]. Note\"] # [doc = \" that we are adding APIs on an as-needed basis. If the API you need is not\"] # [doc = \" present yet, please add it!\"] # [doc = \"\"] # [doc = \" Because it uses vectors as a backing store, the map also iterates over items\"] # [doc = \" in insertion order, like [`crate::IndexMap`].\"] # [doc = \"\"] # [doc = \" This struct uses a struct-of-arrays (SoA) representation which tends to be\"] # [doc = \" more cache efficient and promotes autovectorization when using simple key or\"] # [doc = \" value types.\"] # [derive (Default)] pub struct VecMap { keys : Vec, values : Vec, }", "cfg": [] }, { "id": "collections::vecmap::VecMap::entry", "name": "entry", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn entry (& mut self, key : K) -> Entry<'_, K, V>", "cfg": [], "target": "VecMap" }, { "id": "collections::vecmap::VecMap::entry_ref", "name": "entry_ref", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "Like [`Self::entry`] but takes its key by reference instead of by value.", "documentation": "Like [`Self::entry`] but takes its key by reference instead of by value.\n\nThis can be helpful if you have a key where cloning is expensive, as we\ncan avoid cloning the key until a value is inserted under that entry.", "signature": "pub fn entry_ref<'a, 'k> (& 'a mut self, key : & 'k K) -> EntryRef<'k, 'a, K, V>", "cfg": [], "target": "VecMap" }, { "id": "collections::vecmap::VecMap::iter", "name": "iter", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn iter (& self) -> Iter<'_, K, V>", "cfg": [], "target": "VecMap" }, { "id": "collections::vecmap::VecMap::new", "name": "new", "kind": "method", "package": "gpui-box-collections", "crate": "collections", "module": "vecmap", "path": "collections::vecmap", "source": "crates/collections/src/vecmap.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "VecMap" }, { "id": "derive_refineable::derive_refineable::derive_refineable", "name": "derive_refineable", "kind": "function", "package": "gpui-box-refineable-derive", "crate": "derive_refineable", "module": "derive_refineable", "path": "derive_refineable::derive_refineable", "source": "crates/refineable/derive_refineable/src/derive_refineable.rs", "summary": "", "documentation": "", "signature": "pub fn derive_refineable (input : TokenStream) -> TokenStream", "cfg": [] }, { "id": "gallery::recipes::footnote", "name": "footnote", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn footnote (theme : & Theme, text : impl Into) -> gpui::Div", "cfg": [] }, { "id": "gallery::recipes::identity_tile", "name": "identity_tile", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn identity_tile (theme : & Theme, glyph : Icon) -> gpui::Div", "cfg": [] }, { "id": "gallery::recipes::page", "name": "page", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn page (theme : & Theme) -> gpui::Div", "cfg": [] }, { "id": "gallery::recipes::page_header", "name": "page_header", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn page_header (theme : & Theme, title : impl Into, count : Option,) -> gpui::Div", "cfg": [] }, { "id": "gallery::recipes::row_content", "name": "row_content", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn row_content (theme : & Theme, title : impl Into, detail : impl Into,) -> gpui::Div", "cfg": [] }, { "id": "gallery::recipes::section_title", "name": "section_title", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn section_title (theme : & Theme, text : impl Into) -> gpui::Div", "cfg": [] }, { "id": "gallery::recipes::subtitle", "name": "subtitle", "kind": "function", "package": "gpui-box-gallery", "crate": "gallery", "module": "recipes", "path": "gallery::recipes", "source": "examples/gallery/src/recipes.rs", "summary": "", "documentation": "", "signature": "pub fn subtitle (theme : & Theme, text : impl Into) -> gpui::Div", "cfg": [] }, { "id": "gpui::action::Action", "name": "Action", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "Actions are used to implement keyboard-driven UI. When you declare an action, you can bind keys to the action in the keymap and listeners for that action in the element tree.", "documentation": "Actions are used to implement keyboard-driven UI. When you declare an action, you can bind keys\nto the action in the keymap and listeners for that action in the element tree.\n\nTo declare a list of simple actions, you can use the actions! macro, which defines a simple unit\nstruct action for each listed action name in the given namespace.\n\n```\nuse gpui::actions;\nactions!(editor, [MoveUp, MoveDown, MoveLeft, MoveRight, Newline]);\n```\n\nRegistering the actions with the same name will result in a panic during `App` creation.\n\n# Derive Macro\n\nMore complex data types can also be actions, by using the derive macro for `Action`:\n\n```\nuse gpui::Action;\n#[derive(Clone, PartialEq, serde::Deserialize, schemars::JsonSchema, Action)]\n#[action(namespace = editor)]\npub struct SelectNext {\npub replace_newest: bool,\n}\n```\n\nThe derive macro for `Action` requires that the type implement `Clone` and `PartialEq`. It also\nrequires `serde::Deserialize` and `schemars::JsonSchema` unless `#[action(no_json)]` is\nspecified. In Zed these trait impls are used to load keymaps from JSON.\n\nMultiple arguments separated by commas may be specified in `#[action(...)]`:\n\n- `namespace = some_namespace` sets the namespace. In Zed this is required.\n\n- `name = \"ActionName\"` overrides the action's name. This must not contain `::`.\n\n- `no_json` causes the `build` method to always error and `action_json_schema` to return `None`,\nand allows actions not implement `serde::Serialize` and `schemars::JsonSchema`.\n\n- `no_register` skips registering the action. This is useful for implementing the `Action` trait\nwhile not supporting invocation by name or JSON deserialization.\n\n- `deprecated_aliases = [\"editor::SomeAction\"]` specifies deprecated old names for the action.\nThese action names should *not* correspond to any actions that are registered. These old names\ncan then still be used to refer to invoke this action. In Zed, the keymap JSON schema will\naccept these old names and provide warnings.\n\n- `deprecated = \"Message about why this action is deprecation\"` specifies a deprecation message.\nIn Zed, the keymap JSON schema will cause this to be displayed as a warning.\n\n# Manual Implementation\n\nIf you want to control the behavior of the action trait manually, you can use the lower-level\n`#[register_action]` macro, which only generates the code needed to register your action before\n`main`.\n\n```\nuse gpui::{SharedString, register_action};\n#[derive(Clone, PartialEq, Eq, serde::Deserialize, schemars::JsonSchema)]\npub struct Paste {\npub content: SharedString,\n}\n\nimpl gpui::Action for Paste {\n# fn boxed_clone(&self) -> Box { unimplemented!()}\n# fn partial_eq(&self, other: &dyn gpui::Action) -> bool { unimplemented!() }\n# fn name(&self) -> &'static str { \"Paste\" }\n# fn name_for_type() -> &'static str { \"Paste\" }\n# fn build(value: serde_json::Value) -> anyhow::Result> {\n# unimplemented!()\n# }\n}\n\nregister_action!(Paste);\n```", "signature": "# [doc = \" Actions are used to implement keyboard-driven UI. When you declare an action, you can bind keys\"] # [doc = \" to the action in the keymap and listeners for that action in the element tree.\"] # [doc = \"\"] # [doc = \" To declare a list of simple actions, you can use the actions! macro, which defines a simple unit\"] # [doc = \" struct action for each listed action name in the given namespace.\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" use gpui::actions;\"] # [doc = \" actions!(editor, [MoveUp, MoveDown, MoveLeft, MoveRight, Newline]);\"] # [doc = \" ```\"] # [doc = \"\"] # [doc = \" Registering the actions with the same name will result in a panic during `App` creation.\"] # [doc = \"\"] # [doc = \" # Derive Macro\"] # [doc = \"\"] # [doc = \" More complex data types can also be actions, by using the derive macro for `Action`:\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" use gpui::Action;\"] # [doc = \" #[derive(Clone, PartialEq, serde::Deserialize, schemars::JsonSchema, Action)]\"] # [doc = \" #[action(namespace = editor)]\"] # [doc = \" pub struct SelectNext {\"] # [doc = \" pub replace_newest: bool,\"] # [doc = \" }\"] # [doc = \" ```\"] # [doc = \"\"] # [doc = \" The derive macro for `Action` requires that the type implement `Clone` and `PartialEq`. It also\"] # [doc = \" requires `serde::Deserialize` and `schemars::JsonSchema` unless `#[action(no_json)]` is\"] # [doc = \" specified. In Zed these trait impls are used to load keymaps from JSON.\"] # [doc = \"\"] # [doc = \" Multiple arguments separated by commas may be specified in `#[action(...)]`:\"] # [doc = \"\"] # [doc = \" - `namespace = some_namespace` sets the namespace. In Zed this is required.\"] # [doc = \"\"] # [doc = \" - `name = \\\"ActionName\\\"` overrides the action's name. This must not contain `::`.\"] # [doc = \"\"] # [doc = \" - `no_json` causes the `build` method to always error and `action_json_schema` to return `None`,\"] # [doc = \" and allows actions not implement `serde::Serialize` and `schemars::JsonSchema`.\"] # [doc = \"\"] # [doc = \" - `no_register` skips registering the action. This is useful for implementing the `Action` trait\"] # [doc = \" while not supporting invocation by name or JSON deserialization.\"] # [doc = \"\"] # [doc = \" - `deprecated_aliases = [\\\"editor::SomeAction\\\"]` specifies deprecated old names for the action.\"] # [doc = \" These action names should *not* correspond to any actions that are registered. These old names\"] # [doc = \" can then still be used to refer to invoke this action. In Zed, the keymap JSON schema will\"] # [doc = \" accept these old names and provide warnings.\"] # [doc = \"\"] # [doc = \" - `deprecated = \\\"Message about why this action is deprecation\\\"` specifies a deprecation message.\"] # [doc = \" In Zed, the keymap JSON schema will cause this to be displayed as a warning.\"] # [doc = \"\"] # [doc = \" # Manual Implementation\"] # [doc = \"\"] # [doc = \" If you want to control the behavior of the action trait manually, you can use the lower-level\"] # [doc = \" `#[register_action]` macro, which only generates the code needed to register your action before\"] # [doc = \" `main`.\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" use gpui::{SharedString, register_action};\"] # [doc = \" #[derive(Clone, PartialEq, Eq, serde::Deserialize, schemars::JsonSchema)]\"] # [doc = \" pub struct Paste {\"] # [doc = \" pub content: SharedString,\"] # [doc = \" }\"] # [doc = \"\"] # [doc = \" impl gpui::Action for Paste {\"] # [doc = \" # fn boxed_clone(&self) -> Box { unimplemented!()}\"] # [doc = \" # fn partial_eq(&self, other: &dyn gpui::Action) -> bool { unimplemented!() }\"] # [doc = \" # fn name(&self) -> &'static str { \\\"Paste\\\" }\"] # [doc = \" # fn name_for_type() -> &'static str { \\\"Paste\\\" }\"] # [doc = \" # fn build(value: serde_json::Value) -> anyhow::Result> {\"] # [doc = \" # unimplemented!()\"] # [doc = \" # }\"] # [doc = \" }\"] # [doc = \"\"] # [doc = \" register_action!(Paste);\"] # [doc = \" ```\"] pub trait Action : Any + Send { # [doc = \" Clone the action into a new box\"] fn boxed_clone (& self) -> Box; # [doc = \" Do a partial equality check on this action and the other\"] fn partial_eq (& self, action : & dyn Action) -> bool; # [doc = \" Get the name of this action, for displaying in UI\"] fn name (& self) -> & 'static str; # [doc = \" Get the name of this action type (static)\"] fn name_for_type () -> & 'static str where Self : Sized; # [doc = \" Build this action from a JSON value. This is used to construct actions from the keymap.\"] # [doc = \" A value of `{}` will be passed for actions that don't have any parameters.\"] fn build (value : serde_json::Value) -> Result> where Self : Sized; # [doc = \" Optional JSON schema for the action's input data.\"] fn action_json_schema (_ : & mut schemars::SchemaGenerator) -> Option where Self : Sized, { None } # [doc = \" A list of alternate, deprecated names for this action. These names can still be used to\"] # [doc = \" invoke the action. In Zed, the keymap JSON schema will accept these old names and provide\"] # [doc = \" warnings.\"] fn deprecated_aliases () -> & 'static [& 'static str] where Self : Sized, { & [] } # [doc = \" Returns the deprecation message for this action, if any. In Zed, the keymap JSON schema will\"] # [doc = \" cause this to be displayed as a warning.\"] fn deprecation_message () -> Option<& 'static str> where Self : Sized, { None } # [doc = \" The documentation for this action, if any. When using the derive macro for actions\"] # [doc = \" this will be automatically generated from the doc comments on the action struct.\"] fn documentation () -> Option<& 'static str> where Self : Sized, { None } }", "cfg": [] }, { "id": "gpui::action::ActionBuildError", "name": "ActionBuildError", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "Error type for `Keystroke::parse`. This is used instead of `anyhow::Error` so that Zed can use markdown to display it.", "documentation": "Error type for `Keystroke::parse`. This is used instead of `anyhow::Error` so that Zed can use\nmarkdown to display it.", "signature": "# [doc = \" Error type for `Keystroke::parse`. This is used instead of `anyhow::Error` so that Zed can use\"] # [doc = \" markdown to display it.\"] # [derive (Debug)] pub enum ActionBuildError { # [doc = \" Indicates that an action with this name has not been registered.\"] NotFound { # [doc = \" Name of the action that was not found.\"] name : String, }, # [doc = \" Indicates that an error occurred while building the action, typically a JSON deserialization\"] # [doc = \" error.\"] BuildError { # [doc = \" Name of the action that was attempting to be built.\"] name : String, # [doc = \" Error that occurred while building the action.\"] error : anyhow::Error, }, }", "cfg": [] }, { "id": "gpui::action::ActionRegistry::action_schema_by_name", "name": "action_schema_by_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub fn action_schema_by_name (& self, name : & str, generator : & mut schemars::SchemaGenerator,) -> Option>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::action_schemas", "name": "action_schemas", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub fn action_schemas (& self, generator : & mut schemars::SchemaGenerator,) -> Vec<(& 'static str, Option)>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::all_action_names", "name": "all_action_names", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub fn all_action_names (& self) -> & [& 'static str]", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::build_action", "name": "build_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "Construct an action based on its name and optional JSON parameters sourced from the keymap.", "documentation": "Construct an action based on its name and optional JSON parameters sourced from the keymap.", "signature": "pub fn build_action (& self, name : & str, params : Option,) -> std::result::Result, ActionBuildError>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::build_action_type", "name": "build_action_type", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "Construct an action based on its name and optional JSON parameters sourced from the keymap.", "documentation": "Construct an action based on its name and optional JSON parameters sourced from the keymap.", "signature": "pub fn build_action_type (& self, type_id : & TypeId) -> Result>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::deprecated_aliases", "name": "deprecated_aliases", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub fn deprecated_aliases (& self) -> & HashMap<& 'static str, & 'static str>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::deprecation_messages", "name": "deprecation_messages", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub fn deprecation_messages (& self) -> & HashMap<& 'static str, & 'static str>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::ActionRegistry::documentation", "name": "documentation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub fn documentation (& self) -> & HashMap<& 'static str, & 'static str>", "cfg": [], "target": "ActionRegistry" }, { "id": "gpui::action::MacroActionBuilder", "name": "MacroActionBuilder", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "This type must be public so that our macros can build it in other crates. But this is an implementation detail and should not be used directly.", "documentation": "This type must be public so that our macros can build it in other crates.\nBut this is an implementation detail and should not be used directly.", "signature": "# [doc = \" This type must be public so that our macros can build it in other crates.\"] # [doc = \" But this is an implementation detail and should not be used directly.\"] # [doc (hidden)] pub struct MacroActionBuilder (pub fn () -> MacroActionData);", "cfg": [] }, { "id": "gpui::action::MacroActionData", "name": "MacroActionData", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "This type must be public so that our macros can build it in other crates. But this is an implementation detail and should not be used directly.", "documentation": "This type must be public so that our macros can build it in other crates.\nBut this is an implementation detail and should not be used directly.", "signature": "# [doc = \" This type must be public so that our macros can build it in other crates.\"] # [doc = \" But this is an implementation detail and should not be used directly.\"] # [doc (hidden)] pub struct MacroActionData { pub name : & 'static str, pub type_id : TypeId, pub build : ActionBuilder, pub json_schema : fn (& mut schemars::SchemaGenerator) -> Option, pub deprecated_aliases : & 'static [& 'static str], pub deprecation_message : Option<& 'static str>, pub documentation : Option<& 'static str>, }", "cfg": [] }, { "id": "gpui::action::actions", "name": "actions", "kind": "macro", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "Defines and registers unit structs that can be used as actions. For more complex data types, derive `Action`.", "documentation": "Defines and registers unit structs that can be used as actions. For more complex data types, derive `Action`.\n\nFor example:\n\n```\nuse gpui::actions;\nactions!(editor, [MoveUp, MoveDown, MoveLeft, MoveRight, Newline]);\n```\n\nThis will create actions with names like `editor::MoveUp`, `editor::MoveDown`, etc.\n\nThe namespace argument `editor` can also be omitted, though it is required for Zed actions.", "signature": "macro_rules! actions", "cfg": [] }, { "id": "gpui::action::generate_list_of_all_registered_actions", "name": "generate_list_of_all_registered_actions", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "Generate a list of all the registered actions. Useful for transforming the list of available actions into a format suited for static analysis such as in validating keymaps, or generating documentation.", "documentation": "Generate a list of all the registered actions.\nUseful for transforming the list of available actions into a\nformat suited for static analysis such as in validating keymaps, or\ngenerating documentation.", "signature": "pub fn generate_list_of_all_registered_actions () -> impl Iterator", "cfg": [] }, { "id": "gpui::action::reexport-1", "name": "gpui_macros :: Action", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub use gpui_macros::Action;", "cfg": [] }, { "id": "gpui::action::reexport-2", "name": "no_action :: { NoAction , Unbind , is_no_action , is_unbind }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "action", "path": "gpui::action", "source": "crates/gpui/src/action.rs", "summary": "", "documentation": "", "signature": "pub use no_action::{ NoAction, Unbind, is_no_action, is_unbind };", "cfg": [] }, { "id": "gpui::app::AnyDrag", "name": "AnyDrag", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Contains state associated with an active drag operation, started by dragging an element within the window or by dragging into the app from the underlying platform.", "documentation": "Contains state associated with an active drag operation, started by dragging an element\nwithin the window or by dragging into the app from the underlying platform.", "signature": "# [doc = \" Contains state associated with an active drag operation, started by dragging an element\"] # [doc = \" within the window or by dragging into the app from the underlying platform.\"] pub struct AnyDrag { # [doc = \" Owner captured at drag creation. OS-originated drags have no owner.\"] pub effect_owner : Option, # [doc = \" The view used to render this drag\"] pub view : AnyView, # [doc = \" The value of the dragged item, to be dropped\"] pub value : Arc, # [doc = \" This is used to render the dragged item in the same place\"] # [doc = \" on the original element that the drag was initiated\"] pub cursor_offset : Point, # [doc = \" The cursor style to use while dragging\"] pub cursor_style : Option, # [doc = \" Resolves the payload to offer the platform if the drag leaves the window.\"] # [doc = \" Invoked at most once per drag gesture, at promotion time.\"] pub external_payload_source : Option, }", "cfg": [] }, { "id": "gpui::app::AnyTooltip", "name": "AnyTooltip", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Contains state associated with a tooltip. You'll only need this struct if you're implementing tooltip behavior on a custom element. Otherwise, use [Div::tooltip](crate::Interactivity::tooltip).", "documentation": "Contains state associated with a tooltip. You'll only need this struct if you're implementing\ntooltip behavior on a custom element. Otherwise, use [Div::tooltip](crate::Interactivity::tooltip).", "signature": "# [doc = \" Contains state associated with a tooltip. You'll only need this struct if you're implementing\"] # [doc = \" tooltip behavior on a custom element. Otherwise, use [Div::tooltip](crate::Interactivity::tooltip).\"] # [derive (Clone)] pub struct AnyTooltip { # [doc = \" The view used to display the tooltip\"] pub view : AnyView, # [doc = \" The absolute position of the mouse when the tooltip was deployed.\"] pub mouse_position : Point, # [doc = \" Given the bounds of the tooltip, checks whether the tooltip should still be visible and\"] # [doc = \" updates its state accordingly. This is needed atop the hovered element's mouse move handler\"] # [doc = \" to handle the case where the element is not painted (e.g. via use of `visible_on_hover`).\"] pub check_visible_and_update : Rc, & mut Window, & mut App) -> bool>, }", "cfg": [] }, { "id": "gpui::app::App", "name": "App", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Contains the state of the full application, and passed as a reference to a variety of callbacks. Other [Context] derefs to this type. You need a reference to an `App` to access the state of a [Entity].", "documentation": "Contains the state of the full application, and passed as a reference to a variety of callbacks.\nOther [Context] derefs to this type.\nYou need a reference to an `App` to access the state of a [Entity].", "signature": "# [doc = \" Contains the state of the full application, and passed as a reference to a variety of callbacks.\"] # [doc = \" Other [Context] derefs to this type.\"] # [doc = \" You need a reference to an `App` to access the state of a [Entity].\"] pub struct App { pub (crate) this : Weak, pub (crate) platform : Rc, pub (crate) effect_owner : Rc>>, pub (crate) clipboard_policy : Option, pub (crate) native_menu_revision : Option, text_system : Arc, pub (crate) actions : Rc, pub (crate) active_drag : Option, platform_owned_drag : Option, pub (crate) background_executor : BackgroundExecutor, pub (crate) foreground_executor : ForegroundExecutor, pub (crate) entities : EntityMap, pub (crate) new_entity_observers : SubscriberSet, pub (crate) windows : SlotMap>>, pub (crate) window_handles : FxHashMap, pub (crate) focus_handles : Arc, pub (crate) keymap : Rc>, pub (crate) keyboard_layout : Box, pub (crate) keyboard_mapper : Rc, pub (crate) global_action_listeners : TypeIdHashMap>>, pending_effects : VecDeque, pub (crate) observers : SubscriberSet, pub (crate) event_listeners : SubscriberSet, pub (crate) keystroke_observers : SubscriberSet<(), KeystrokeObserver>, pub (crate) keystroke_interceptors : SubscriberSet<(), KeystrokeObserver>, pub (crate) keyboard_layout_observers : SubscriberSet<(), Handler>, pub (crate) thermal_state_observers : SubscriberSet<(), Handler>, pub (crate) release_listeners : SubscriberSet, pub (crate) global_observers : SubscriberSet, pub (crate) quit_observers : SubscriberSet<(), QuitHandler>, pub (crate) restart_observers : SubscriberSet<(), Handler>, pub (crate) window_closed_observers : SubscriberSet<(), WindowClosedHandler>, # [doc = \" Per-App element arena. This isolates element allocations between different\"] # [doc = \" App instances (important for tests where multiple Apps run concurrently).\"] pub (crate) element_arena : RefCell, # [doc = \" Per-App event arena.\"] pub (crate) event_arena : Arena, pub (crate) globals_by_type : TypeIdHashMap>, pub (crate) loading_assets : FxHashMap<(TypeId, u64), Box>, asset_source : Arc, pub (crate) svg_renderer : SvgRenderer, http_client : Arc, pub (crate) pending_notifications : FxHashSet, pub (crate) pending_global_notifications : TypeIdHashSet, pub (crate) restart_path : Option, pub (crate) layout_id_buffer : Vec, pub (crate) propagate_event : bool, pub (crate) prompt_builder : Option, pub (crate) window_invalidators_by_entity : FxHashMap>, pub (crate) tracked_entities : FxHashMap>, pub (crate) current_window_by_entity : FxHashMap, # [cfg (any (feature = \"inspector\", debug_assertions))] pub (crate) inspector_renderer : Option, # [cfg (any (feature = \"inspector\", debug_assertions))] pub (crate) inspector_element_registry : InspectorElementRegistry, # [cfg (any (test, feature = \"test-support\", debug_assertions))] pub (crate) name : Option<& 'static str>, pub (crate) text_rendering_mode : Rc>, pub (crate) window_update_stack : Vec, pub (crate) mode : GpuiMode, pub (crate) cursor_hide_mode : CursorHideMode, pub (crate) reduce_motion : bool, # [doc = \" Whether the app was created by [`Application::new_inaccessible`]. No\"] # [doc = \" accesskit APIs will be called when this flag is set.\"] pub (crate) accessibility_force_disabled : bool, flushing_effects : bool, pending_updates : usize, quit_mode : QuitMode, quitting : bool, # [cfg (any (test, feature = \"leak-detection\"))] _ref_counts : Arc>, }", "cfg": [] }, { "id": "gpui::app::App::action_deprecation_messages", "name": "action_deprecation_messages", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get a map from an action name to the deprecation messages.", "documentation": "Get a map from an action name to the deprecation messages.", "signature": "pub fn action_deprecation_messages (& self) -> & HashMap<& 'static str, & 'static str>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::action_documentation", "name": "action_documentation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get a map from an action name to the documentation.", "documentation": "Get a map from an action name to the documentation.", "signature": "pub fn action_documentation (& self) -> & HashMap<& 'static str, & 'static str>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::action_schema_by_name", "name": "action_schema_by_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get the schema for a specific action by name. Returns `None` if the action is not found. Returns `Some(None)` if the action exists but has no schema. Returns `Some(Some(schema))` if the action exists and has a schema.", "documentation": "Get the schema for a specific action by name.\nReturns `None` if the action is not found.\nReturns `Some(None)` if the action exists but has no schema.\nReturns `Some(Some(schema))` if the action exists and has a schema.", "signature": "pub fn action_schema_by_name (& self, name : & str, generator : & mut schemars::SchemaGenerator,) -> Option>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::action_schemas", "name": "action_schemas", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get all non-internal actions that have been registered, along with their schemas.", "documentation": "Get all non-internal actions that have been registered, along with their schemas.", "signature": "pub fn action_schemas (& self, generator : & mut schemars::SchemaGenerator,) -> Vec<(& 'static str, Option)>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::activate", "name": "activate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Instructs the platform to activate the application by bringing it to the foreground.", "documentation": "Instructs the platform to activate the application by bringing it to the foreground.", "signature": "pub fn activate (& self, ignoring_other_apps : bool)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::active_drag_cursor_style", "name": "active_drag_cursor_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Gets the cursor style of the currently active drag operation.", "documentation": "Gets the cursor style of the currently active drag operation.", "signature": "pub fn active_drag_cursor_style (& self) -> Option", "cfg": [], "target": "App" }, { "id": "gpui::app::App::active_window", "name": "active_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns a handle to the window that is currently focused at the platform level, if one exists.", "documentation": "Returns a handle to the window that is currently focused at the platform level, if one exists.", "signature": "pub fn active_window (& self) -> Option", "cfg": [], "target": "App" }, { "id": "gpui::app::App::add_recent_document", "name": "add_recent_document", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Adds given path to the bottom of the list of recent paths for the application. The list is usually shown on the application icon's context menu in the dock, and allows to open the recent files via that context menu. If the path is already in the list, it will be moved to the bottom of the list.", "documentation": "Adds given path to the bottom of the list of recent paths for the application.\nThe list is usually shown on the application icon's context menu in the dock,\nand allows to open the recent files via that context menu.\nIf the path is already in the list, it will be moved to the bottom of the list.", "signature": "pub fn add_recent_document (& self, path : & Path)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::all_action_names", "name": "all_action_names", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get all action names that have been registered. Note that registration only allows for actions to be built dynamically, and is unrelated to binding actions in the element tree.", "documentation": "Get all action names that have been registered. Note that registration only allows for\nactions to be built dynamically, and is unrelated to binding actions in the element tree.", "signature": "pub fn all_action_names (& self) -> & [& 'static str]", "cfg": [], "target": "App" }, { "id": "gpui::app::App::all_bindings_for_input", "name": "all_bindings_for_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns key bindings that invoke the given action on the currently focused element, without checking context. Bindings are returned in the order they were added. For display, the last binding should take precedence.", "documentation": "Returns key bindings that invoke the given action on the currently focused element, without\nchecking context. Bindings are returned in the order they were added. For display, the last\nbinding should take precedence.", "signature": "pub fn all_bindings_for_input (& self, input : & [Keystroke]) -> Vec", "cfg": [], "target": "App" }, { "id": "gpui::app::App::app_path", "name": "app_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the full pathname of the current app bundle.", "documentation": "Returns the full pathname of the current app bundle.\n\nReturns an error if the app is not being run from a bundle.", "signature": "pub fn app_path (& self) -> Result", "cfg": [], "target": "App" }, { "id": "gpui::app::App::assert_no_new_leaks", "name": "assert_no_new_leaks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Asserts that no entities created after `snapshot` still have alive handles.", "documentation": "Asserts that no entities created after `snapshot` still have alive handles.\n\nEntities that were already tracked at the time of the snapshot are ignored,\neven if they still have handles. Only *new* entities (those whose\n`EntityId` was not present in the snapshot) are considered leaks.\n\n# Panics\n\nPanics if any new entity handles exist. The panic message lists every\nleaked entity with its type name, and includes allocation-site backtraces\nwhen `LEAK_BACKTRACE` is set.", "signature": "pub fn assert_no_new_leaks (& self, snapshot : & LeakDetectorSnapshot)", "cfg": [ "cfg (any (test, feature = \"leak-detection\"))" ], "target": "App" }, { "id": "gpui::app::App::asset_source", "name": "asset_source", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Accessor for the application's asset source, which is provided when constructing the `App`.", "documentation": "Accessor for the application's asset source, which is provided when constructing the `App`.", "signature": "pub fn asset_source (& self) -> & Arc", "cfg": [], "target": "App" }, { "id": "gpui::app::App::background_executor", "name": "background_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Obtains a reference to the executor, which can be used to spawn futures.", "documentation": "Obtains a reference to the executor, which can be used to spawn futures.", "signature": "pub fn background_executor (& self) -> & BackgroundExecutor", "cfg": [], "target": "App" }, { "id": "gpui::app::App::bind_keys", "name": "bind_keys", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register key bindings.", "documentation": "Register key bindings.", "signature": "pub fn bind_keys (& mut self, bindings : impl IntoIterator)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::build_action", "name": "build_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Build an action from some arbitrary data, typically a keymap entry.", "documentation": "Build an action from some arbitrary data, typically a keymap entry.", "signature": "pub fn build_action (& self, name : & str, data : Option,) -> std::result::Result, ActionBuildError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::button_layout", "name": "button_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the window button layout configuration when supported.", "documentation": "Returns the window button layout configuration when supported.", "signature": "pub fn button_layout (& self) -> Option", "cfg": [], "target": "App" }, { "id": "gpui::app::App::can_select_mixed_files_and_dirs", "name": "can_select_mixed_files_and_dirs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns `true` if the platform file picker supports selecting a mix of files and directories.", "documentation": "Returns `true` if the platform file picker supports selecting a mix of files and directories.", "signature": "pub fn can_select_mixed_files_and_dirs (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::clear_globals", "name": "clear_globals", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Clear all stored globals. Does not notify global observers.", "documentation": "Clear all stored globals. Does not notify global observers.", "signature": "pub fn clear_globals (& mut self)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "App" }, { "id": "gpui::app::App::clear_key_bindings", "name": "clear_key_bindings", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Clear all key bindings in the app.", "documentation": "Clear all key bindings in the app.", "signature": "pub fn clear_key_bindings (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::compositor_name", "name": "compositor_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "On Linux, returns the name of the compositor in use.", "documentation": "On Linux, returns the name of the compositor in use.\n\nReturns an empty string on other platforms.", "signature": "pub fn compositor_name (& self) -> & 'static str", "cfg": [], "target": "App" }, { "id": "gpui::app::App::cursor_hide_mode", "name": "cursor_hide_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the current policy for hiding the cursor in response to keyboard input.", "documentation": "Returns the current policy for hiding the cursor in response to\nkeyboard input.", "signature": "pub fn cursor_hide_mode (& self) -> CursorHideMode", "cfg": [], "target": "App" }, { "id": "gpui::app::App::default_global", "name": "default_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Access the global of the given type mutably. A default value is assigned if a global of this type has not yet been assigned.", "documentation": "Access the global of the given type mutably. A default value is assigned if a global of this type has not\nyet been assigned.", "signature": "pub fn default_global (& mut self) -> & mut G", "cfg": [], "target": "App" }, { "id": "gpui::app::App::defer", "name": "defer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Schedules the given function to be run at the end of the current effect cycle, allowing entities that are currently on the stack to be returned to the app.", "documentation": "Schedules the given function to be run at the end of the current effect cycle, allowing entities\nthat are currently on the stack to be returned to the app.", "signature": "pub fn defer (& mut self, f : impl FnOnce (& mut App) + 'static)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::delete_credentials", "name": "delete_credentials", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Deletes credentials from the platform keychain.", "documentation": "Deletes credentials from the platform keychain.", "signature": "pub fn delete_credentials (& self, url : & str) -> Task>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::deprecated_actions_to_preferred_actions", "name": "deprecated_actions_to_preferred_actions", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get a map from a deprecated action name to the canonical name.", "documentation": "Get a map from a deprecated action name to the canonical name.", "signature": "pub fn deprecated_actions_to_preferred_actions (& self) -> & HashMap<& 'static str, & 'static str>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::dismiss_system_notification", "name": "dismiss_system_notification", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Removes the delivered or pending notification with this tag.", "documentation": "Removes the delivered or pending notification with this tag.\n\nBest-effort: some platforms cannot retract a notification once shown,\nin which case it ages out of the notification center on its own.", "signature": "pub fn dismiss_system_notification (& self, tag : & str)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::dispatch_action", "name": "dispatch_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Dispatch an action to the currently active window or global action handler See [`crate::Action`] for more information on how actions work", "documentation": "Dispatch an action to the currently active window or global action handler\nSee [`crate::Action`] for more information on how actions work", "signature": "pub fn dispatch_action (& mut self, action : & dyn Action)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::displays", "name": "displays", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the list of currently active displays.", "documentation": "Returns the list of currently active displays.", "signature": "pub fn displays (& self) -> Vec>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::drop_image", "name": "drop_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Removes an image from the sprite atlas on all windows.", "documentation": "Removes an image from the sprite atlas on all windows.\n\nIf the current window is being updated, it will be removed from `App.windows`, you can use `current_window` to specify the current window.\nThis is a no-op if the image is not in the sprite atlas.", "signature": "pub fn drop_image (& mut self, image : Arc, current_window : Option<& mut Window>)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::fetch_asset", "name": "fetch_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Asynchronously load an asset, if the asset hasn't finished loading this will return None.", "documentation": "Asynchronously load an asset, if the asset hasn't finished loading this will return None.\n\nNote that the multiple calls to this method will only result in one `Asset::load` call at a\ntime, and the results of this call will be cached", "signature": "pub fn fetch_asset (& mut self, source : & A::Source) -> (Shared>, bool)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::find_display", "name": "find_display", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the display with the given ID, if one exists.", "documentation": "Returns the display with the given ID, if one exists.", "signature": "pub fn find_display (& self, id : DisplayId) -> Option>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::focus_handle", "name": "focus_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Obtain a new [`FocusHandle`], which allows you to track and manipulate the keyboard focus for elements rendered within this window.", "documentation": "Obtain a new [`FocusHandle`], which allows you to track and manipulate the keyboard focus\nfor elements rendered within this window.", "signature": "pub fn focus_handle (& self) -> FocusHandle", "cfg": [], "target": "App" }, { "id": "gpui::app::App::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Obtains a reference to the executor, which can be used to spawn futures.", "documentation": "Obtains a reference to the executor, which can be used to spawn futures.", "signature": "pub fn foreground_executor (& self) -> & ForegroundExecutor", "cfg": [], "target": "App" }, { "id": "gpui::app::App::get_menus", "name": "get_menus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Gets the menu bar for this application.", "documentation": "Gets the menu bar for this application.", "signature": "pub fn get_menus (& self) -> Option>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::get_name", "name": "get_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the name for this [`App`].", "documentation": "Returns the name for this [`App`].", "signature": "pub fn get_name (& self) -> Option<& 'static str>", "cfg": [ "cfg (any (test, feature = \"test-support\", debug_assertions))" ], "target": "App" }, { "id": "gpui::app::App::global", "name": "global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Access the global of the given type. Panics if a global for that type has not been assigned.", "documentation": "Access the global of the given type. Panics if a global for that type has not been assigned.", "signature": "pub fn global (& self) -> & G", "cfg": [], "target": "App" }, { "id": "gpui::app::App::global_mut", "name": "global_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Access the global of the given type mutably. Panics if a global for that type has not been assigned.", "documentation": "Access the global of the given type mutably. Panics if a global for that type has not been assigned.", "signature": "pub fn global_mut (& mut self) -> & mut G", "cfg": [], "target": "App" }, { "id": "gpui::app::App::has_active_drag", "name": "has_active_drag", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Is there currently something being dragged?", "documentation": "Is there currently something being dragged?", "signature": "pub fn has_active_drag (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::has_asset", "name": "has_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Check whether an asset is present in GPUI's cache (loading or loaded), without fetching it.", "documentation": "Check whether an asset is present in GPUI's cache (loading or loaded),\nwithout fetching it.", "signature": "pub fn has_asset (& self, source : & A::Source) -> bool", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "App" }, { "id": "gpui::app::App::has_global", "name": "has_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Check whether a global of the given type has been assigned.", "documentation": "Check whether a global of the given type has been assigned.", "signature": "pub fn has_global (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::hide", "name": "hide", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Hide the application at the platform level. May do nothing on mobile; use [`Self::try_hide`] to receive a refusal.", "documentation": "Hide the application at the platform level.\nMay do nothing on mobile; use [`Self::try_hide`] to receive a refusal.", "signature": "pub fn hide (& self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::hide_other_apps", "name": "hide_other_apps", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Hide other applications at the platform level. May do nothing on mobile; use [`Self::try_hide_other_apps`].", "documentation": "Hide other applications at the platform level.\nMay do nothing on mobile; use [`Self::try_hide_other_apps`].", "signature": "pub fn hide_other_apps (& self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::http_client", "name": "http_client", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the HTTP client for the application.", "documentation": "Returns the HTTP client for the application.", "signature": "pub fn http_client (& self) -> Arc", "cfg": [], "target": "App" }, { "id": "gpui::app::App::init_colors", "name": "init_colors", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Initializes gpui's default colors for the application.", "documentation": "Initializes gpui's default colors for the application.\n\nThese colors can be accessed through `cx.default_colors()`.", "signature": "pub fn init_colors (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::intercept_keystrokes", "name": "intercept_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a callback to be invoked when a keystroke is received by the application in any window. Note that this fires _before_ all other action and event mechanisms have resolved unlike [`App::observe_keystrokes`] which fires after. This means that `cx.stop_propagation` calls within interceptors will prevent action dispatch", "documentation": "Register a callback to be invoked when a keystroke is received by the application\nin any window. Note that this fires _before_ all other action and event mechanisms have resolved\nunlike [`App::observe_keystrokes`] which fires after. This means that `cx.stop_propagation` calls\nwithin interceptors will prevent action dispatch", "signature": "pub fn intercept_keystrokes (& mut self, mut f : impl FnMut (& KeystrokeEvent, & mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "App" }, { "id": "gpui::app::App::is_action_available", "name": "is_action_available", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks if the given action is bound in the current context, as defined by the app's current focus, the bindings in the element tree, and any global action listeners.", "documentation": "Checks if the given action is bound in the current context, as defined by the app's current focus,\nthe bindings in the element tree, and any global action listeners.", "signature": "pub fn is_action_available (& mut self, action : & dyn Action) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::is_cursor_visible", "name": "is_cursor_visible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns whether the cursor is currently visible according to the platform. This will report `false` after a keyboard input has hidden the cursor and the user has not yet moved the mouse to restore it.", "documentation": "Returns whether the cursor is currently visible according to the\nplatform. This will report `false` after a keyboard input has hidden\nthe cursor and the user has not yet moved the mouse to restore it.\n\nSee [`App::set_cursor_hide_mode`].", "signature": "pub fn is_cursor_visible (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::is_screen_capture_supported", "name": "is_screen_capture_supported", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns whether `screen_capture_sources` may work.", "documentation": "Returns whether `screen_capture_sources` may work.", "signature": "pub fn is_screen_capture_supported (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::key_bindings", "name": "key_bindings", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get all key bindings in the app.", "documentation": "Get all key bindings in the app.", "signature": "pub fn key_bindings (& self) -> Rc>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::keyboard_layout", "name": "keyboard_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get the id of the current keyboard layout", "documentation": "Get the id of the current keyboard layout", "signature": "pub fn keyboard_layout (& self) -> & dyn PlatformKeyboardLayout", "cfg": [], "target": "App" }, { "id": "gpui::app::App::keyboard_mapper", "name": "keyboard_mapper", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get the current keyboard mapper.", "documentation": "Get the current keyboard mapper.", "signature": "pub fn keyboard_mapper (& self) -> & Rc", "cfg": [], "target": "App" }, { "id": "gpui::app::App::leak_detector_snapshot", "name": "leak_detector_snapshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Captures a snapshot of all entities that currently have alive handles.", "documentation": "Captures a snapshot of all entities that currently have alive handles.\n\nThe returned [`LeakDetectorSnapshot`] can later be passed to\n[`assert_no_new_leaks`](Self::assert_no_new_leaks) to verify that no\nentities created after the snapshot are still alive.", "signature": "pub fn leak_detector_snapshot (& self) -> LeakDetectorSnapshot", "cfg": [ "cfg (any (test, feature = \"leak-detection\"))" ], "target": "App" }, { "id": "gpui::app::App::notify", "name": "notify", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Tell GPUI that an entity has changed and observers of it should be notified.", "documentation": "Tell GPUI that an entity has changed and observers of it should be notified.", "signature": "pub fn notify (& mut self, entity_id : EntityId)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::observe", "name": "observe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Arrange a callback to be invoked when the given entity calls `notify` on its respective context.", "documentation": "Arrange a callback to be invoked when the given entity calls `notify` on its respective context.", "signature": "pub fn observe (& mut self, entity : & Entity, mut on_notify : impl FnMut (Entity, & mut App) + 'static,) -> Subscription where W : 'static,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::observe_global", "name": "observe_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a callback to be invoked when a global of the given type is updated.", "documentation": "Register a callback to be invoked when a global of the given type is updated.", "signature": "pub fn observe_global (& mut self, mut f : impl FnMut (& mut Self) + 'static,) -> Subscription", "cfg": [], "target": "App" }, { "id": "gpui::app::App::observe_keystrokes", "name": "observe_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a callback to be invoked when a keystroke is received by the application in any window. Note that this fires after all other action and event mechanisms have resolved and that this API will not be invoked if the event's propagation is stopped.", "documentation": "Register a callback to be invoked when a keystroke is received by the application\nin any window. Note that this fires after all other action and event mechanisms have resolved\nand that this API will not be invoked if the event's propagation is stopped.", "signature": "pub fn observe_keystrokes (& mut self, mut f : impl FnMut (& KeystrokeEvent, & mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "App" }, { "id": "gpui::app::App::observe_new", "name": "observe_new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Arrange for the given function to be invoked whenever a view of the specified type is created. The function will be passed a mutable reference to the view along with an appropriate context.", "documentation": "Arrange for the given function to be invoked whenever a view of the specified type is created.\nThe function will be passed a mutable reference to the view along with an appropriate context.", "signature": "pub fn observe_new (& self, on_new : impl 'static + Fn (& mut T, Option<& mut Window>, & mut Context),) -> Subscription", "cfg": [], "target": "App" }, { "id": "gpui::app::App::observe_release", "name": "observe_release", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Observe the release of a entity. The callback is invoked after the entity has no more strong references but before it has been dropped.", "documentation": "Observe the release of a entity. The callback is invoked after the entity\nhas no more strong references but before it has been dropped.", "signature": "pub fn observe_release (& self, handle : & Entity, on_release : impl FnOnce (& mut T, & mut App) + 'static,) -> Subscription where T : 'static,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::observe_release_in", "name": "observe_release_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Observe the release of a entity. The callback is invoked after the entity has no more strong references but before it has been dropped.", "documentation": "Observe the release of a entity. The callback is invoked after the entity\nhas no more strong references but before it has been dropped.", "signature": "pub fn observe_release_in (& self, handle : & Entity, window : & Window, on_release : impl FnOnce (& mut T, & mut Window, & mut App) + 'static,) -> Subscription where T : 'static,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_action", "name": "on_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a global handler for actions invoked via the keyboard. These handlers are run at the end of the bubble phase for actions, and so will only be invoked if there are no other handlers or if they called `cx.propagate()`.", "documentation": "Register a global handler for actions invoked via the keyboard. These handlers are run at\nthe end of the bubble phase for actions, and so will only be invoked if there are no other\nhandlers or if they called `cx.propagate()`.", "signature": "pub fn on_action (& mut self, listener : impl Fn (& A, & mut Self) + 'static,) -> & mut Self", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_app_quit", "name": "on_app_quit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a callback to be invoked when the application is about to quit. It is not possible to cancel the quit event at this point.", "documentation": "Register a callback to be invoked when the application is about to quit.\nIt is not possible to cancel the quit event at this point.", "signature": "pub fn on_app_quit (& self, mut on_quit : impl FnMut (& mut App) -> Fut + 'static,) -> Subscription where Fut : 'static + Future,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_app_restart", "name": "on_app_restart", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a callback to be invoked when the application is about to restart.", "documentation": "Register a callback to be invoked when the application is about to restart.\n\nThese callbacks are called before any `on_app_quit` callbacks.", "signature": "pub fn on_app_restart (& self, mut on_restart : impl 'static + FnMut (& mut App)) -> Subscription", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_keyboard_layout_change", "name": "on_keyboard_layout_change", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Invokes a handler when the current keyboard layout changes", "documentation": "Invokes a handler when the current keyboard layout changes", "signature": "pub fn on_keyboard_layout_change (& self, mut callback : F) -> Subscription where F : 'static + FnMut (& mut App),", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_system_notification_response", "name": "on_system_notification_response", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Registers the handler invoked when the user activates a system notification, either by clicking its body or one of its action buttons. Subsequent registrations replace the handler.", "documentation": "Registers the handler invoked when the user activates a system\nnotification, either by clicking its body or one of its action\nbuttons. Subsequent registrations replace the handler.", "signature": "pub fn on_system_notification_response (& self, mut callback : F) where F : 'static + FnMut (SystemNotificationResponse, & mut App),", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_thermal_state_change", "name": "on_thermal_state_change", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Invokes a handler when the thermal state changes", "documentation": "Invokes a handler when the thermal state changes", "signature": "pub fn on_thermal_state_change (& self, mut callback : F) -> Subscription where F : 'static + FnMut (& mut App),", "cfg": [], "target": "App" }, { "id": "gpui::app::App::on_window_closed", "name": "on_window_closed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a callback to be invoked when a window is closed The window is no longer accessible at the point this callback is invoked.", "documentation": "Register a callback to be invoked when a window is closed\nThe window is no longer accessible at the point this callback is invoked.", "signature": "pub fn on_window_closed (& self, mut on_closed : impl FnMut (& mut App, WindowId) + 'static,) -> Subscription", "cfg": [], "target": "App" }, { "id": "gpui::app::App::open_url", "name": "open_url", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Directs the platform's default browser to open the given URL.", "documentation": "Directs the platform's default browser to open the given URL.", "signature": "pub fn open_url (& self, url : & str)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::open_window", "name": "open_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Opens a new window with the given option and the root view returned by the given function. The function is invoked with a `Window`, which can be used to interact with window-specific functionality.", "documentation": "Opens a new window with the given option and the root view returned by the given function.\nThe function is invoked with a `Window`, which can be used to interact with window-specific\nfunctionality.", "signature": "pub fn open_window (& mut self, options : crate::WindowOptions, build_root_view : impl FnOnce (& mut Window, & mut App) -> Entity,) -> anyhow::Result>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::open_with_system", "name": "open_with_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Opens the specified path with the system's default application. May do nothing on mobile; use [`Self::try_open_with_system`].", "documentation": "Opens the specified path with the system's default application.\nMay do nothing on mobile; use [`Self::try_open_with_system`].", "signature": "pub fn open_with_system (& self, path : & Path)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::path_for_auxiliary_executable", "name": "path_for_auxiliary_executable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the file URL of the executable with the specified name in the application bundle", "documentation": "Returns the file URL of the executable with the specified name in the application bundle", "signature": "pub fn path_for_auxiliary_executable (& self, name : & str) -> Result", "cfg": [], "target": "App" }, { "id": "gpui::app::App::perform_dock_menu_action", "name": "perform_dock_menu_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Performs the action associated with the given dock menu item, only used on Windows for now.", "documentation": "Performs the action associated with the given dock menu item, only used on Windows for now.", "signature": "pub fn perform_dock_menu_action (& self, action : usize)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::primary_display", "name": "primary_display", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the primary display that will be used for new windows.", "documentation": "Returns the primary display that will be used for new windows.", "signature": "pub fn primary_display (& self) -> Option>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::prompt_for_new_path", "name": "prompt_for_new_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Displays a platform modal for selecting a new path where a file can be saved.", "documentation": "Displays a platform modal for selecting a new path where a file can be saved.\n\nThe provided directory will be used to set the initial location.\nWhen a path is selected, it is relayed asynchronously via the returned oneshot channel.\nIf cancelled, a `None` will be relayed instead.\nMay return an error on Linux if the file picker couldn't be opened.", "signature": "pub fn prompt_for_new_path (& self, directory : & Path, suggested_name : Option<& str>,) -> oneshot::Receiver>>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::prompt_for_paths", "name": "prompt_for_paths", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Displays a platform modal for selecting paths.", "documentation": "Displays a platform modal for selecting paths.\n\nWhen one or more paths are selected, they'll be relayed asynchronously via the returned oneshot channel.\nIf cancelled, a `None` will be relayed instead.\nMay return an error on Linux if the file picker couldn't be opened.", "signature": "pub fn prompt_for_paths (& self, options : PathPromptOptions,) -> oneshot::Receiver>>>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::propagate", "name": "propagate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Action handlers stop propagation by default during the bubble phase of action dispatch dispatching to action handlers higher in the element tree. This is the opposite of [`Self::stop_propagation`]. It's also possible to cancel a call to [`Self::stop_propagation`] by calling this method before effects are flushed.", "documentation": "Action handlers stop propagation by default during the bubble phase of action dispatch\ndispatching to action handlers higher in the element tree. This is the opposite of\n[`Self::stop_propagation`]. It's also possible to cancel a call to [`Self::stop_propagation`] by calling\nthis method before effects are flushed.", "signature": "pub fn propagate (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::quit", "name": "quit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Gracefully quit the application via the platform's standard routine. May do nothing on mobile; use [`Self::try_quit`] to receive a refusal.", "documentation": "Gracefully quit the application via the platform's standard routine.\nMay do nothing on mobile; use [`Self::try_quit`] to receive a refusal.", "signature": "pub fn quit (& self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::read_credentials", "name": "read_credentials", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Reads credentials from the platform keychain.", "documentation": "Reads credentials from the platform keychain.", "signature": "pub fn read_credentials (& self, url : & str) -> Task)>>>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::read_from_clipboard", "name": "read_from_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Reads data from the platform clipboard.", "documentation": "Reads data from the platform clipboard.", "signature": "pub fn read_from_clipboard (& self) -> Option", "cfg": [], "target": "App" }, { "id": "gpui::app::App::read_from_find_pasteboard", "name": "read_from_find_pasteboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Reads data from macOS's \"Find\" pasteboard.", "documentation": "Reads data from macOS's \"Find\" pasteboard.\n\nUsed to share the current search string between apps.\n\n", "signature": "pub fn read_from_find_pasteboard (& self) -> Option", "cfg": [ "cfg (target_os = \"macos\")" ], "target": "App" }, { "id": "gpui::app::App::read_from_primary", "name": "read_from_primary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Reads data from the primary selection buffer. Only available on Linux.", "documentation": "Reads data from the primary selection buffer.\nOnly available on Linux.", "signature": "pub fn read_from_primary (& self) -> Option", "cfg": [ "cfg (any (target_os = \"linux\", target_os = \"freebsd\"))" ], "target": "App" }, { "id": "gpui::app::App::reduce_motion", "name": "reduce_motion", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns whether non-essential animations (e.g. loading spinners) should be rendered in a static state instead of animating.", "documentation": "Returns whether non-essential animations (e.g. loading spinners) should\nbe rendered in a static state instead of animating.", "signature": "pub fn reduce_motion (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::ref_counts_drop_handle", "name": "ref_counts_drop_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub fn ref_counts_drop_handle (& self) -> impl Sized + use<>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::refresh_windows", "name": "refresh_windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Schedules all windows in the application to be redrawn. This can be called multiple times in an update cycle and still result in a single redraw.", "documentation": "Schedules all windows in the application to be redrawn. This can be called\nmultiple times in an update cycle and still result in a single redraw.", "signature": "pub fn refresh_windows (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::register_inspector_element", "name": "register_inspector_element", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Registers a renderer specific to an inspector state.", "documentation": "Registers a renderer specific to an inspector state.", "signature": "pub fn register_inspector_element (& mut self, f : impl 'static + Fn (crate::InspectorElementId, & T, & mut Window, & mut App) -> R,)", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ], "target": "App" }, { "id": "gpui::app::App::register_url_scheme", "name": "register_url_scheme", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Registers the given URL scheme (e.g. `zed` for `zed://` urls) to be opened by the current app.", "documentation": "Registers the given URL scheme (e.g. `zed` for `zed://` urls) to be\nopened by the current app.\n\nOn some platforms (e.g. macOS) you may be able to register URL schemes\nas part of app distribution, but this method exists to let you register\nschemes at runtime.", "signature": "pub fn register_url_scheme (& self, scheme : & str) -> Task>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::remove_asset", "name": "remove_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Remove an asset from GPUI's cache", "documentation": "Remove an asset from GPUI's cache", "signature": "pub fn remove_asset (& mut self, source : & A::Source)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::remove_global", "name": "remove_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Remove the global of the given type from the app context. Does not notify global observers.", "documentation": "Remove the global of the given type from the app context. Does not notify global observers.", "signature": "pub fn remove_global (& mut self) -> G", "cfg": [], "target": "App" }, { "id": "gpui::app::App::reset_prompt_builder", "name": "reset_prompt_builder", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Reset the prompt builder to the default implementation.", "documentation": "Reset the prompt builder to the default implementation.", "signature": "pub fn reset_prompt_builder (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::restart", "name": "restart", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Restarts the application. May do nothing on mobile; use [`Self::try_restart`] to avoid notifying restart observers when the platform cannot restart.", "documentation": "Restarts the application.\nMay do nothing on mobile; use [`Self::try_restart`] to avoid notifying\nrestart observers when the platform cannot restart.", "signature": "pub fn restart (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::reveal_path", "name": "reveal_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Reveals the specified path at the platform level, such as in Finder on macOS. May do nothing on mobile; use [`Self::try_reveal_path`].", "documentation": "Reveals the specified path at the platform level, such as in Finder on macOS.\nMay do nothing on mobile; use [`Self::try_reveal_path`].", "signature": "pub fn reveal_path (& self, path : & Path)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::screen_capture_sources", "name": "screen_capture_sources", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns a list of available screen capture sources.", "documentation": "Returns a list of available screen capture sources.", "signature": "pub fn screen_capture_sources (& self,) -> oneshot::Receiver>>>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_active_drag_cursor_style", "name": "set_active_drag_cursor_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the cursor style for the currently active drag operation.", "documentation": "Sets the cursor style for the currently active drag operation.", "signature": "pub fn set_active_drag_cursor_style (& mut self, cursor_style : CursorStyle, window : & mut Window,) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_app_identity", "name": "set_app_identity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the application's process-wide identity and user-visible name.", "documentation": "Sets the application's process-wide identity and user-visible name.\n\nThe identifier is used for platform identity mechanisms such as the\nWindows AppUserModelID. The name is used wherever the operating system\npresents the application to the user. Call this once, early in startup,\nbefore opening windows or posting notifications.", "signature": "pub fn set_app_identity (& self, identifier : & str, name : & str)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_cursor_hide_mode", "name": "set_cursor_hide_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the policy controlling when GPUI hides the cursor in response to keyboard input.", "documentation": "Sets the policy controlling when GPUI hides the cursor in response\nto keyboard input.", "signature": "pub fn set_cursor_hide_mode (& mut self, mode : CursorHideMode)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_dock_menu", "name": "set_dock_menu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the right click menu for the app icon in the dock May do nothing on mobile; use [`Self::try_set_dock_menu`].", "documentation": "Sets the right click menu for the app icon in the dock\nMay do nothing on mobile; use [`Self::try_set_dock_menu`].", "signature": "pub fn set_dock_menu (& self, menus : Vec)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_global", "name": "set_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the value of the global of the given type.", "documentation": "Sets the value of the global of the given type.", "signature": "pub fn set_global (& mut self, global : G)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_http_client", "name": "set_http_client", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the HTTP client for the application.", "documentation": "Sets the HTTP client for the application.", "signature": "pub fn set_http_client (& mut self, new_client : Arc)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_inspector_renderer", "name": "set_inspector_renderer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the renderer for the inspector.", "documentation": "Sets the renderer for the inspector.", "signature": "pub fn set_inspector_renderer (& mut self, f : crate::InspectorRenderer)", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ], "target": "App" }, { "id": "gpui::app::App::set_menus", "name": "set_menus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the menu bar for this application. This will replace any existing menu bar.", "documentation": "Sets the menu bar for this application. This will replace any existing menu bar.", "signature": "pub fn set_menus (& self, menus : impl IntoIterator)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_prompt_builder", "name": "set_prompt_builder", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Set the prompt renderer for GPUI. This will replace the default or platform specific prompts with this custom implementation.", "documentation": "Set the prompt renderer for GPUI. This will replace the default or platform specific\nprompts with this custom implementation.", "signature": "pub fn set_prompt_builder (& mut self, renderer : impl Fn (PromptLevel, & str, Option<& str>, & [PromptButton], PromptHandle, & mut Window, & mut App,) -> RenderablePromptHandle + 'static,)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_quit_mode", "name": "set_quit_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Configures when the application should automatically quit. By default, [`QuitMode::Default`] is used.", "documentation": "Configures when the application should automatically quit.\nBy default, [`QuitMode::Default`] is used.", "signature": "pub fn set_quit_mode (& mut self, mode : QuitMode)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_reduce_motion", "name": "set_reduce_motion", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets whether non-essential animations (e.g. loading spinners) should be rendered in a static state instead of animating.", "documentation": "Sets whether non-essential animations (e.g. loading spinners) should be\nrendered in a static state instead of animating.", "signature": "pub fn set_reduce_motion (& mut self, reduce_motion : bool)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_restart_path", "name": "set_restart_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the path to use when restarting the application.", "documentation": "Sets the path to use when restarting the application.", "signature": "pub fn set_restart_path (& mut self, path : PathBuf)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_text_rendering_mode", "name": "set_text_rendering_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the text rendering mode for the application.", "documentation": "Sets the text rendering mode for the application.", "signature": "pub fn set_text_rendering_mode (& mut self, mode : TextRenderingMode)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::set_window_appearance", "name": "set_window_appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Overrides the appearance (light/dark) applied to the app's windows, independent of the OS-wide setting. Pass `None` to clear the override and follow the system again. The current value is reported by [`App::window_appearance`].", "documentation": "Overrides the appearance (light/dark) applied to the app's windows, independent of\nthe OS-wide setting. Pass `None` to clear the override and follow the system again.\nThe current value is reported by [`App::window_appearance`].\n\nOn macOS this sets the underlying `NSApplication.appearance`, which controls the\nnative window chrome (the window border and titlebar) of every window. Use this\nwhen the app uses a dark theme while the system is in light mode (or vice versa)\nso the window edges render to match the theme. While an appearance is forced,\nwindows stop tracking system light/dark changes; pass `None` to resume following\nthe system. On other platforms this is a no-op.", "signature": "pub fn set_window_appearance (& self, appearance : Option)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::should_auto_hide_scrollbars", "name": "should_auto_hide_scrollbars", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns whether the user has configured scrollbars to auto-hide at the platform level.", "documentation": "Returns whether the user has configured scrollbars to auto-hide at the platform level.", "signature": "pub fn should_auto_hide_scrollbars (& self) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::show_system_notification", "name": "show_system_notification", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Posts a notification to the operating system's notification center.", "documentation": "Posts a notification to the operating system's notification center.\n\nPosting a notification whose [`SystemNotification::tag`] matches an\nearlier one replaces that notification where the platform supports it.\nNo-op on platforms without notification support, or when delivery is\nunavailable (e.g. authorization was denied).", "signature": "pub fn show_system_notification (& self, notification : SystemNotification)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::shutdown", "name": "shutdown", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Quit the application gracefully. Handlers registered with [`Context::on_app_quit`] will be given `SHUTDOWN_TIMEOUT` to complete before exiting.", "documentation": "Quit the application gracefully. Handlers registered with [`Context::on_app_quit`]\nwill be given `SHUTDOWN_TIMEOUT` to complete before exiting.", "signature": "pub fn shutdown (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Spawns the future returned by the given function on the main thread. The closure will be invoked with [AsyncApp], which allows the application state to be accessed across await points.", "documentation": "Spawns the future returned by the given function on the main thread. The closure will be invoked\nwith [AsyncApp], which allows the application state to be accessed across await points.", "signature": "pub fn spawn (& self, f : AsyncFn) -> Task where AsyncFn : AsyncFnOnce (& mut AsyncApp) -> R + 'static, R : 'static,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::spawn_with_priority", "name": "spawn_with_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Spawns the future returned by the given function on the main thread with the given priority. The closure will be invoked with [AsyncApp], which allows the application state to be accessed across await points.", "documentation": "Spawns the future returned by the given function on the main thread with\nthe given priority. The closure will be invoked with [AsyncApp], which\nallows the application state to be accessed across await points.", "signature": "pub fn spawn_with_priority (& self, priority : Priority, f : AsyncFn) -> Task where AsyncFn : AsyncFnOnce (& mut AsyncApp) -> R + 'static, R : 'static,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::stop_active_drag", "name": "stop_active_drag", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Stops active drag and clears any related effects.", "documentation": "Stops active drag and clears any related effects.", "signature": "pub fn stop_active_drag (& mut self, window : & mut Window) -> bool", "cfg": [], "target": "App" }, { "id": "gpui::app::App::stop_propagation", "name": "stop_propagation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Event handlers propagate events by default. Call this method to stop dispatching to event handlers with a lower z-index (mouse) or higher in the tree (keyboard). This is the opposite of [`Self::propagate`]. It's also possible to cancel a call to [`Self::propagate`] by calling this method before effects are flushed.", "documentation": "Event handlers propagate events by default. Call this method to stop dispatching to\nevent handlers with a lower z-index (mouse) or higher in the tree (keyboard). This is\nthe opposite of [`Self::propagate`]. It's also possible to cancel a call to [`Self::propagate`] by\ncalling this method before effects are flushed.", "signature": "pub fn stop_propagation (& mut self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::subscribe", "name": "subscribe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Arrange for the given callback to be invoked whenever the given entity emits an event of a given type. The callback is provided a handle to the emitting entity and a reference to the emitted event.", "documentation": "Arrange for the given callback to be invoked whenever the given entity emits an event of a given type.\nThe callback is provided a handle to the emitting entity and a reference to the emitted event.", "signature": "pub fn subscribe (& mut self, entity : & Entity, mut on_event : impl FnMut (Entity, & Event, & mut App) + 'static,) -> Subscription where T : 'static + EventEmitter, Event : 'static,", "cfg": [], "target": "App" }, { "id": "gpui::app::App::svg_renderer", "name": "svg_renderer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the SVG renderer used by the application.", "documentation": "Returns the SVG renderer used by the application.", "signature": "pub fn svg_renderer (& self) -> SvgRenderer", "cfg": [], "target": "App" }, { "id": "gpui::app::App::text_rendering_mode", "name": "text_rendering_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the current text rendering mode for the application.", "documentation": "Returns the current text rendering mode for the application.", "signature": "pub fn text_rendering_mode (& self) -> TextRenderingMode", "cfg": [], "target": "App" }, { "id": "gpui::app::App::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Accessor for the text system.", "documentation": "Accessor for the text system.", "signature": "pub fn text_system (& self) -> & Arc", "cfg": [], "target": "App" }, { "id": "gpui::app::App::thermal_state", "name": "thermal_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the current thermal state of the system.", "documentation": "Returns the current thermal state of the system.", "signature": "pub fn thermal_state (& self) -> ThermalState", "cfg": [], "target": "App" }, { "id": "gpui::app::App::to_async", "name": "to_async", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Creates an `AsyncApp`, which can be cloned and has a static lifetime so it can be held across `await` points.", "documentation": "Creates an `AsyncApp`, which can be cloned and has a static lifetime\nso it can be held across `await` points.", "signature": "pub fn to_async (& self) -> AsyncApp", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_global", "name": "try_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Access the global of the given type if a value has been assigned.", "documentation": "Access the global of the given type if a value has been assigned.", "signature": "pub fn try_global (& self) -> Option<& G>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_hide", "name": "try_hide", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and requests application hiding on the owner UI thread.", "documentation": "Checks and requests application hiding on the owner UI thread.", "signature": "pub fn try_hide (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_hide_other_apps", "name": "try_hide_other_apps", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and requests hiding other applications on the owner UI thread.", "documentation": "Checks and requests hiding other applications on the owner UI thread.", "signature": "pub fn try_hide_other_apps (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_open_with_system", "name": "try_open_with_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and requests opening a path on the owner UI thread. Success means the request was issued, not that the external application opened it.", "documentation": "Checks and requests opening a path on the owner UI thread. Success means\nthe request was issued, not that the external application opened it.", "signature": "pub fn try_open_with_system (& self, path : & Path) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_quit", "name": "try_quit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and requests quit on the owner UI thread. Success means accepted, not that the OS has finished terminating the application.", "documentation": "Checks and requests quit on the owner UI thread. Success means accepted,\nnot that the OS has finished terminating the application.", "signature": "pub fn try_quit (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_restart", "name": "try_restart", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks restart before notifying observers or consuming the restart path.", "documentation": "Checks restart before notifying observers or consuming the restart path.", "signature": "pub fn try_restart (& mut self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_reveal_path", "name": "try_reveal_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and requests path reveal on the owner UI thread.", "documentation": "Checks and requests path reveal on the owner UI thread.", "signature": "pub fn try_reveal_path (& self, path : & Path) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_set_dock_menu", "name": "try_set_dock_menu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and installs a dock menu on the owner UI thread.", "documentation": "Checks and installs a dock menu on the owner UI thread.", "signature": "pub fn try_set_dock_menu (& self, menus : Vec,) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::try_unhide_other_apps", "name": "try_unhide_other_apps", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Checks and requests unhiding other applications on the owner UI thread.", "documentation": "Checks and requests unhiding other applications on the owner UI thread.", "signature": "pub fn try_unhide_other_apps (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::unhide_other_apps", "name": "unhide_other_apps", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Unhide other applications at the platform level. May do nothing on mobile; use [`Self::try_unhide_other_apps`].", "documentation": "Unhide other applications at the platform level.\nMay do nothing on mobile; use [`Self::try_unhide_other_apps`].", "signature": "pub fn unhide_other_apps (& self)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::update_jump_list", "name": "update_jump_list", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Updates the jump list with the updated list of recent paths for the application, only used on Windows for now. Note that this also sets the dock menu on Windows.", "documentation": "Updates the jump list with the updated list of recent paths for the application, only used on Windows for now.\nNote that this also sets the dock menu on Windows.", "signature": "pub fn update_jump_list (& self, menus : Vec, entries : Vec>,) -> Task>>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::window_appearance", "name": "window_appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the appearance of the application's windows.", "documentation": "Returns the appearance of the application's windows.", "signature": "pub fn window_appearance (& self) -> WindowAppearance", "cfg": [], "target": "App" }, { "id": "gpui::app::App::window_stack", "name": "window_stack", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the window handles ordered by their appearance on screen, front to back.", "documentation": "Returns the window handles ordered by their appearance on screen, front to back.\n\nThe first window in the returned list is the active/topmost window of the application.\n\nThis method returns None if the platform doesn't implement the method yet.", "signature": "pub fn window_stack (& self) -> Option>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::windows", "name": "windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns handles to all open windows in the application. Each handle could be downcast to a handle typed for the root view of that window. To find all windows of a given type, you could filter on", "documentation": "Returns handles to all open windows in the application.\nEach handle could be downcast to a handle typed for the root view of that window.\nTo find all windows of a given type, you could filter on", "signature": "pub fn windows (& self) -> Vec", "cfg": [], "target": "App" }, { "id": "gpui::app::App::with_window", "name": "with_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Run `f` against the entity's *current* window — the most recently rendered window that referenced the entity, or its creation window if it has yet to be rendered. Returns `None` if the entity has no current window, or if that window has been closed, or if it is already on the update stack.", "documentation": "Run `f` against the entity's *current* window — the most recently\nrendered window that referenced the entity, or its creation window if\nit has yet to be rendered. Returns `None` if the entity has no\ncurrent window, or if that window has been closed, or if it is\nalready on the update stack.", "signature": "pub fn with_window (& mut self, entity_id : EntityId, f : impl FnOnce (& mut Window, & mut App) -> R,) -> Option", "cfg": [], "target": "App" }, { "id": "gpui::app::App::write_credentials", "name": "write_credentials", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Writes credentials to the platform keychain.", "documentation": "Writes credentials to the platform keychain.", "signature": "pub fn write_credentials (& self, url : & str, username : & str, password : & [u8],) -> Task>", "cfg": [], "target": "App" }, { "id": "gpui::app::App::write_to_clipboard", "name": "write_to_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Writes data to the platform clipboard.", "documentation": "Writes data to the platform clipboard.", "signature": "pub fn write_to_clipboard (& self, item : ClipboardItem)", "cfg": [], "target": "App" }, { "id": "gpui::app::App::write_to_find_pasteboard", "name": "write_to_find_pasteboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Writes data to macOS's \"Find\" pasteboard.", "documentation": "Writes data to macOS's \"Find\" pasteboard.\n\nUsed to share the current search string between apps.\n\n", "signature": "pub fn write_to_find_pasteboard (& self, item : ClipboardItem)", "cfg": [ "cfg (target_os = \"macos\")" ], "target": "App" }, { "id": "gpui::app::App::write_to_primary", "name": "write_to_primary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Writes data to the primary selection buffer. Only available on Linux.", "documentation": "Writes data to the primary selection buffer.\nOnly available on Linux.", "signature": "pub fn write_to_primary (& self, item : ClipboardItem)", "cfg": [ "cfg (any (target_os = \"linux\", target_os = \"freebsd\"))" ], "target": "App" }, { "id": "gpui::app::AppCell", "name": "AppCell", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Temporary(?) wrapper around [`RefCell`] to help us debug any double borrows. Strongly consider removing after stabilization.", "documentation": "Temporary(?) wrapper around [`RefCell`] to help us debug any double borrows.\nStrongly consider removing after stabilization.", "signature": "# [doc = \" Temporary(?) wrapper around [`RefCell`] to help us debug any double borrows.\"] # [doc = \" Strongly consider removing after stabilization.\"] # [doc (hidden)] pub struct AppCell { app : RefCell, }", "cfg": [] }, { "id": "gpui::app::AppCell::borrow", "name": "borrow", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub fn borrow (& self) -> AppRef<'_>", "cfg": [], "target": "AppCell" }, { "id": "gpui::app::AppCell::borrow_mut", "name": "borrow_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub fn borrow_mut (& self) -> AppRefMut<'_>", "cfg": [], "target": "AppCell" }, { "id": "gpui::app::AppCell::try_borrow_mut", "name": "try_borrow_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub fn try_borrow_mut (& self) -> Result, BorrowMutError>", "cfg": [], "target": "AppCell" }, { "id": "gpui::app::AppRef", "name": "AppRef", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Deref, DerefMut)] pub struct AppRef<'a> (Ref<'a, App>);", "cfg": [] }, { "id": "gpui::app::AppRefMut", "name": "AppRefMut", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Deref, DerefMut)] pub struct AppRefMut<'a> (RefMut<'a, App>);", "cfg": [] }, { "id": "gpui::app::Application", "name": "Application", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "A reference to a GPUI application, typically constructed in the `main` function of your app. You won't interact with this type much outside of initial configuration and startup.", "documentation": "A reference to a GPUI application, typically constructed in the `main` function of your app.\nYou won't interact with this type much outside of initial configuration and startup.", "signature": "# [doc = \" A reference to a GPUI application, typically constructed in the `main` function of your app.\"] # [doc = \" You won't interact with this type much outside of initial configuration and startup.\"] pub struct Application (Rc);", "cfg": [] }, { "id": "gpui::app::Application::background_executor", "name": "background_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns a handle to the [`BackgroundExecutor`] associated with this app, which can be used to spawn futures in the background.", "documentation": "Returns a handle to the [`BackgroundExecutor`] associated with this app, which can be used to spawn futures in the background.", "signature": "pub fn background_executor (& self) -> BackgroundExecutor", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns a handle to the [`ForegroundExecutor`] associated with this app, which can be used to spawn futures in the foreground.", "documentation": "Returns a handle to the [`ForegroundExecutor`] associated with this app, which can be used to spawn futures in the foreground.", "signature": "pub fn foreground_executor (& self) -> ForegroundExecutor", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::new_inaccessible", "name": "new_inaccessible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Builds an app with accessibility (AccessKit) integration forcibly disabled.", "documentation": "Builds an app with accessibility (AccessKit) integration forcibly\ndisabled.\n\nIn this mode, accessibility APIs (e.g.\n[`div().role()`][crate::StatefulInteractiveElement::role]) silently\nno-op.\n\nSee the [accessibility guide](crate::_accessibility) for an overview of\nthe features this disables.", "signature": "pub fn new_inaccessible (platform : Rc) -> Self", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::on_open_urls", "name": "on_open_urls", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Register a handler to be invoked when the platform instructs the application to open one or more URLs.", "documentation": "Register a handler to be invoked when the platform instructs the application\nto open one or more URLs.", "signature": "pub fn on_open_urls (& self, mut callback : F) -> & Self where F : 'static + FnMut (Vec),", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::on_reopen", "name": "on_reopen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Invokes a handler when an already-running application is launched. On macOS, this can occur when the application icon is double-clicked or the app is launched via the dock.", "documentation": "Invokes a handler when an already-running application is launched.\nOn macOS, this can occur when the application icon is double-clicked or the app is launched via the dock.", "signature": "pub fn on_reopen (& self, mut callback : F) -> & Self where F : 'static + FnMut (& mut App),", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::on_system_wake", "name": "on_system_wake", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Invokes a handler when the system wakes from sleep.", "documentation": "Invokes a handler when the system wakes from sleep.", "signature": "pub fn on_system_wake (& self, mut callback : F) -> & Self where F : 'static + FnMut (& mut App),", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::path_for_auxiliary_executable", "name": "path_for_auxiliary_executable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns the file URL of the executable with the specified name in the application bundle", "documentation": "Returns the file URL of the executable with the specified name in the application bundle", "signature": "pub fn path_for_auxiliary_executable (& self, name : & str) -> Result", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::run", "name": "run", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Start the application. The provided callback will be called once the app is fully launched.", "documentation": "Start the application. The provided callback will be called once the\napp is fully launched.", "signature": "pub fn run (self, on_finish_launching : F) where F : 'static + FnOnce (& mut App),", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::run_embedded", "name": "run_embedded", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Start the application for an embedder that drives the run loop itself.", "documentation": "Start the application for an embedder that drives the run loop itself.\n\nOn ordinary platforms `Platform::run` blocks for the lifetime of the app, and the\napp state is kept alive by [`Application::run`]'s stack frame. Embedded platforms —\nwhere the run loop belongs to someone else, e.g. GPUI compiled into a Wasm guest,\nor a GPUI view hosted inside a foreign native application — implement\n`Platform::run` to invoke the launch callback and return immediately. This method\nsupports that shape: it returns an [`ApplicationHandle`] that keeps the app alive\nand lets the embedder re-enter it whenever the external run loop yields control.", "signature": "pub fn run_embedded (self, on_finish_launching : F) -> ApplicationHandle where F : 'static + FnOnce (& mut App),", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Returns a reference to the [`TextSystem`] associated with this app.", "documentation": "Returns a reference to the [`TextSystem`] associated with this app.", "signature": "pub fn text_system (& self) -> Arc", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::with_assets", "name": "with_assets", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Assigns the source of assets for the application.", "documentation": "Assigns the source of assets for the application.", "signature": "pub fn with_assets (self, asset_source : impl AssetSource) -> Self", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::with_http_client", "name": "with_http_client", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Sets the HTTP client for the application.", "documentation": "Sets the HTTP client for the application.", "signature": "pub fn with_http_client (self, http_client : Arc) -> Self", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::with_platform", "name": "with_platform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Builds an app with a caller-provided platform implementation.", "documentation": "Builds an app with a caller-provided platform implementation.", "signature": "pub fn with_platform (platform : Rc) -> Self", "cfg": [], "target": "Application" }, { "id": "gpui::app::Application::with_quit_mode", "name": "with_quit_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Configures when the application should automatically quit. By default, [`QuitMode::Default`] is used.", "documentation": "Configures when the application should automatically quit.\nBy default, [`QuitMode::Default`] is used.", "signature": "pub fn with_quit_mode (self, mode : QuitMode) -> Self", "cfg": [], "target": "Application" }, { "id": "gpui::app::ApplicationHandle", "name": "ApplicationHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "A strong handle to an [`Application`] started with [`Application::run_embedded`].", "documentation": "A strong handle to an [`Application`] started with [`Application::run_embedded`].\n\nDropping this handle releases the app, so an embedder must hold it for as long as the\napp should run. While held, it is the embedder's entry point back into GPUI each time\nthe external run loop gives it control.", "signature": "# [doc = \" A strong handle to an [`Application`] started with [`Application::run_embedded`].\"] # [doc = \"\"] # [doc = \" Dropping this handle releases the app, so an embedder must hold it for as long as the\"] # [doc = \" app should run. While held, it is the embedder's entry point back into GPUI each time\"] # [doc = \" the external run loop gives it control.\"] pub struct ApplicationHandle { app : Rc, }", "cfg": [] }, { "id": "gpui::app::ApplicationHandle::to_async", "name": "to_async", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "An [`AsyncApp`] for use across await points. It holds the app weakly; keeping the app alive remains this handle's job.", "documentation": "An [`AsyncApp`] for use across await points. It holds the app weakly; keeping the\napp alive remains this handle's job.", "signature": "pub fn to_async (& self) -> AsyncApp", "cfg": [], "target": "ApplicationHandle" }, { "id": "gpui::app::ApplicationHandle::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Invoke `f` with the app context. Must not be called re-entrantly from code that is already inside an update; the app state is a `RefCell` and will panic on a double borrow.", "documentation": "Invoke `f` with the app context. Must not be called re-entrantly from code that\nis already inside an update; the app state is a `RefCell` and will panic on a\ndouble borrow.", "signature": "pub fn update (& self, f : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "ApplicationHandle" }, { "id": "gpui::app::CursorHideMode", "name": "CursorHideMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Controls when GPUI hides the mouse cursor in response to keyboard input.", "documentation": "Controls when GPUI hides the mouse cursor in response to keyboard input.\n\nRestoration on mouse motion is handled by the platform layer; this enum\nonly describes the policy for *triggering* a hide.", "signature": "# [doc = \" Controls when GPUI hides the mouse cursor in response to keyboard input.\"] # [doc = \"\"] # [doc = \" Restoration on mouse motion is handled by the platform layer; this enum\"] # [doc = \" only describes the policy for *triggering* a hide.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum CursorHideMode { # [doc = \" Never hide the cursor automatically.\"] Never, # [doc = \" Hide on character-producing key presses (typing).\"] OnTyping, # [doc = \" Hide on character-producing key presses, *and* when a key binding\"] # [doc = \" resolves to an action that consumes the keystroke.\"] # [default] OnTypingAndAction, }", "cfg": [] }, { "id": "gpui::app::ExternalDragPayloadSource", "name": "ExternalDragPayloadSource", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Lazily resolves the payload handed to the platform when an internal drag is promoted to a native drag session.", "documentation": "Lazily resolves the payload handed to the platform when an internal drag is\npromoted to a native drag session.", "signature": "# [doc = \" Lazily resolves the payload handed to the platform when an internal drag is\"] # [doc = \" promoted to a native drag session.\"] pub type ExternalDragPayloadSource = Box Option + 'static>;", "cfg": [] }, { "id": "gpui::app::GpuiBorrow", "name": "GpuiBorrow", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "A mutable reference to an entity owned by GPUI", "documentation": "A mutable reference to an entity owned by GPUI", "signature": "# [doc = \" A mutable reference to an entity owned by GPUI\"] pub struct GpuiBorrow<'a, T> { inner : Option>, app : & 'a mut App, }", "cfg": [] }, { "id": "gpui::app::GpuiMode::test", "name": "test", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub fn test () -> Self", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "GpuiMode" }, { "id": "gpui::app::KeystrokeEvent", "name": "KeystrokeEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "A keystroke event, and potentially the associated action", "documentation": "A keystroke event, and potentially the associated action", "signature": "# [doc = \" A keystroke event, and potentially the associated action\"] # [derive (Debug)] pub struct KeystrokeEvent { # [doc = \" The keystroke that occurred\"] pub keystroke : Keystroke, # [doc = \" The action that was resolved for the keystroke, if any\"] pub action : Option>, # [doc = \" The context stack at the time\"] pub context_stack : Vec, }", "cfg": [] }, { "id": "gpui::app::QuitMode", "name": "QuitMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Defines when the application should automatically quit.", "documentation": "Defines when the application should automatically quit.", "signature": "# [doc = \" Defines when the application should automatically quit.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum QuitMode { # [doc = \" Use [`QuitMode::Explicit`] on macOS and [`QuitMode::LastWindowClosed`] on other platforms.\"] # [default] Default, # [doc = \" Quit automatically when the last window is closed.\"] LastWindowClosed, # [doc = \" Quit only when requested via [`App::quit`].\"] Explicit, }", "cfg": [] }, { "id": "gpui::app::SHUTDOWN_TIMEOUT", "name": "SHUTDOWN_TIMEOUT", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "The duration for which futures returned from [Context::on_app_quit] can run before the application fully quits.", "documentation": "The duration for which futures returned from [Context::on_app_quit] can run before the application fully quits.", "signature": "pub const SHUTDOWN_TIMEOUT: Duration", "cfg": [] }, { "id": "gpui::app::SystemWindowTab", "name": "SystemWindowTab", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Clone, PartialEq, Eq)] pub struct SystemWindowTab { pub id : WindowId, pub title : SharedString, pub handle : AnyWindowHandle, pub last_active_at : Instant, }", "cfg": [] }, { "id": "gpui::app::SystemWindowTab::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Create a new instance of the window tab.", "documentation": "Create a new instance of the window tab.", "signature": "pub fn new (title : SharedString, handle : AnyWindowHandle) -> Self", "cfg": [], "target": "SystemWindowTab" }, { "id": "gpui::app::SystemWindowTabController", "name": "SystemWindowTabController", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "A controller for managing window tabs.", "documentation": "A controller for managing window tabs.", "signature": "# [doc = \" A controller for managing window tabs.\"] # [derive (Default)] pub struct SystemWindowTabController { visible : Option, tab_groups : FxHashMap>, }", "cfg": [] }, { "id": "gpui::app::SystemWindowTabController::add_tab", "name": "add_tab", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Insert a tab into a tab group.", "documentation": "Insert a tab into a tab group.", "signature": "pub fn add_tab (cx : & mut App, id : WindowId, tabs : Vec)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::get_next_tab_group_window", "name": "get_next_tab_group_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get the next tab group window handle.", "documentation": "Get the next tab group window handle.", "signature": "pub fn get_next_tab_group_window (cx : & mut App, id : WindowId) -> Option<& AnyWindowHandle>", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::get_prev_tab_group_window", "name": "get_prev_tab_group_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get the previous tab group window handle.", "documentation": "Get the previous tab group window handle.", "signature": "pub fn get_prev_tab_group_window (cx : & mut App, id : WindowId) -> Option<& AnyWindowHandle>", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::init", "name": "init", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Initialize the global window tab controller.", "documentation": "Initialize the global window tab controller.", "signature": "pub fn init (cx : & mut App)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::init_visible", "name": "init_visible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Initialize the visibility of the system window tab controller.", "documentation": "Initialize the visibility of the system window tab controller.", "signature": "pub fn init_visible (cx : & mut App, visible : bool)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::is_visible", "name": "is_visible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get the visibility of the system window tab controller.", "documentation": "Get the visibility of the system window tab controller.", "signature": "pub fn is_visible (& self) -> bool", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::merge_all_windows", "name": "merge_all_windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Merge all tab groups into a single group.", "documentation": "Merge all tab groups into a single group.", "signature": "pub fn merge_all_windows (cx : & mut App, id : WindowId)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::move_tab_to_new_window", "name": "move_tab_to_new_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Move a tab to a new tab group.", "documentation": "Move a tab to a new tab group.", "signature": "pub fn move_tab_to_new_window (cx : & mut App, id : WindowId)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Create a new instance of the window tab controller.", "documentation": "Create a new instance of the window tab controller.", "signature": "pub fn new () -> Self", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::remove_tab", "name": "remove_tab", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Remove a tab from a tab group.", "documentation": "Remove a tab from a tab group.", "signature": "pub fn remove_tab (cx : & mut App, id : WindowId) -> Option", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::select_next_tab", "name": "select_next_tab", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Selects the next tab in the tab group in the trailing direction.", "documentation": "Selects the next tab in the tab group in the trailing direction.", "signature": "pub fn select_next_tab (cx : & mut App, id : WindowId)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::select_previous_tab", "name": "select_previous_tab", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Selects the previous tab in the tab group in the leading direction.", "documentation": "Selects the previous tab in the tab group in the leading direction.", "signature": "pub fn select_previous_tab (cx : & mut App, id : WindowId)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::set_visible", "name": "set_visible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Set the visibility of the system window tab controller.", "documentation": "Set the visibility of the system window tab controller.", "signature": "pub fn set_visible (cx : & mut App, visible : bool)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::tab_groups", "name": "tab_groups", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get all tab groups.", "documentation": "Get all tab groups.", "signature": "pub fn tab_groups (& self) -> & FxHashMap>", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::tabs", "name": "tabs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Get all tabs in the same window.", "documentation": "Get all tabs in the same window.", "signature": "pub fn tabs (& self, id : WindowId) -> Option<& Vec>", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::update_last_active", "name": "update_last_active", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Update the last active of a window.", "documentation": "Update the last active of a window.", "signature": "pub fn update_last_active (cx : & mut App, id : WindowId)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::update_tab_position", "name": "update_tab_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Update the position of a tab within its group.", "documentation": "Update the position of a tab within its group.", "signature": "pub fn update_tab_position (cx : & mut App, id : WindowId, ix : usize)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::SystemWindowTabController::update_tab_title", "name": "update_tab_title", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "Update the title of a tab.", "documentation": "Update the title of a tab.", "signature": "pub fn update_tab_title (cx : & mut App, id : WindowId, title : SharedString)", "cfg": [], "target": "SystemWindowTabController" }, { "id": "gpui::app::async_context::AsyncApp", "name": "AsyncApp", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "An async-friendly version of [App] with a static lifetime so it can be held across `await` points in async code. You're provided with an instance when calling [App::spawn], and you can also create one with [App::to_async].", "documentation": "An async-friendly version of [App] with a static lifetime so it can be held across `await` points in async code.\nYou're provided with an instance when calling [App::spawn], and you can also create one with [App::to_async].\n\nInternally, this holds a weak reference to an `App`. Methods will panic if the app has been dropped,\nbut this should not happen in practice when using foreground tasks spawned via `cx.spawn()`,\nas the executor checks if the app is alive before running each task.", "signature": "# [doc = \" An async-friendly version of [App] with a static lifetime so it can be held across `await` points in async code.\"] # [doc = \" You're provided with an instance when calling [App::spawn], and you can also create one with [App::to_async].\"] # [doc = \"\"] # [doc = \" Internally, this holds a weak reference to an `App`. Methods will panic if the app has been dropped,\"] # [doc = \" but this should not happen in practice when using foreground tasks spawned via `cx.spawn()`,\"] # [doc = \" as the executor checks if the app is alive before running each task.\"] # [derive (Clone)] pub struct AsyncApp { pub (crate) app : Weak, pub (crate) background_executor : BackgroundExecutor, pub (crate) foreground_executor : ForegroundExecutor, }", "cfg": [] }, { "id": "gpui::app::async_context::AsyncApp::background_executor", "name": "background_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Get an executor which can be used to spawn futures in the background.", "documentation": "Get an executor which can be used to spawn futures in the background.", "signature": "pub fn background_executor (& self) -> & BackgroundExecutor", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Get an executor which can be used to spawn futures in the foreground.", "documentation": "Get an executor which can be used to spawn futures in the foreground.", "signature": "pub fn foreground_executor (& self) -> & ForegroundExecutor", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::has_global", "name": "has_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Determine whether global state of the specified type has been assigned.", "documentation": "Determine whether global state of the specified type has been assigned.", "signature": "pub fn has_global (& self) -> bool", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::on_drop", "name": "on_drop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Run something using this entity and cx, when the returned struct is dropped", "documentation": "Run something using this entity and cx, when the returned struct is dropped", "signature": "pub fn on_drop) + 'static> (& self, entity : & WeakEntity, f : Callback,) -> gpui_util::Deferred>", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::open_window", "name": "open_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Open a window with the given options based on the root view returned by the given function.", "documentation": "Open a window with the given options based on the root view returned by the given function.", "signature": "pub fn open_window (& self, options : crate::WindowOptions, build_root_view : impl FnOnce (& mut Window, & mut App) -> Entity,) -> Result> where V : 'static + Render,", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::read_default_global", "name": "read_default_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Reads the global state of the specified type, passing it to the given callback. A default value is assigned if a global of this type has not yet been assigned.", "documentation": "Reads the global state of the specified type, passing it to the given callback.\nA default value is assigned if a global of this type has not yet been assigned.", "signature": "pub fn read_default_global (& self, read : impl FnOnce (& G, & App) -> R,) -> R", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::read_global", "name": "read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Reads the global state of the specified type, passing it to the given callback.", "documentation": "Reads the global state of the specified type, passing it to the given callback.\n\nPanics if no global state of the specified type has been assigned.", "signature": "pub fn read_global (& self, read : impl FnOnce (& G, & App) -> R) -> R", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::refresh", "name": "refresh", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Schedules all windows in the application to be redrawn.", "documentation": "Schedules all windows in the application to be redrawn.", "signature": "pub fn refresh (& self)", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Schedule a future to be polled in the foreground.", "documentation": "Schedule a future to be polled in the foreground.", "signature": "pub fn spawn (& self, f : AsyncFn) -> Task where AsyncFn : AsyncFnOnce (& mut AsyncApp) -> R + 'static, R : 'static,", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::subscribe", "name": "subscribe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Arrange for the given callback to be invoked whenever the given entity emits an event of a given type. The callback is provided a handle to the emitting entity and a reference to the emitted event.", "documentation": "Arrange for the given callback to be invoked whenever the given entity emits an event of a given type.\nThe callback is provided a handle to the emitting entity and a reference to the emitted event.", "signature": "pub fn subscribe (& mut self, entity : & Entity, on_event : impl FnMut (Entity, & Event, & mut App) + 'static,) -> Subscription where T : 'static + EventEmitter, Event : 'static,", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::try_read_global", "name": "try_read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Reads the global state of the specified type, passing it to the given callback.", "documentation": "Reads the global state of the specified type, passing it to the given callback.\n\nSimilar to [`AsyncApp::read_global`], but returns an error instead of panicking", "signature": "pub fn try_read_global (& self, read : impl FnOnce (& G, & App) -> R) -> Option", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Invoke the given function in the context of the app, then flush any effects produced during its invocation.", "documentation": "Invoke the given function in the context of the app, then flush any effects produced during its invocation.", "signature": "pub fn update (& self, f : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncApp::update_global", "name": "update_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A convenience method for [`App::update_global`](BorrowAppContext::update_global) for updating the global state of the specified type.", "documentation": "A convenience method for [`App::update_global`](BorrowAppContext::update_global)\nfor updating the global state of the specified type.", "signature": "pub fn update_global (& self, update : impl FnOnce (& mut G, & mut App) -> R) -> R", "cfg": [], "target": "AsyncApp" }, { "id": "gpui::app::async_context::AsyncWindowContext", "name": "AsyncWindowContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A cloneable, owned handle to the application context, composed with the window associated with the current task.", "documentation": "A cloneable, owned handle to the application context,\ncomposed with the window associated with the current task.", "signature": "# [doc = \" A cloneable, owned handle to the application context,\"] # [doc = \" composed with the window associated with the current task.\"] # [derive (Clone, Deref, DerefMut)] pub struct AsyncWindowContext { # [deref] # [deref_mut] app : AsyncApp, window : AnyWindowHandle, }", "cfg": [] }, { "id": "gpui::app::async_context::AsyncWindowContext::on_next_frame", "name": "on_next_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A convenience method for [`Window::on_next_frame`].", "documentation": "A convenience method for [`Window::on_next_frame`].", "signature": "pub fn on_next_frame (& mut self, f : impl FnOnce (& mut Window, & mut App) + 'static)", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::prompt", "name": "prompt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Present a platform dialog. The provided message will be presented, along with buttons for each answer. When a button is clicked, the returned Receiver will receive the index of the clicked button.", "documentation": "Present a platform dialog.\nThe provided message will be presented, along with buttons for each answer.\nWhen a button is clicked, the returned Receiver will receive the index of the clicked button.", "signature": "pub fn prompt (& mut self, level : PromptLevel, message : & str, detail : Option<& str>, answers : & [T],) -> oneshot::Receiver where T : Clone + Into,", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::read_global", "name": "read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A convenience method for [`App::global`].", "documentation": "A convenience method for [`App::global`].", "signature": "pub fn read_global (& mut self, read : impl FnOnce (& G, & Window, & App) -> R,) -> Result", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Schedule a future to be executed on the main thread. This is used for collecting the results of background tasks and updating the UI.", "documentation": "Schedule a future to be executed on the main thread. This is used for collecting\nthe results of background tasks and updating the UI.", "signature": "pub fn spawn (& self, f : AsyncFn) -> Task where AsyncFn : AsyncFnOnce (& mut AsyncWindowContext) -> R + 'static, R : 'static,", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A convenience method for [`App::update_window`].", "documentation": "A convenience method for [`App::update_window`].", "signature": "pub fn update (& mut self, update : impl FnOnce (& mut Window, & mut App) -> R) -> Result", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::update_global", "name": "update_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A convenience method for [`App::update_global`](BorrowAppContext::update_global). for updating the global state of the specified type.", "documentation": "A convenience method for [`App::update_global`](BorrowAppContext::update_global).\nfor updating the global state of the specified type.", "signature": "pub fn update_global (& mut self, update : impl FnOnce (& mut G, & mut Window, & mut App) -> R,) -> Result where G : Global,", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::update_root", "name": "update_root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "A convenience method for [`App::update_window`].", "documentation": "A convenience method for [`App::update_window`].", "signature": "pub fn update_root (& mut self, update : impl FnOnce (AnyView, & mut Window, & mut App) -> R,) -> Result", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::async_context::AsyncWindowContext::window_handle", "name": "window_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::async_context", "path": "gpui::app::async_context", "source": "crates/gpui/src/app/async_context.rs", "summary": "Get the handle of the window this context is associated with.", "documentation": "Get the handle of the window this context is associated with.", "signature": "pub fn window_handle (& self) -> AnyWindowHandle", "cfg": [], "target": "AsyncWindowContext" }, { "id": "gpui::app::bench_context::BenchAppContext", "name": "BenchAppContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "A GPUI app context for Criterion benchmarks.", "documentation": "A GPUI app context for Criterion benchmarks.\n\n`BenchAppContext` is intentionally separate from `TestAppContext`: it owns a\nbenchmark app instance and exposes only the app/window operations needed by\nbenchmark setup. Criterion remains responsible for the measured loop via its\n`Bencher` API.", "signature": "# [doc = \" A GPUI app context for Criterion benchmarks.\"] # [doc = \"\"] # [doc = \" `BenchAppContext` is intentionally separate from `TestAppContext`: it owns a\"] # [doc = \" benchmark app instance and exposes only the app/window operations needed by\"] # [doc = \" benchmark setup. Criterion remains responsible for the measured loop via its\"] # [doc = \" `Bencher` API.\"] # [derive (Clone)] pub struct BenchAppContext<'a, 'measurement> { app : Rc, background_executor : BackgroundExecutor, foreground_executor : ForegroundExecutor, benchmark_name : Option<& 'static str>, bencher : Rc>>>, report : BenchReport, }", "cfg": [] }, { "id": "gpui::app::bench_context::BenchAppContext::add_empty_window", "name": "add_empty_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Adds a window with an empty root view for benchmark setup.", "documentation": "Adds a window with an empty root view for benchmark setup.", "signature": "pub fn add_empty_window (& mut self) -> BenchWindowContext<'a, 'measurement>", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::background_executor", "name": "background_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Returns the background executor used by this benchmark app.", "documentation": "Returns the background executor used by this benchmark app.", "signature": "pub fn background_executor (& self) -> & BackgroundExecutor", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::bench_batched_task", "name": "bench_batched_task", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Measures a GPUI task with per-iteration setup outside the timed interval.", "documentation": "Measures a GPUI task with per-iteration setup outside the timed interval.\n\n`setup` runs before timing starts. The returned input is passed by mutable\nreference to `benchmark`, which returns the task whose completion is\nmeasured. Both the setup input and task output are dropped after timing\nstops.\n\nEach iteration is kept in its own Criterion batch so frame tracing and\ndestruction cannot overlap adjacent measurements.", "signature": "pub fn bench_batched_task (& mut self, setup : impl FnMut (& mut Self) -> Input, benchmark : impl FnMut (& mut Input, & mut Self) -> Task,) where Output : 'static,", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::bench_iter", "name": "bench_iter", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Measures a generic benchmark workload using Criterion's iteration loop.", "documentation": "Measures a generic benchmark workload using Criterion's iteration loop.\n\nThe closure is invoked once per Criterion iteration with this\nbenchmark app context so it can update GPUI state.\n\nAny window draws triggered by the workload are recorded into the\nbenchmark's frame report through the GPUI frame profiler.", "signature": "pub fn bench_iter (& mut self, mut benchmark : impl FnMut (& mut Self))", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::bench_renderer", "name": "bench_renderer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Measures frame latency after updating a GPUI entity in its current window.", "documentation": "Measures frame latency after updating a GPUI entity in its current window.\n\nEach iteration runs `update` against the entity in its current window. In\nbench builds, flushing the update's effects synchronously draws dirty\nwindows. The entity should be part of the window's render tree, such as the\nroot view or a child of it.\n\nFrame timings are collected through the GPUI frame profiler\n([`crate::profiler::record_frame_timing`]), which is enabled for the\nduration of the measurement.", "signature": "pub fn bench_renderer (& mut self, view : Entity, mut update : impl FnMut (& mut V, & mut Window, & mut Context),) where V : 'static + Render,", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::bench_task", "name": "bench_task", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Measures a GPUI task to completion using Criterion's iteration loop.", "documentation": "Measures a GPUI task to completion using Criterion's iteration loop.\n\nThe closure is invoked once per Criterion iteration. The returned task\nmay depend on foreground work, background work, timers, or external\nworkers that wake GPUI tasks. Its output is dropped after the timed\ninterval.\n\nAny window draws triggered by the task are recorded into the benchmark's\nframe report through the GPUI frame profiler.", "signature": "pub fn bench_task (& mut self, mut benchmark : impl FnMut (& mut Self) -> Task) where Output : 'static,", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::benchmark_name", "name": "benchmark_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "The benchmark function name that created this context.", "documentation": "The benchmark function name that created this context.", "signature": "pub fn benchmark_name (& self) -> Option<& 'static str>", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Returns the foreground executor used by this benchmark app.", "documentation": "Returns the foreground executor used by this benchmark app.", "signature": "pub fn foreground_executor (& self) -> & ForegroundExecutor", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Creates a new benchmark app context backed by the provided platform.", "documentation": "Creates a new benchmark app context backed by the provided platform.\n\nThe platform's executors must be backed by a [`ThreadedDispatcher`]\n(see [`bench_platform`]) so the context can drain foreground work via\n[`Self::run_until_idle`]; panics otherwise.", "signature": "pub fn new (platform : Rc, benchmark_name : Option<& 'static str>, bencher : & 'a mut criterion::Bencher<'measurement>,) -> Self", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::new_with_platform_and_report", "name": "new_with_platform_and_report", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Creates a new benchmark app context backed by the provided platform.", "documentation": "Creates a new benchmark app context backed by the provided platform.\n\nThe platform's executors must be backed by a [`ThreadedDispatcher`]\n(see [`bench_platform`]) so the context can drain foreground work via\n[`Self::run_until_idle`]; panics otherwise.", "signature": "pub fn new_with_platform_and_report (platform : Rc, benchmark_name : Option<& 'static str>, bencher : & 'a mut criterion::Bencher<'measurement>, report : BenchReport,) -> Self", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Reads app state.", "documentation": "Reads app state.", "signature": "pub fn read (& self, read : impl FnOnce (& App) -> R) -> R", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::run_until_idle", "name": "run_until_idle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Runs queued foreground tasks on this thread and waits for in flight background work to finish. Timers that aren't due yet are not waited for (see [`ThreadedDispatcher::run_until_idle`]).", "documentation": "Runs queued foreground tasks on this thread and waits for in flight\nbackground work to finish. Timers that aren't due yet are not waited\nfor (see [`ThreadedDispatcher::run_until_idle`]).", "signature": "pub fn run_until_idle (& self)", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::teardown", "name": "teardown", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Runs GPUI benchmark teardown.", "documentation": "Runs GPUI benchmark teardown.\n\nCancels any timers still armed on the shared dispatcher and drains the\nwork that cancellation unblocks so they can't fire during a later\nbenchmark; assumes no other `BenchAppContext` is live on this thread.", "signature": "pub fn teardown (mut self)", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchAppContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Updates the app and flushes synchronous GPUI effects afterward.", "documentation": "Updates the app and flushes synchronous GPUI effects afterward.", "signature": "pub fn update (& mut self, update : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "BenchAppContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchReport", "name": "BenchReport", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "A small report produced by GPUI benchmarks.", "documentation": "A small report produced by GPUI benchmarks.", "signature": "# [doc = \" A small report produced by GPUI benchmarks.\"] # [derive (Clone)] pub struct BenchReport { frame_snapshot : Rc>, frame_budget_nanos : u128, }", "cfg": [] }, { "id": "gpui::app::bench_context::BenchReport::print", "name": "print", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Prints this report to stderr.", "documentation": "Prints this report to stderr.", "signature": "pub fn print (& self, benchmark_name : Option<& 'static str>)", "cfg": [], "target": "BenchReport" }, { "id": "gpui::app::bench_context::BenchReport::with_fps", "name": "with_fps", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Creates a report whose per-frame budget is one frame at `fps` when counting frame budget overruns.", "documentation": "Creates a report whose per-frame budget is one frame at `fps` when\ncounting frame budget overruns.", "signature": "pub fn with_fps (fps : u64) -> Self", "cfg": [], "target": "BenchReport" }, { "id": "gpui::app::bench_context::BenchReport::with_frame_budget_nanos", "name": "with_frame_budget_nanos", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Creates a report that treats `frame_budget_nanos` as the per-frame budget when counting frame budget overruns.", "documentation": "Creates a report that treats `frame_budget_nanos` as the per-frame budget\nwhen counting frame budget overruns.", "signature": "pub fn with_frame_budget_nanos (frame_budget_nanos : u128) -> Self", "cfg": [], "target": "BenchReport" }, { "id": "gpui::app::bench_context::BenchWindowContext", "name": "BenchWindowContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "A window-specific context for GPUI benchmarks.", "documentation": "A window-specific context for GPUI benchmarks.\n\nThis is separate from `VisualTestContext`; it provides access to a benchmark\nwindow without exposing test-only helpers such as input simulation.", "signature": "# [doc = \" A window-specific context for GPUI benchmarks.\"] # [doc = \"\"] # [doc = \" This is separate from `VisualTestContext`; it provides access to a benchmark\"] # [doc = \" window without exposing test-only helpers such as input simulation.\"] # [derive (Clone)] pub struct BenchWindowContext<'a, 'measurement> { cx : BenchAppContext<'a, 'measurement>, window : AnyWindowHandle, }", "cfg": [] }, { "id": "gpui::app::bench_context::BenchWindowContext::app_context", "name": "app_context", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Returns the underlying benchmark app context.", "documentation": "Returns the underlying benchmark app context.", "signature": "pub fn app_context (& mut self) -> & mut BenchAppContext<'a, 'measurement>", "cfg": [], "target": "BenchWindowContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchWindowContext::run_until_idle", "name": "run_until_idle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Runs queued foreground tasks on this thread and waits for in-flight background work to finish. Pending timers are not waited for.", "documentation": "Runs queued foreground tasks on this thread and waits for in-flight\nbackground work to finish. Pending timers are not waited for.", "signature": "pub fn run_until_idle (& self)", "cfg": [], "target": "BenchWindowContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchWindowContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Updates the benchmark window.", "documentation": "Updates the benchmark window.", "signature": "pub fn update (& mut self, update : impl FnOnce (& mut Window, & mut App) -> R) -> R", "cfg": [], "target": "BenchWindowContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::BenchWindowContext::window_handle", "name": "window_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Returns the window associated with this context.", "documentation": "Returns the window associated with this context.", "signature": "pub fn window_handle (& self) -> AnyWindowHandle", "cfg": [], "target": "BenchWindowContext<'a, 'measurement>" }, { "id": "gpui::app::bench_context::bench_platform", "name": "bench_platform", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "app::bench_context", "path": "gpui::app::bench_context", "source": "crates/gpui/src/app/bench_context.rs", "summary": "Returns a benchmark platform backed by this thread's shared dispatcher.", "documentation": "Returns a benchmark platform backed by this thread's shared dispatcher.\n\nThe platform uses this thread's shared multithreaded [`ThreadedDispatcher`], so\nbackground work runs with production concurrency in real time. The dispatcher\nis cached per thread and reused across benchmark invocations so worker and\ntimer threads persist for the whole process instead of being recreated for\nevery Criterion calibration pass.\n\nText is shaped with the provided platform text system. Benchmarks generated\nby `#[gpui::bench]` use the current platform's text system, so text-heavy\nbenchmark measurements include production shaping and glyph rasterization.\n\n`headless_renderer_factory` supplies a renderer for benchmark windows, e.g.\n`gpui_platform::current_headless_renderer`. When present, scenes drawn by\nbenchmarks are rasterized through the real sprite atlas and submitted to\nthe GPU on present, so quad/sprite regressions show up in measurements.\nWhen `None`, presenting discards the scene. Currently only macOS provides\na headless renderer (Metal), so GPU submission is excluded from benchmark\nmeasurements on other platforms.", "signature": "pub fn bench_platform (headless_renderer_factory : Option Option>>>, text_system : Arc,) -> Rc", "cfg": [] }, { "id": "gpui::app::context::Context", "name": "Context", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "The app context, with specialized behavior for the given entity.", "documentation": "The app context, with specialized behavior for the given entity.", "signature": "# [doc = \" The app context, with specialized behavior for the given entity.\"] pub struct Context<'a, T> { app : & 'a mut App, entity_state : WeakEntity, }", "cfg": [] }, { "id": "gpui::app::context::Context::defer_in", "name": "defer_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Schedules the given function to be run at the end of the current effect cycle, allowing entities that are currently on the stack to be returned to the app.", "documentation": "Schedules the given function to be run at the end of the current effect cycle, allowing entities\nthat are currently on the stack to be returned to the app.", "signature": "pub fn defer_in (& mut self, window : & Window, f : impl FnOnce (& mut T, & mut Window, & mut Context) + 'static,)", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::emit", "name": "emit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Emit an event of the specified type, which can be handled by other entities that have subscribed via `subscribe` methods on their respective contexts.", "documentation": "Emit an event of the specified type, which can be handled by other entities that have subscribed via `subscribe` methods on their respective contexts.", "signature": "pub fn emit (& mut self, event : Evt) where T : EventEmitter, Evt : 'static,", "cfg": [], "target": "Context<'_, T>" }, { "id": "gpui::app::context::Context::entity", "name": "entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Returns a handle to the entity belonging to this context.", "documentation": "Returns a handle to the entity belonging to this context.", "signature": "pub fn entity (& self) -> Entity", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::entity_id", "name": "entity_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "The entity id of the entity backing this context.", "documentation": "The entity id of the entity backing this context.", "signature": "pub fn entity_id (& self) -> EntityId", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::focus_self", "name": "focus_self", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Move focus to the current view, assuming it implements [`Focusable`].", "documentation": "Move focus to the current view, assuming it implements [`Focusable`].", "signature": "pub fn focus_self (& mut self, window : & mut Window) where T : Focusable,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::focus_view", "name": "focus_view", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Focus the given view in the given window. View type is required to implement Focusable.", "documentation": "Focus the given view in the given window. View type is required to implement Focusable.", "signature": "pub fn focus_view (& mut self, view : & Entity, window : & mut Window)", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::listener", "name": "listener", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Convenience method for accessing view state in an event callback.", "documentation": "Convenience method for accessing view state in an event callback.\n\nMany GPUI callbacks take the form of `Fn(&E, &mut Window, &mut App)`,\nbut it's often useful to be able to access view state in these\ncallbacks. This method provides a convenient way to do so.", "signature": "pub fn listener (& self, f : impl Fn (& mut T, & E, & mut Window, & mut Context) + 'static,) -> impl Fn (& E, & mut Window, & mut App) + 'static", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::notify", "name": "notify", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Tell GPUI that this entity has changed and observers of it should be notified.", "documentation": "Tell GPUI that this entity has changed and observers of it should be notified.", "signature": "pub fn notify (& mut self)", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe", "name": "observe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Arranges for the given function to be called whenever [`Context::notify`] is called with the given entity.", "documentation": "Arranges for the given function to be called whenever [`Context::notify`] is\ncalled with the given entity.", "signature": "pub fn observe (& mut self, entity : & Entity, mut on_notify : impl FnMut (& mut T, Entity, & mut Context) + 'static,) -> Subscription where T : 'static, W : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_button_layout_changed", "name": "observe_button_layout_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Registers a callback to be invoked when the window button layout changes.", "documentation": "Registers a callback to be invoked when the window button layout changes.", "signature": "pub fn observe_button_layout_changed (& self, window : & mut Window, mut callback : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_global", "name": "observe_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to for updates to the given global", "documentation": "Register a callback to for updates to the given global", "signature": "pub fn observe_global (& mut self, mut f : impl FnMut (& mut T, & mut Context) + 'static,) -> Subscription where T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_global_in", "name": "observe_global_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the given global state changes.", "documentation": "Register a callback to be invoked when the given global state changes.", "signature": "pub fn observe_global_in (& mut self, window : & Window, mut f : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_in", "name": "observe_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Observe another entity for changes to its state, as tracked by [`Context::notify`].", "documentation": "Observe another entity for changes to its state, as tracked by [`Context::notify`].", "signature": "pub fn observe_in (& mut self, observed : & Entity, window : & mut Window, mut on_notify : impl FnMut (& mut T, Entity, & mut Window, & mut Context) + 'static,) -> Subscription where V2 : 'static, T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_keystrokes", "name": "observe_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when a keystroke is received by the application in any window. Note that this fires after all other action and event mechanisms have resolved and that this API will not be invoked if the event's propagation is stopped.", "documentation": "Register a callback to be invoked when a keystroke is received by the application\nin any window. Note that this fires after all other action and event mechanisms have resolved\nand that this API will not be invoked if the event's propagation is stopped.", "signature": "pub fn observe_keystrokes (& mut self, mut f : impl FnMut (& mut T, & KeystrokeEvent, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_pending_input", "name": "observe_pending_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the window's pending input changes.", "documentation": "Register a callback to be invoked when the window's pending input changes.", "signature": "pub fn observe_pending_input (& self, window : & mut Window, mut callback : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_release", "name": "observe_release", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be run on the release of another entity", "documentation": "Register a callback to be run on the release of another entity", "signature": "pub fn observe_release (& self, entity : & Entity, on_release : impl FnOnce (& mut T, & mut T2, & mut Context) + 'static,) -> Subscription where T : Any, T2 : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_release_in", "name": "observe_release_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the given Entity is released.", "documentation": "Register a callback to be invoked when the given Entity is released.", "signature": "pub fn observe_release_in (& self, observed : & Entity, window : & Window, mut on_release : impl FnMut (& mut T, & mut T2, & mut Window, & mut Context) + 'static,) -> Subscription where T : 'static, T2 : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_self", "name": "observe_self", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Observe changes to ourselves", "documentation": "Observe changes to ourselves", "signature": "pub fn observe_self (& mut self, mut on_event : impl FnMut (& mut T, & mut Context) + 'static,) -> Subscription where T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_window_activation", "name": "observe_window_activation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the window is activated or deactivated.", "documentation": "Register a callback to be invoked when the window is activated or deactivated.", "signature": "pub fn observe_window_activation (& self, window : & mut Window, mut callback : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_window_appearance", "name": "observe_window_appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Registers a callback to be invoked when the window appearance changes.", "documentation": "Registers a callback to be invoked when the window appearance changes.", "signature": "pub fn observe_window_appearance (& self, window : & mut Window, mut callback : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::observe_window_bounds", "name": "observe_window_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the window is resized.", "documentation": "Register a callback to be invoked when the window is resized.", "signature": "pub fn observe_window_bounds (& self, window : & mut Window, mut callback : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_action", "name": "on_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the given Action type is dispatched to the window.", "documentation": "Register a callback to be invoked when the given Action type is dispatched to the window.", "signature": "pub fn on_action (& mut self, action_type : TypeId, window : & mut Window, listener : impl Fn (& mut T, & dyn Any, DispatchPhase, & mut Window, & mut Context) + 'static,)", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_app_quit", "name": "on_app_quit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Arrange for the given function to be invoked whenever the application is quit. The future returned from this callback will be polled for up to [crate::SHUTDOWN_TIMEOUT] until the app fully quits.", "documentation": "Arrange for the given function to be invoked whenever the application is quit.\nThe future returned from this callback will be polled for up to [crate::SHUTDOWN_TIMEOUT] until the app fully quits.", "signature": "pub fn on_app_quit (& self, mut on_quit : impl FnMut (& mut T, & mut Context) -> Fut + 'static,) -> Subscription where Fut : 'static + Future, T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_app_restart", "name": "on_app_restart", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the application is about to restart.", "documentation": "Register a callback to be invoked when the application is about to restart.", "signature": "pub fn on_app_restart (& self, mut on_restart : impl FnMut (& mut T, & mut App) + 'static,) -> Subscription where T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_blur", "name": "on_blur", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a listener to be called when the given focus handle loses focus. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when the given focus handle loses focus.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_blur (& mut self, handle : & FocusHandle, window : & mut Window, mut listener : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_drop", "name": "on_drop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Run something using this entity and cx, when the returned struct is dropped", "documentation": "Run something using this entity and cx, when the returned struct is dropped", "signature": "pub fn on_drop (& self, f : impl FnOnce (& mut T, & mut Context) + 'static,) -> Deferred", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_focus", "name": "on_focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a listener to be called when the given focus handle receives focus. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when the given focus handle receives focus.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_focus (& mut self, handle : & FocusHandle, window : & mut Window, mut listener : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_focus_in", "name": "on_focus_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a listener to be called when the given focus handle or one of its descendants receives focus. This does not fire if the given focus handle - or one of its descendants - was previously focused. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when the given focus handle or one of its descendants receives focus.\nThis does not fire if the given focus handle - or one of its descendants - was previously focused.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_focus_in (& mut self, handle : & FocusHandle, window : & mut Window, mut listener : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_focus_lost", "name": "on_focus_lost", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a listener to be called when nothing in the window has focus. This typically happens when the node that was focused is removed from the tree, and this callback lets you chose a default place to restore the users focus. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when nothing in the window has focus.\nThis typically happens when the node that was focused is removed from the tree,\nand this callback lets you chose a default place to restore the users focus.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_focus_lost (& mut self, window : & mut Window, mut listener : impl FnMut (& mut T, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_focus_out", "name": "on_focus_out", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a listener to be called when the given focus handle or one of its descendants loses focus. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when the given focus handle or one of its descendants loses focus.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_focus_out (& mut self, handle : & FocusHandle, window : & mut Window, mut listener : impl FnMut (& mut T, FocusOutEvent, & mut Window, & mut Context) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_next_frame", "name": "on_next_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Sets a given callback to be run on the next frame.", "documentation": "Sets a given callback to be run on the next frame.", "signature": "pub fn on_next_frame (& self, window : & mut Window, f : impl FnOnce (& mut T, & mut Window, & mut Context) + 'static,) where T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_release", "name": "on_release", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when GPUI releases this entity.", "documentation": "Register a callback to be invoked when GPUI releases this entity.", "signature": "pub fn on_release (& self, on_release : impl FnOnce (& mut T, & mut App) + 'static) -> Subscription where T : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::on_release_in", "name": "on_release_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Register a callback to be invoked when the view is released.", "documentation": "Register a callback to be invoked when the view is released.\n\nThe callback receives a handle to the view's window. This handle may be\ninvalid, if the window was closed before the view was released.", "signature": "pub fn on_release_in (& mut self, window : & Window, on_release : impl FnOnce (& mut T, & mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::processor", "name": "processor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Convenience method for producing view state in a closure. See `listener` for more details.", "documentation": "Convenience method for producing view state in a closure.\nSee `listener` for more details.", "signature": "pub fn processor (& self, f : impl Fn (& mut T, E, & mut Window, & mut Context) -> R + 'static,) -> impl Fn (E, & mut Window, & mut App) -> R + 'static", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Spawn the future returned by the given function. The function is provided a weak handle to the entity owned by this context and a context that can be held across await points. The returned task must be held or detached.", "documentation": "Spawn the future returned by the given function.\nThe function is provided a weak handle to the entity owned by this context and a context that can be held across await points.\nThe returned task must be held or detached.", "signature": "pub fn spawn (& self, f : AsyncFn) -> Task where T : 'static, AsyncFn : AsyncFnOnce (WeakEntity, & mut AsyncApp) -> R + 'static, R : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::spawn_in", "name": "spawn_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Schedule a future to be run asynchronously. The given callback is invoked with a [`WeakEntity`] to avoid leaking the entity for a long-running process. It's also given an [`AsyncWindowContext`], which can be used to access the state of the entity across await points. The returned future will be polled on the main thread.", "documentation": "Schedule a future to be run asynchronously.\nThe given callback is invoked with a [`WeakEntity`] to avoid leaking the entity for a long-running process.\nIt's also given an [`AsyncWindowContext`], which can be used to access the state of the entity across await points.\nThe returned future will be polled on the main thread.", "signature": "pub fn spawn_in (& self, window : & Window, f : AsyncFn) -> Task where R : 'static, AsyncFn : AsyncFnOnce (WeakEntity, & mut AsyncWindowContext) -> R + 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::spawn_in_with_priority", "name": "spawn_in_with_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Schedule a future to be run asynchronously with the given priority. The given callback is invoked with a [`WeakEntity`] to avoid leaking the entity for a long-running process. It's also given an [`AsyncWindowContext`], which can be used to access the state of the entity across await points. The returned future will be polled on the main thread.", "documentation": "Schedule a future to be run asynchronously with the given priority.\nThe given callback is invoked with a [`WeakEntity`] to avoid leaking the entity for a long-running process.\nIt's also given an [`AsyncWindowContext`], which can be used to access the state of the entity across await points.\nThe returned future will be polled on the main thread.", "signature": "pub fn spawn_in_with_priority (& self, priority : Priority, window : & Window, f : AsyncFn,) -> Task where R : 'static, AsyncFn : AsyncFnOnce (WeakEntity, & mut AsyncWindowContext) -> R + 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::subscribe", "name": "subscribe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Subscribe to an event type from another entity", "documentation": "Subscribe to an event type from another entity", "signature": "pub fn subscribe (& mut self, entity : & Entity, mut on_event : impl FnMut (& mut T, Entity, & Evt, & mut Context) + 'static,) -> Subscription where T : 'static, T2 : 'static + EventEmitter, Evt : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::subscribe_in", "name": "subscribe_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Subscribe to events emitted by another entity. The entity to which you're subscribing must implement the [`EventEmitter`] trait. The callback will be invoked with a reference to the current view, a handle to the emitting `Entity`, the event, a mutable reference to the `Window`, and the context for the entity.", "documentation": "Subscribe to events emitted by another entity.\nThe entity to which you're subscribing must implement the [`EventEmitter`] trait.\nThe callback will be invoked with a reference to the current view, a handle to the emitting `Entity`, the event, a mutable reference to the `Window`, and the context for the entity.", "signature": "pub fn subscribe_in (& mut self, emitter : & Entity, window : & Window, mut on_event : impl FnMut (& mut T, & Entity, & Evt, & mut Window, & mut Context) + 'static,) -> Subscription where Emitter : EventEmitter, Evt : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::subscribe_self", "name": "subscribe_self", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Subscribe to an event type from ourself", "documentation": "Subscribe to an event type from ourself", "signature": "pub fn subscribe_self (& mut self, mut on_event : impl FnMut (& mut T, & Evt, & mut Context) + 'static,) -> Subscription where T : 'static + EventEmitter, Evt : 'static,", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::context::Context::weak_entity", "name": "weak_entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::context", "path": "gpui::app::context", "source": "crates/gpui/src/app/context.rs", "summary": "Returns a weak handle to the entity belonging to this context.", "documentation": "Returns a weak handle to the entity belonging to this context.", "signature": "pub fn weak_entity (& self) -> WeakEntity", "cfg": [], "target": "Context<'a, T>" }, { "id": "gpui::app::entity_map::AnyEntity", "name": "AnyEntity", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "A dynamically typed reference to a entity, which can be downcast into a `Entity`.", "documentation": "A dynamically typed reference to a entity, which can be downcast into a `Entity`.", "signature": "# [doc = \" A dynamically typed reference to a entity, which can be downcast into a `Entity`.\"] pub struct AnyEntity { pub (crate) entity_id : EntityId, pub (crate) entity_type : TypeId, entity_map : Weak>, # [cfg (any (test, feature = \"leak-detection\"))] handle_id : HandleId, }", "cfg": [] }, { "id": "gpui::app::entity_map::AnyEntity::downcast", "name": "downcast", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Converts this entity handle into a strongly-typed entity handle of the given type. If this entity handle is not of the specified type, returns itself as an error variant.", "documentation": "Converts this entity handle into a strongly-typed entity handle of the given type.\nIf this entity handle is not of the specified type, returns itself as an error variant.", "signature": "pub fn downcast (self) -> Result, AnyEntity>", "cfg": [], "target": "AnyEntity" }, { "id": "gpui::app::entity_map::AnyEntity::downgrade", "name": "downgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Converts this entity handle into a weak variant, which does not prevent it from being released.", "documentation": "Converts this entity handle into a weak variant, which does not prevent it from being released.", "signature": "pub fn downgrade (& self) -> AnyWeakEntity", "cfg": [], "target": "AnyEntity" }, { "id": "gpui::app::entity_map::AnyEntity::entity_id", "name": "entity_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Returns the id associated with this entity.", "documentation": "Returns the id associated with this entity.", "signature": "pub fn entity_id (& self) -> EntityId", "cfg": [], "target": "AnyEntity" }, { "id": "gpui::app::entity_map::AnyEntity::entity_type", "name": "entity_type", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Returns the [TypeId] associated with this entity.", "documentation": "Returns the [TypeId] associated with this entity.", "signature": "pub fn entity_type (& self) -> TypeId", "cfg": [], "target": "AnyEntity" }, { "id": "gpui::app::entity_map::AnyWeakEntity", "name": "AnyWeakEntity", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "A type erased, weak reference to a entity.", "documentation": "A type erased, weak reference to a entity.", "signature": "# [doc = \" A type erased, weak reference to a entity.\"] # [derive (Clone)] pub struct AnyWeakEntity { pub (crate) entity_id : EntityId, entity_type : TypeId, entity_ref_counts : Weak>, }", "cfg": [] }, { "id": "gpui::app::entity_map::AnyWeakEntity::assert_released", "name": "assert_released", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Asserts that the entity referenced by this weak handle has been fully released.", "documentation": "Asserts that the entity referenced by this weak handle has been fully released.\n\n# Example\n\n```ignore\nlet entity = cx.new(|_| MyEntity::new());\nlet weak = entity.downgrade();\ndrop(entity);\n\n// Verify the entity was released\nweak.assert_released();\n```\n\n# Debugging Leaks\n\nIf this method panics due to leaked handles, set the `LEAK_BACKTRACE` environment\nvariable to see where the leaked handles were allocated:\n\n```bash\nLEAK_BACKTRACE=1 cargo test my_test\n```\n\n# Panics\n\n- Panics if any strong handles to the entity are still alive.\n- Panics if the entity was recently dropped but cleanup hasn't completed yet\n(resources are retained until the end of the effect cycle).", "signature": "pub fn assert_released (& self)", "cfg": [ "cfg (any (test, feature = \"leak-detection\"))" ], "target": "AnyWeakEntity" }, { "id": "gpui::app::entity_map::AnyWeakEntity::entity_id", "name": "entity_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Get the entity ID associated with this weak reference.", "documentation": "Get the entity ID associated with this weak reference.", "signature": "pub fn entity_id (& self) -> EntityId", "cfg": [], "target": "AnyWeakEntity" }, { "id": "gpui::app::entity_map::AnyWeakEntity::is_upgradable", "name": "is_upgradable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Check if this weak handle can be upgraded, or if the entity has already been dropped", "documentation": "Check if this weak handle can be upgraded, or if the entity has already been dropped", "signature": "pub fn is_upgradable (& self) -> bool", "cfg": [], "target": "AnyWeakEntity" }, { "id": "gpui::app::entity_map::AnyWeakEntity::new_invalid", "name": "new_invalid", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Creates a weak entity that can never be upgraded.", "documentation": "Creates a weak entity that can never be upgraded.", "signature": "pub fn new_invalid () -> Self", "cfg": [], "target": "AnyWeakEntity" }, { "id": "gpui::app::entity_map::AnyWeakEntity::upgrade", "name": "upgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Upgrade this weak entity reference to a strong reference.", "documentation": "Upgrade this weak entity reference to a strong reference.", "signature": "pub fn upgrade (& self) -> Option", "cfg": [], "target": "AnyWeakEntity" }, { "id": "gpui::app::entity_map::Entity", "name": "Entity", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "A strong, well-typed reference to a struct which is managed by GPUI", "documentation": "A strong, well-typed reference to a struct which is managed\nby GPUI", "signature": "# [doc = \" A strong, well-typed reference to a struct which is managed\"] # [doc = \" by GPUI\"] # [derive (Deref, DerefMut)] pub struct Entity { # [deref] # [deref_mut] pub (crate) any_entity : AnyEntity, pub (crate) entity_type : PhantomData T>, }", "cfg": [] }, { "id": "gpui::app::entity_map::Entity::as_mut", "name": "as_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Updates the entity referenced by this handle with the given function.", "documentation": "Updates the entity referenced by this handle with the given function.", "signature": "pub fn as_mut<'a, C : AppContext> (& self, cx : & 'a mut C) -> GpuiBorrow<'a, T>", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::downgrade", "name": "downgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Downgrade this entity pointer to a non-retaining weak pointer", "documentation": "Downgrade this entity pointer to a non-retaining weak pointer", "signature": "pub fn downgrade (& self) -> WeakEntity", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::entity_id", "name": "entity_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Get the entity ID associated with this entity", "documentation": "Get the entity ID associated with this entity", "signature": "pub fn entity_id (& self) -> EntityId", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::into_any", "name": "into_any", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Convert this into a dynamically typed entity.", "documentation": "Convert this into a dynamically typed entity.", "signature": "pub fn into_any (self) -> AnyEntity", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Grab a reference to this entity from the context.", "documentation": "Grab a reference to this entity from the context.", "signature": "pub fn read<'a> (& self, cx : & 'a App) -> & 'a T", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::read_with", "name": "read_with", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Read the entity referenced by this handle with the given function.", "documentation": "Read the entity referenced by this handle with the given function.", "signature": "pub fn read_with (& self, cx : & C, f : impl FnOnce (& T, & App) -> R) -> R", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Updates the entity referenced by this handle with the given function.", "documentation": "Updates the entity referenced by this handle with the given function.", "signature": "pub fn update (& self, cx : & mut C, update : impl FnOnce (& mut T, & mut Context) -> R,) -> R", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::update_in", "name": "update_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Updates the entity referenced by this handle with the given function if the referenced entity still exists, within a visual context that has a window. Returns an error if the window has been closed.", "documentation": "Updates the entity referenced by this handle with the given function if\nthe referenced entity still exists, within a visual context that has a window.\nReturns an error if the window has been closed.", "signature": "pub fn update_in (& self, cx : & mut C, update : impl FnOnce (& mut T, & mut Window, & mut Context) -> R,) -> C::Result", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::Entity::write", "name": "write", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Updates the entity referenced by this handle with the given function.", "documentation": "Updates the entity referenced by this handle with the given function.", "signature": "pub fn write (& self, cx : & mut C, value : T)", "cfg": [], "target": "Entity" }, { "id": "gpui::app::entity_map::EntityId::as_non_zero_u64", "name": "as_non_zero_u64", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Converts this entity id to a [NonZeroU64]", "documentation": "Converts this entity id to a [NonZeroU64]", "signature": "pub fn as_non_zero_u64 (self) -> NonZeroU64", "cfg": [], "target": "EntityId" }, { "id": "gpui::app::entity_map::EntityId::as_u64", "name": "as_u64", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Converts this entity id to a [u64]", "documentation": "Converts this entity id to a [u64]", "signature": "pub fn as_u64 (self) -> u64", "cfg": [], "target": "EntityId" }, { "id": "gpui::app::entity_map::EntityMap::assert_no_new_leaks", "name": "assert_no_new_leaks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Asserts that no entities created after `snapshot` still have alive handles.", "documentation": "Asserts that no entities created after `snapshot` still have alive handles.\n\nSee [`LeakDetector::assert_no_new_leaks`] for details.", "signature": "pub fn assert_no_new_leaks (& self, snapshot : & LeakDetectorSnapshot)", "cfg": [ "cfg (any (test, feature = \"leak-detection\"))" ], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::clear_accessed", "name": "clear_accessed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "", "documentation": "", "signature": "pub fn clear_accessed (& mut self)", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::end_lease", "name": "end_lease", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Returns an entity after moving it to the stack.", "documentation": "Returns an entity after moving it to the stack.", "signature": "pub fn end_lease (& mut self, mut lease : Lease)", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::extend_accessed", "name": "extend_accessed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "", "documentation": "", "signature": "pub fn extend_accessed (& mut self, entities : & FxHashSet)", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::insert", "name": "insert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Insert an entity into a slot obtained by calling `reserve`.", "documentation": "Insert an entity into a slot obtained by calling `reserve`.", "signature": "pub fn insert (& mut self, slot : Slot, entity : T) -> Entity where T : 'static,", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::leak_detector_snapshot", "name": "leak_detector_snapshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Captures a snapshot of all entities that currently have alive handles.", "documentation": "Captures a snapshot of all entities that currently have alive handles.\n\nThe returned [`LeakDetectorSnapshot`] can later be passed to\n[`assert_no_new_leaks`](Self::assert_no_new_leaks) to verify that no\nentities created after the snapshot are still alive.", "signature": "pub fn leak_detector_snapshot (& self) -> LeakDetectorSnapshot", "cfg": [ "cfg (any (test, feature = \"leak-detection\"))" ], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::lease", "name": "lease", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Move an entity to the stack.", "documentation": "Move an entity to the stack.", "signature": "pub fn lease (& mut self, pointer : & Entity) -> Lease", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "", "documentation": "", "signature": "pub fn read (& self, entity : & Entity) -> & T", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::ref_counts_drop_handle", "name": "ref_counts_drop_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "", "documentation": "", "signature": "pub fn ref_counts_drop_handle (& self) -> Arc>", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::reserve", "name": "reserve", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Reserve a slot for an entity, which you can subsequently use with `insert`.", "documentation": "Reserve a slot for an entity, which you can subsequently use with `insert`.", "signature": "pub fn reserve (& self) -> Slot", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::EntityMap::take_dropped", "name": "take_dropped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "", "documentation": "", "signature": "pub fn take_dropped (& mut self) -> Vec<(EntityId, Box)>", "cfg": [], "target": "EntityMap" }, { "id": "gpui::app::entity_map::LeakDetector::assert_no_new_leaks", "name": "assert_no_new_leaks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Asserts that no entities created after `snapshot` still have alive handles.", "documentation": "Asserts that no entities created after `snapshot` still have alive handles.\n\nEntities that were already tracked at the time of the snapshot are ignored,\neven if they still have handles. Only *new* entities (those whose\n`EntityId` was not present in the snapshot) are considered leaks.\n\n# Panics\n\nPanics if any new entity handles exist. The panic message lists every\nleaked entity with its type name, and includes allocation-site backtraces\nwhen `LEAK_BACKTRACE` is set.", "signature": "pub fn assert_no_new_leaks (& self, snapshot : & LeakDetectorSnapshot)", "cfg": [], "target": "LeakDetector" }, { "id": "gpui::app::entity_map::LeakDetector::assert_released", "name": "assert_released", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Asserts that all handles to the given entity have been released.", "documentation": "Asserts that all handles to the given entity have been released.\n\n# Panics\n\nPanics if any handles to the entity are still alive. The panic message\nincludes backtraces for each leaked handle if `LEAK_BACKTRACE` is set,\notherwise it suggests setting the environment variable to get more info.", "signature": "pub fn assert_released (& mut self, entity_id : EntityId)", "cfg": [], "target": "LeakDetector" }, { "id": "gpui::app::entity_map::LeakDetector::handle_created", "name": "handle_created", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Records that a new handle has been created for the given entity.", "documentation": "Records that a new handle has been created for the given entity.\n\nReturns a unique `HandleId` that must be passed to `handle_released` when\nthe handle is dropped. If `LEAK_BACKTRACE` is set, captures a backtrace\nat the allocation site.", "signature": "pub fn handle_created (& mut self, entity_id : EntityId, type_name : Option<& 'static str>,) -> HandleId", "cfg": [], "target": "LeakDetector" }, { "id": "gpui::app::entity_map::LeakDetector::handle_released", "name": "handle_released", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Records that a handle has been released (dropped).", "documentation": "Records that a handle has been released (dropped).\n\nThis removes the handle from tracking. The `handle_id` should be the same\none returned by `handle_created` when the handle was allocated.", "signature": "pub fn handle_released (& mut self, entity_id : EntityId, handle_id : HandleId)", "cfg": [], "target": "LeakDetector" }, { "id": "gpui::app::entity_map::LeakDetector::snapshot", "name": "snapshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Captures a snapshot of all entity IDs that currently have alive handles.", "documentation": "Captures a snapshot of all entity IDs that currently have alive handles.\n\nThe returned [`LeakDetectorSnapshot`] can later be passed to\n[`assert_no_new_leaks`](Self::assert_no_new_leaks) to verify that no\nentities created after the snapshot are still alive.", "signature": "pub fn snapshot (& self) -> LeakDetectorSnapshot", "cfg": [], "target": "LeakDetector" }, { "id": "gpui::app::entity_map::LeakDetectorSnapshot", "name": "LeakDetectorSnapshot", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "A snapshot of the set of alive entities at a point in time.", "documentation": "A snapshot of the set of alive entities at a point in time.\n\nCreated by [`App::leak_detector_snapshot`](crate::App::leak_detector_snapshot).\nCan later be passed to\n[`App::assert_no_new_leaks`](crate::App::assert_no_new_leaks) to verify that\nno new entity handles remain between the snapshot and the current state.", "signature": "# [doc = \" A snapshot of the set of alive entities at a point in time.\"] # [doc = \"\"] # [doc = \" Created by [`App::leak_detector_snapshot`](crate::App::leak_detector_snapshot).\"] # [doc = \" Can later be passed to\"] # [doc = \" [`App::assert_no_new_leaks`](crate::App::assert_no_new_leaks) to verify that\"] # [doc = \" no new entity handles remain between the snapshot and the current state.\"] # [cfg (any (test, feature = \"leak-detection\"))] pub struct LeakDetectorSnapshot { entity_ids : collections::HashSet, }", "cfg": [ "cfg (any (test, feature = \"leak-detection\"))" ] }, { "id": "gpui::app::entity_map::WeakEntity", "name": "WeakEntity", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "A weak reference to a entity of the given type.", "documentation": "A weak reference to a entity of the given type.", "signature": "# [doc = \" A weak reference to a entity of the given type.\"] # [derive (Deref, DerefMut)] pub struct WeakEntity { # [deref] # [deref_mut] any_entity : AnyWeakEntity, entity_type : PhantomData T>, }", "cfg": [] }, { "id": "gpui::app::entity_map::WeakEntity::new_invalid", "name": "new_invalid", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Create a new weak entity that can never be upgraded.", "documentation": "Create a new weak entity that can never be upgraded.", "signature": "pub fn new_invalid () -> Self", "cfg": [], "target": "WeakEntity" }, { "id": "gpui::app::entity_map::WeakEntity::read_with", "name": "read_with", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Reads the entity referenced by this handle with the given function if the referenced entity still exists. Returns an error if the entity has been released.", "documentation": "Reads the entity referenced by this handle with the given function if\nthe referenced entity still exists. Returns an error if the entity has\nbeen released.", "signature": "pub fn read_with (& self, cx : & C, read : impl FnOnce (& T, & App) -> R) -> Result where C : AppContext,", "cfg": [], "target": "WeakEntity" }, { "id": "gpui::app::entity_map::WeakEntity::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Updates the entity referenced by this handle with the given function if the referenced entity still exists. Returns an error if the entity has been released.", "documentation": "Updates the entity referenced by this handle with the given function if\nthe referenced entity still exists. Returns an error if the entity has\nbeen released.", "signature": "pub fn update (& self, cx : & mut C, update : impl FnOnce (& mut T, & mut Context) -> R,) -> Result where C : AppContext,", "cfg": [], "target": "WeakEntity" }, { "id": "gpui::app::entity_map::WeakEntity::update_in", "name": "update_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Updates the entity referenced by this handle with the given function if the referenced entity still exists, within a visual context that has a window. Returns an error if the entity has been released.", "documentation": "Updates the entity referenced by this handle with the given function if\nthe referenced entity still exists, within a visual context that has a window.\nReturns an error if the entity has been released.", "signature": "pub fn update_in (& self, cx : & mut C, update : impl FnOnce (& mut T, & mut Window, & mut Context) -> R,) -> Result where C : AppContext,", "cfg": [], "target": "WeakEntity" }, { "id": "gpui::app::entity_map::WeakEntity::upgrade", "name": "upgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::entity_map", "path": "gpui::app::entity_map", "source": "crates/gpui/src/app/entity_map.rs", "summary": "Upgrade this weak entity reference into a strong entity reference", "documentation": "Upgrade this weak entity reference into a strong entity reference", "signature": "pub fn upgrade (& self) -> Option>", "cfg": [], "target": "WeakEntity" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext", "name": "HeadlessAppContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "A cross-platform headless app context for tests that need real text shaping.", "documentation": "A cross-platform headless app context for tests that need real text shaping.\n\nUnlike the old `HeadlessMetalAppContext`, this works on any platform. It uses\n`TestPlatform` for deterministic scheduling and accepts a pluggable\n`PlatformTextSystem` so tests get real glyph measurements.\n\n# Usage\n\n```ignore\nlet text_system = Arc::new(gpui_wgpu::CosmicTextSystem::new(\"fallback\"));\nlet mut cx = HeadlessAppContext::with_platform(\ntext_system,\nArc::new(Assets),\n|| gpui_platform::current_headless_renderer(),\n);\n```", "signature": "# [doc = \" A cross-platform headless app context for tests that need real text shaping.\"] # [doc = \"\"] # [doc = \" Unlike the old `HeadlessMetalAppContext`, this works on any platform. It uses\"] # [doc = \" `TestPlatform` for deterministic scheduling and accepts a pluggable\"] # [doc = \" `PlatformTextSystem` so tests get real glyph measurements.\"] # [doc = \"\"] # [doc = \" # Usage\"] # [doc = \"\"] # [doc = \" ```ignore\"] # [doc = \" let text_system = Arc::new(gpui_wgpu::CosmicTextSystem::new(\\\"fallback\\\"));\"] # [doc = \" let mut cx = HeadlessAppContext::with_platform(\"] # [doc = \" text_system,\"] # [doc = \" Arc::new(Assets),\"] # [doc = \" || gpui_platform::current_headless_renderer(),\"] # [doc = \");\"] # [doc = \" ```\"] pub struct HeadlessAppContext { # [doc = \" The underlying app cell.\"] pub app : Rc, # [doc = \" The background executor for running async tasks.\"] pub background_executor : BackgroundExecutor, # [doc = \" The foreground executor for running tasks on the main thread.\"] pub foreground_executor : ForegroundExecutor, dispatcher : TestDispatcher, text_system : Arc, }", "cfg": [] }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::advance_clock", "name": "advance_clock", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Advances the simulated clock.", "documentation": "Advances the simulated clock.", "signature": "pub fn advance_clock (& self, duration : Duration)", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::allow_parking", "name": "allow_parking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Enables parking mode, allowing blocking on real I/O (e.g., async asset loading).", "documentation": "Enables parking mode, allowing blocking on real I/O (e.g., async asset loading).", "signature": "pub fn allow_parking (& self)", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::background_executor", "name": "background_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Returns the background executor.", "documentation": "Returns the background executor.", "signature": "pub fn background_executor (& self) -> & BackgroundExecutor", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::capture_screenshot", "name": "capture_screenshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Captures a screenshot from a window.", "documentation": "Captures a screenshot from a window.\n\nRequires that the context was created with a renderer factory that\nreturns `Some` via [`HeadlessAppContext::with_platform`].", "signature": "pub fn capture_screenshot (& mut self, window : AnyWindowHandle) -> Result", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::forbid_parking", "name": "forbid_parking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Disables parking mode, returning to deterministic test execution.", "documentation": "Disables parking mode, returning to deterministic test execution.", "signature": "pub fn forbid_parking (& self)", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Returns the foreground executor.", "documentation": "Returns the foreground executor.", "signature": "pub fn foreground_executor (& self) -> & ForegroundExecutor", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Creates a new headless app context with the given text system.", "documentation": "Creates a new headless app context with the given text system.", "signature": "pub fn new (platform_text_system : Arc) -> Self", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::open_window", "name": "open_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Opens a window for headless rendering.", "documentation": "Opens a window for headless rendering.", "signature": "pub fn open_window (& mut self, size : Size, build_root : impl FnOnce (& mut Window, & mut App) -> Entity,) -> Result>", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Runs all pending tasks until parked.", "documentation": "Runs all pending tasks until parked.", "signature": "pub fn run_until_parked (& self)", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Returns the text system.", "documentation": "Returns the text system.", "signature": "pub fn text_system (& self) -> & Arc", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Updates app state.", "documentation": "Updates app state.", "signature": "pub fn update (& mut self, f : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::update_window", "name": "update_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Updates a window and calls draw to render.", "documentation": "Updates a window and calls draw to render.", "signature": "pub fn update_window (& mut self, window : AnyWindowHandle, f : impl FnOnce (AnyView, & mut Window, & mut App) -> R,) -> Result", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::with_asset_source", "name": "with_asset_source", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Creates a new headless app context with a custom text system and asset source.", "documentation": "Creates a new headless app context with a custom text system and asset source.", "signature": "pub fn with_asset_source (platform_text_system : Arc, asset_source : Arc,) -> Self", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::headless_app_context::HeadlessAppContext::with_platform", "name": "with_platform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::headless_app_context", "path": "gpui::app::headless_app_context", "source": "crates/gpui/src/app/headless_app_context.rs", "summary": "Creates a new headless app context with the given text system, asset source, and an optional renderer factory for screenshot support.", "documentation": "Creates a new headless app context with the given text system, asset source,\nand an optional renderer factory for screenshot support.", "signature": "pub fn with_platform (platform_text_system : Arc, asset_source : Arc, renderer_factory : impl Fn () -> Option> + 'static,) -> Self", "cfg": [], "target": "HeadlessAppContext" }, { "id": "gpui::app::reexport-1", "name": "async_context :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub use async_context::*;", "cfg": [] }, { "id": "gpui::app::reexport-2", "name": "bench_context :: { BenchAppContext , BenchReport , BenchWindowContext , bench_platform }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [cfg (feature = \"bench\")] pub use bench_context::{ BenchAppContext, BenchReport, BenchWindowContext, bench_platform };", "cfg": [ "cfg (feature = \"bench\")" ] }, { "id": "gpui::app::reexport-3", "name": "context :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub use context::*;", "cfg": [] }, { "id": "gpui::app::reexport-4", "name": "entity_map :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "pub use entity_map::*;", "cfg": [] }, { "id": "gpui::app::reexport-5", "name": "headless_app_context :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use headless_app_context::*;", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::app::reexport-6", "name": "test_app :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use test_app::*;", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::app::reexport-7", "name": "test_context :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use test_context::*;", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::app::reexport-8", "name": "visual_test_context :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "app", "path": "gpui::app", "source": "crates/gpui/src/app.rs", "summary": "", "documentation": "", "signature": "# [cfg (all (target_os = \"macos\", any (test, feature = \"test-support\")))] pub use visual_test_context::*;", "cfg": [ "cfg (all (target_os = \"macos\", any (test, feature = \"test-support\")))" ] }, { "id": "gpui::app::test_app::TestApp", "name": "TestApp", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "A test application context with a clean API.", "documentation": "A test application context with a clean API.\n\nUnlike `TestAppContext`, `TestApp` automatically flushes effects after\neach update and provides simpler window management.", "signature": "# [doc = \" A test application context with a clean API.\"] # [doc = \"\"] # [doc = \" Unlike `TestAppContext`, `TestApp` automatically flushes effects after\"] # [doc = \" each update and provides simpler window management.\"] pub struct TestApp { app : Rc, platform : Rc, background_executor : BackgroundExecutor, foreground_executor : ForegroundExecutor, # [allow (dead_code)] dispatcher : TestDispatcher, text_system : Arc, }", "cfg": [] }, { "id": "gpui::app::test_app::TestApp::advance_clock", "name": "advance_clock", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Advance the simulated clock by the given duration.", "documentation": "Advance the simulated clock by the given duration.", "signature": "pub fn advance_clock (& self, duration : Duration)", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::background_executor", "name": "background_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get the background executor.", "documentation": "Get the background executor.", "signature": "pub fn background_executor (& self) -> & BackgroundExecutor", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::background_spawn", "name": "background_spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Spawn a future on the background executor.", "documentation": "Spawn a future on the background executor.", "signature": "pub fn background_spawn (& self, future : impl Future + Send + 'static) -> Task where R : Send + 'static,", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::did_prompt_for_new_path", "name": "did_prompt_for_new_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Check if a file path prompt is pending.", "documentation": "Check if a file path prompt is pending.", "signature": "pub fn did_prompt_for_new_path (& self) -> bool", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get the foreground executor.", "documentation": "Get the foreground executor.", "signature": "pub fn foreground_executor (& self) -> & ForegroundExecutor", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::has_global", "name": "has_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Check if a global of the given type exists.", "documentation": "Check if a global of the given type exists.", "signature": "pub fn has_global (& self) -> bool", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::has_pending_prompt", "name": "has_pending_prompt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Check if a prompt dialog is pending.", "documentation": "Check if a prompt dialog is pending.", "signature": "pub fn has_pending_prompt (& self) -> bool", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Create a new test application.", "documentation": "Create a new test application.", "signature": "pub fn new () -> Self", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::new_entity", "name": "new_entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Create a new entity in the app.", "documentation": "Create a new entity in the app.", "signature": "pub fn new_entity (& mut self, build : impl FnOnce (& mut Context) -> T,) -> Entity", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::open_window", "name": "open_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Open a test window with the given root view, using maximized bounds.", "documentation": "Open a test window with the given root view, using maximized bounds.", "signature": "pub fn open_window (& mut self, build_view : impl FnOnce (& mut Window, & mut Context) -> V,) -> TestAppWindow", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::open_window_with_options", "name": "open_window_with_options", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Open a test window with specific options.", "documentation": "Open a test window with specific options.", "signature": "pub fn open_window_with_options (& mut self, options : WindowOptions, build_view : impl FnOnce (& mut Window, & mut Context) -> V,) -> TestAppWindow", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::opened_url", "name": "opened_url", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get URLs that have been opened via `cx.open_url()`.", "documentation": "Get URLs that have been opened via `cx.open_url()`.", "signature": "pub fn opened_url (& self) -> Option", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Run a closure with read-only access to the App context.", "documentation": "Run a closure with read-only access to the App context.", "signature": "pub fn read (& self, f : impl FnOnce (& App) -> R) -> R", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::read_entity", "name": "read_entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Read an entity.", "documentation": "Read an entity.", "signature": "pub fn read_entity (& self, entity : & Entity, f : impl FnOnce (& T, & App) -> R,) -> R", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::read_from_clipboard", "name": "read_from_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Read from the simulated clipboard.", "documentation": "Read from the simulated clipboard.", "signature": "pub fn read_from_clipboard (& self) -> Option", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::read_global", "name": "read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Read a global value.", "documentation": "Read a global value.", "signature": "pub fn read_global (& self, f : impl FnOnce (& G, & App) -> R) -> R", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Run pending tasks until there's nothing left to do.", "documentation": "Run pending tasks until there's nothing left to do.", "signature": "pub fn run_until_parked (& self)", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::set_global", "name": "set_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Set a global value.", "documentation": "Set a global value.", "signature": "pub fn set_global (& mut self, global : G)", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::simulate_new_path_selection", "name": "simulate_new_path_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate answering a path selection dialog.", "documentation": "Simulate answering a path selection dialog.", "signature": "pub fn simulate_new_path_selection (& self, select : impl FnOnce (& std::path::Path) -> Option,)", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::simulate_prompt_answer", "name": "simulate_prompt_answer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate answering a prompt dialog.", "documentation": "Simulate answering a prompt dialog.", "signature": "pub fn simulate_prompt_answer (& self, button : & str)", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Spawn a future on the foreground executor.", "documentation": "Spawn a future on the foreground executor.", "signature": "pub fn spawn (& self, f : impl FnOnce (AsyncApp) -> Fut) -> Task where Fut : Future + 'static, R : 'static,", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get the text system.", "documentation": "Get the text system.", "signature": "pub fn text_system (& self) -> & Arc", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::to_async", "name": "to_async", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get an async handle to the app.", "documentation": "Get an async handle to the app.", "signature": "pub fn to_async (& self) -> AsyncApp", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Run a closure with mutable access to the App context. Automatically runs until parked after the closure completes.", "documentation": "Run a closure with mutable access to the App context.\nAutomatically runs until parked after the closure completes.", "signature": "pub fn update (& mut self, f : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::update_entity", "name": "update_entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Update an entity.", "documentation": "Update an entity.", "signature": "pub fn update_entity (& mut self, entity : & Entity, f : impl FnOnce (& mut T, & mut Context) -> R,) -> R", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::update_global", "name": "update_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Update a global value.", "documentation": "Update a global value.", "signature": "pub fn update_global (& mut self, f : impl FnOnce (& mut G, & mut App) -> R) -> R", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::windows", "name": "windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get all open windows.", "documentation": "Get all open windows.", "signature": "pub fn windows (& self) -> Vec", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::with_seed", "name": "with_seed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Create a new test application with a specific random seed.", "documentation": "Create a new test application with a specific random seed.", "signature": "pub fn with_seed (seed : u64) -> Self", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::with_text_system", "name": "with_text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Create a new test application with a custom text system for real font shaping.", "documentation": "Create a new test application with a custom text system for real font shaping.", "signature": "pub fn with_text_system (text_system : Arc) -> Self", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::with_text_system_and_assets", "name": "with_text_system_and_assets", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Create a new test application with a custom text system and asset source.", "documentation": "Create a new test application with a custom text system and asset source.", "signature": "pub fn with_text_system_and_assets (text_system : Arc, asset_source : Arc,) -> Self", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestApp::write_to_clipboard", "name": "write_to_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Write text to the simulated clipboard.", "documentation": "Write text to the simulated clipboard.", "signature": "pub fn write_to_clipboard (& self, item : ClipboardItem)", "cfg": [], "target": "TestApp" }, { "id": "gpui::app::test_app::TestAppWindow", "name": "TestAppWindow", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "A test window with inspection and simulation capabilities.", "documentation": "A test window with inspection and simulation capabilities.", "signature": "# [doc = \" A test window with inspection and simulation capabilities.\"] pub struct TestAppWindow { handle : WindowHandle, app : Rc, platform : Rc, background_executor : BackgroundExecutor, }", "cfg": [] }, { "id": "gpui::app::test_app::TestAppWindow::draw", "name": "draw", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Force a redraw of the window.", "documentation": "Force a redraw of the window.", "signature": "pub fn draw (& mut self)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::handle", "name": "handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get the window handle.", "documentation": "Get the window handle.", "signature": "pub fn handle (& self) -> WindowHandle", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Read the root view.", "documentation": "Read the root view.", "signature": "pub fn read (& self, f : impl FnOnce (& V, & App) -> R) -> R", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::root", "name": "root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get the root view entity.", "documentation": "Get the root view entity.", "signature": "pub fn root (& self) -> Entity", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_click", "name": "simulate_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate a click at the given position.", "documentation": "Simulate a click at the given position.", "signature": "pub fn simulate_click (& mut self, position : Point, button : MouseButton)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_event", "name": "simulate_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate an input event.", "documentation": "Simulate an input event.", "signature": "pub fn simulate_event (& mut self, event : E)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_input", "name": "simulate_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate typing text.", "documentation": "Simulate typing text.", "signature": "pub fn simulate_input (& mut self, input : & str)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_keystroke", "name": "simulate_keystroke", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate a keystroke.", "documentation": "Simulate a keystroke.", "signature": "pub fn simulate_keystroke (& mut self, keystroke : & str)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_keystrokes", "name": "simulate_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate multiple keystrokes (space-separated).", "documentation": "Simulate multiple keystrokes (space-separated).", "signature": "pub fn simulate_keystrokes (& mut self, keystrokes : & str)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_mouse_down", "name": "simulate_mouse_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate a mouse down event.", "documentation": "Simulate a mouse down event.", "signature": "pub fn simulate_mouse_down (& mut self, position : Point, button : MouseButton)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_mouse_move", "name": "simulate_mouse_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate a mouse move.", "documentation": "Simulate a mouse move.", "signature": "pub fn simulate_mouse_move (& mut self, position : Point)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_mouse_up", "name": "simulate_mouse_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate a mouse up event.", "documentation": "Simulate a mouse up event.", "signature": "pub fn simulate_mouse_up (& mut self, position : Point, button : MouseButton)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_resize", "name": "simulate_resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate resizing the window.", "documentation": "Simulate resizing the window.", "signature": "pub fn simulate_resize (& mut self, size : Size)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::simulate_scroll", "name": "simulate_scroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Simulate a scroll event.", "documentation": "Simulate a scroll event.", "signature": "pub fn simulate_scroll (& mut self, position : Point, delta : Point)", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::title", "name": "title", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Get the window title.", "documentation": "Get the window title.", "signature": "pub fn title (& self) -> Option", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_app::TestAppWindow::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_app", "path": "gpui::app::test_app", "source": "crates/gpui/src/app/test_app.rs", "summary": "Update the root view.", "documentation": "Update the root view.", "signature": "pub fn update (& mut self, f : impl FnOnce (& mut V, & mut Window, & mut Context) -> R) -> R", "cfg": [], "target": "TestAppWindow" }, { "id": "gpui::app::test_context::AnyWindowHandle::build_entity", "name": "build_entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Creates the given view in this window.", "documentation": "Creates the given view in this window.", "signature": "pub fn build_entity (& self, cx : & mut TestAppContext, build_view : impl FnOnce (& mut Window, & mut Context) -> V,) -> Entity", "cfg": [], "target": "AnyWindowHandle" }, { "id": "gpui::app::test_context::Entity::condition", "name": "condition", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns a future that resolves when the condition becomes true.", "documentation": "Returns a future that resolves when the condition becomes true.", "signature": "pub fn condition (& self, cx : & TestAppContext, mut predicate : impl FnMut (& V, & App) -> bool,) -> impl Future where Evt : 'static, V : EventEmitter,", "cfg": [], "target": "Entity" }, { "id": "gpui::app::test_context::Entity::next_event", "name": "next_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Block until the next event is emitted by the entity, then return it.", "documentation": "Block until the next event is emitted by the entity, then return it.", "signature": "pub fn next_event (& self, cx : & mut TestAppContext) -> impl Future where Event : Send + Clone + 'static, T : EventEmitter,", "cfg": [], "target": "Entity" }, { "id": "gpui::app::test_context::Entity::next_notification", "name": "next_notification", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns a future that resolves when the view is next updated.", "documentation": "Returns a future that resolves when the view is next updated.", "signature": "pub fn next_notification (& self, advance_clock_by : Duration, cx : & TestAppContext,) -> impl Future", "cfg": [], "target": "Entity" }, { "id": "gpui::app::test_context::TestAppContext", "name": "TestAppContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "A TestAppContext is provided to tests created with `#[gpui::test]`, it provides an implementation of `Context` with additional methods that are useful in tests.", "documentation": "A TestAppContext is provided to tests created with `#[gpui::test]`, it provides\nan implementation of `Context` with additional methods that are useful in tests.", "signature": "# [doc = \" A TestAppContext is provided to tests created with `#[gpui::test]`, it provides\"] # [doc = \" an implementation of `Context` with additional methods that are useful in tests.\"] # [derive (Clone)] pub struct TestAppContext { # [doc (hidden)] pub background_executor : BackgroundExecutor, # [doc (hidden)] pub foreground_executor : ForegroundExecutor, # [doc (hidden)] pub dispatcher : TestDispatcher, pub (crate) test_platform : Rc, text_system : Arc, fn_name : Option<& 'static str>, on_quit : Rc>>>, # [doc (hidden)] pub app : Rc, }", "cfg": [] }, { "id": "gpui::app::test_context::TestAppContext::activate_accessibility", "name": "activate_accessibility", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Activates the test window's platform accessibility adapter.", "documentation": "Activates the test window's platform accessibility adapter.", "signature": "pub fn activate_accessibility (& mut self, window : AnyWindowHandle)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::add_empty_window", "name": "add_empty_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Adds a new window with no content.", "documentation": "Adds a new window with no content.", "signature": "pub fn add_empty_window (& mut self) -> & mut VisualTestContext", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::add_window", "name": "add_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Adds a new window. The Window will always be backed by a `TestWindow` which can be retrieved with `self.test_window(handle)`", "documentation": "Adds a new window. The Window will always be backed by a `TestWindow` which\ncan be retrieved with `self.test_window(handle)`", "signature": "pub fn add_window (& mut self, build_window : F) -> WindowHandle where F : FnOnce (& mut Window, & mut Context) -> V, V : 'static + Render,", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::add_window_view", "name": "add_window_view", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Adds a new window, and returns its root view and a `VisualTestContext` which can be used as a `Window` and `App` for the rest of the test. Typically you would shadow this context with the returned one. `let (view, cx) = cx.add_window_view(...);`", "documentation": "Adds a new window, and returns its root view and a `VisualTestContext` which can be used\nas a `Window` and `App` for the rest of the test. Typically you would shadow this context with\nthe returned one. `let (view, cx) = cx.add_window_view(...);`", "signature": "pub fn add_window_view (& mut self, build_root_view : F,) -> (Entity, & mut VisualTestContext) where F : FnOnce (& mut Window, & mut Context) -> V, V : 'static + Render,", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::app_identity", "name": "app_identity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns the application identity configured during this test.", "documentation": "Returns the application identity configured during this test.", "signature": "pub fn app_identity (& self) -> Option<(SharedString, SharedString)>", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::build", "name": "build", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Creates a new `TestAppContext`. Usually you can rely on `#[gpui::test]` to do this for you.", "documentation": "Creates a new `TestAppContext`. Usually you can rely on `#[gpui::test]` to do this for you.", "signature": "pub fn build (dispatcher : TestDispatcher, fn_name : Option<& 'static str>) -> Self", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::condition", "name": "condition", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Runs until the given condition becomes true. (Prefer `run_until_parked` if you don't need to jump in at a specific time).", "documentation": "Runs until the given condition becomes true. (Prefer `run_until_parked` if you\ndon't need to jump in at a specific time).", "signature": "pub async fn condition (& mut self, entity : & Entity, mut predicate : impl FnMut (& mut T, & mut Context) -> bool,)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::delivered_system_notifications", "name": "delivered_system_notifications", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns the system notifications currently delivered by the test platform.", "documentation": "Returns the system notifications currently delivered by the test platform.", "signature": "pub fn delivered_system_notifications (& self) -> Vec", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::did_prompt_for_new_path", "name": "did_prompt_for_new_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Checks whether there have been any new path prompts received by the platform.", "documentation": "Checks whether there have been any new path prompts received by the platform.", "signature": "pub fn did_prompt_for_new_path (& self) -> bool", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::did_prompt_for_paths", "name": "did_prompt_for_paths", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns true if there's a path selection dialog pending.", "documentation": "Returns true if there's a path selection dialog pending.", "signature": "pub fn did_prompt_for_paths (& self) -> bool", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::dismiss_context_menu", "name": "dismiss_context_menu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates closing the pending native context menu without a selection.", "documentation": "Simulates closing the pending native context menu without a selection.", "signature": "pub fn dismiss_context_menu (& self, window : AnyWindowHandle)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::dismissed_system_notifications", "name": "dismissed_system_notifications", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns the tags of all system notifications dismissed during this test, in order.", "documentation": "Returns the tags of all system notifications dismissed during this test, in order.", "signature": "pub fn dismissed_system_notifications (& self) -> Vec", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::dispatch_accessibility_action", "name": "dispatch_accessibility_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Delivers an AccessKit action to the same listener path used by a platform adapter.", "documentation": "Delivers an AccessKit action to the same listener path used by a\nplatform adapter.", "signature": "pub fn dispatch_accessibility_action (& mut self, window : AnyWindowHandle, request : accesskit::ActionRequest,)", "cfg": [ "cfg (not (target_family = \"wasm\"))" ], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::dispatch_action", "name": "dispatch_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate dispatching an action to the currently focused node in the window.", "documentation": "Simulate dispatching an action to the currently focused node in the window.", "signature": "pub fn dispatch_action (& mut self, window : AnyWindowHandle, action : A) where A : Action,", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::dispatch_keystroke", "name": "dispatch_keystroke", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "dispatches a single Keystroke (see also `simulate_keystrokes` and `simulate_input`)", "documentation": "dispatches a single Keystroke (see also `simulate_keystrokes` and `simulate_input`)", "signature": "pub fn dispatch_keystroke (& mut self, window : AnyWindowHandle, keystroke : Keystroke)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::events", "name": "events", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns a stream of events emitted by the given Entity.", "documentation": "Returns a stream of events emitted by the given Entity.", "signature": "pub fn events> (& mut self, entity : & Entity,) -> futures::channel::mpsc::UnboundedReceiver where Evt : 'static + Clone,", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::executor", "name": "executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns an executor (for running tasks in the background)", "documentation": "Returns an executor (for running tasks in the background)", "signature": "pub fn executor (& self) -> BackgroundExecutor", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::expect_restart", "name": "expect_restart", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns true if there's an alert dialog open.", "documentation": "Returns true if there's an alert dialog open.", "signature": "pub fn expect_restart (& self) -> oneshot::Receiver>", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns an executor (for running tasks on the main thread)", "documentation": "Returns an executor (for running tasks on the main thread)", "signature": "pub fn foreground_executor (& self) -> & ForegroundExecutor", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::has_global", "name": "has_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "true if the given global is defined", "documentation": "true if the given global is defined", "signature": "pub fn has_global (& self) -> bool", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::has_pending_prompt", "name": "has_pending_prompt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns true if there's an alert dialog open.", "documentation": "Returns true if there's an alert dialog open.", "signature": "pub fn has_pending_prompt (& self) -> bool", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::new_app", "name": "new_app", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "returns a new `TestAppContext` re-using the same executors to interleave tasks.", "documentation": "returns a new `TestAppContext` re-using the same executors to interleave tasks.", "signature": "pub fn new_app (& self) -> TestAppContext", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::notifications", "name": "notifications", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns a stream of notifications whenever the Entity is updated.", "documentation": "Returns a stream of notifications whenever the Entity is updated.", "signature": "pub fn notifications (& mut self, entity : & Entity,) -> impl Stream + use", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::on_quit", "name": "on_quit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Register cleanup to run when the test ends.", "documentation": "Register cleanup to run when the test ends.", "signature": "pub fn on_quit (& mut self, f : impl FnOnce () + 'static)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::open_window", "name": "open_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Opens a new window with a specific size.", "documentation": "Opens a new window with a specific size.\n\nUnlike `add_window` which uses maximized bounds, this allows controlling\nthe window dimensions, which is important for layout-sensitive tests.", "signature": "pub fn open_window (& mut self, window_size : Size, build_window : F,) -> WindowHandle where F : FnOnce (& mut Window, & mut Context) -> V, V : 'static + Render,", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::opened_url", "name": "opened_url", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "All the urls that have been opened with cx.open_url() during this test.", "documentation": "All the urls that have been opened with cx.open_url() during this test.", "signature": "pub fn opened_url (& self) -> Option", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::pending_context_menu_position", "name": "pending_context_menu_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns the logical window position of the pending native context menu.", "documentation": "Returns the logical window position of the pending native context menu.", "signature": "pub fn pending_context_menu_position (& self, window : AnyWindowHandle) -> Option>", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::pending_prompt", "name": "pending_prompt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns true if there's an alert dialog open.", "documentation": "Returns true if there's an alert dialog open.", "signature": "pub fn pending_prompt (& self) -> Option<(String, String)>", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::quit", "name": "quit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Called by the test helper to end the test. public so the macro can call it.", "documentation": "Called by the test helper to end the test.\npublic so the macro can call it.", "signature": "pub fn quit (& self)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Gives you an `&App` for the duration of the closure", "documentation": "Gives you an `&App` for the duration of the closure", "signature": "pub fn read (& self, f : impl FnOnce (& App) -> R) -> R", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::read_from_clipboard", "name": "read_from_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates reading from the platform clipboard. This will return the most recent value from `write_to_clipboard`.", "documentation": "Simulates reading from the platform clipboard.\nThis will return the most recent value from `write_to_clipboard`.", "signature": "pub fn read_from_clipboard (& self) -> Option", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::read_global", "name": "read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "runs the given closure with a reference to the global panics if `has_global` would return false.", "documentation": "runs the given closure with a reference to the global\npanics if `has_global` would return false.", "signature": "pub fn read_global (& self, read : impl FnOnce (& G, & App) -> R) -> R", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::refresh", "name": "refresh", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Schedules all windows to be redrawn on the next effect cycle.", "documentation": "Schedules all windows to be redrawn on the next effect cycle.", "signature": "pub fn refresh (& mut self) -> Result<()>", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Wait until there are no more pending tasks.", "documentation": "Wait until there are no more pending tasks.", "signature": "pub fn run_until_parked (& self)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::select_context_menu_item", "name": "select_context_menu_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates choosing one native context-menu item by its recursive index path, for example `[2, 0]` for the first item of the third submenu.", "documentation": "Simulates choosing one native context-menu item by its recursive index\npath, for example `[2, 0]` for the first item of the third submenu.", "signature": "pub fn select_context_menu_item (& self, window : AnyWindowHandle, path : & [usize])", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::set_global", "name": "set_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "sets the global in this context.", "documentation": "sets the global in this context.", "signature": "pub fn set_global (& mut self, global : G)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::set_name", "name": "set_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Set a name for this App.", "documentation": "Set a name for this App.", "signature": "pub fn set_name (& mut self, name : & 'static str)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::set_native_context_menu_cancel_fails", "name": "set_native_context_menu_cancel_fails", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates native cancellation refusal without closing the menu. Its revision is still invalidated, so later native commands cannot dispatch.", "documentation": "Simulates native cancellation refusal without closing the menu. Its\nrevision is still invalidated, so later native commands cannot dispatch.", "signature": "pub fn set_native_context_menu_cancel_fails (& self, window : AnyWindowHandle, fails : bool)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::set_native_context_menus_supported", "name": "set_native_context_menus_supported", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Controls whether the test window accepts platform-native context menus. Test windows default to unsupported so component fallback rendering is exercised unless a test opts into the native contract.", "documentation": "Controls whether the test window accepts platform-native context menus.\nTest windows default to unsupported so component fallback rendering is\nexercised unless a test opts into the native contract.", "signature": "pub fn set_native_context_menus_supported (& self, window : AnyWindowHandle, supported : bool)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::set_screen_capture_sources", "name": "set_screen_capture_sources", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Causes the given sources to be returned if the application queries for screen capture sources.", "documentation": "Causes the given sources to be returned if the application queries for screen\ncapture sources.", "signature": "pub fn set_screen_capture_sources (& self, sources : Vec)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::shown_system_notifications", "name": "shown_system_notifications", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns all system notifications shown during this test, in order.", "documentation": "Returns all system notifications shown during this test, in order.", "signature": "pub fn shown_system_notifications (& self) -> Vec", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_input", "name": "simulate_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "simulate_input takes a string of text to type. cx.simulate_input(\"abc\") will type abc into your current editor This will also run the background executor until it's parked.", "documentation": "simulate_input takes a string of text to type.\ncx.simulate_input(\"abc\")\nwill type abc into your current editor\nThis will also run the background executor until it's parked.", "signature": "pub fn simulate_input (& mut self, window : AnyWindowHandle, input : & str)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_keystrokes", "name": "simulate_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "simulate_keystrokes takes a space-separated list of keys to type. cx.simulate_keystrokes(\"cmd-shift-p b k s p enter\") in Zed, this will run backspace on the current editor through the command palette. This will also run the background executor until it's parked.", "documentation": "simulate_keystrokes takes a space-separated list of keys to type.\ncx.simulate_keystrokes(\"cmd-shift-p b k s p enter\")\nin Zed, this will run backspace on the current editor through the command palette.\nThis will also run the background executor until it's parked.", "signature": "pub fn simulate_keystrokes (& mut self, window : AnyWindowHandle, keystrokes : & str)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_new_path_selection", "name": "simulate_new_path_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates choosing a File in the platform's \"Open\" dialog.", "documentation": "Simulates choosing a File in the platform's \"Open\" dialog.", "signature": "pub fn simulate_new_path_selection (& self, select_path : impl FnOnce (& std::path::Path) -> Option,)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_path_prompt_response", "name": "simulate_path_prompt_response", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates responding to a `prompt_for_paths` (\"Open\") dialog.", "documentation": "Simulates responding to a `prompt_for_paths` (\"Open\") dialog.", "signature": "pub fn simulate_path_prompt_response (& self, select_paths : impl FnOnce (& crate::PathPromptOptions) -> Option>,)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_prompt_answer", "name": "simulate_prompt_answer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates clicking a button in an platform-level alert dialog.", "documentation": "Simulates clicking a button in an platform-level alert dialog.", "signature": "pub fn simulate_prompt_answer (& self, button : & str)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_system_notification_response", "name": "simulate_system_notification_response", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates the user activating a system notification.", "documentation": "Simulates the user activating a system notification.", "signature": "pub fn simulate_system_notification_response (& self, response : SystemNotificationResponse)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_window_insets", "name": "simulate_window_insets", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates residual viewport occlusion through the platform inset callback. This changes test geometry, not an actual system keyboard or safe area.", "documentation": "Simulates residual viewport occlusion through the platform inset callback.\nThis changes test geometry, not an actual system keyboard or safe area.", "signature": "pub fn simulate_window_insets (& self, window : AnyWindowHandle, insets : crate::WindowInsets)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::simulate_window_resize", "name": "simulate_window_resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates the user resizing the window to the new size.", "documentation": "Simulates the user resizing the window to the new size.", "signature": "pub fn simulate_window_resize (& self, window_handle : AnyWindowHandle, size : Size)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::single", "name": "single", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Create a single TestAppContext, for non-multi-client tests", "documentation": "Create a single TestAppContext, for non-multi-client tests", "signature": "pub fn single () -> Self", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::skip_drawing", "name": "skip_drawing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Skip all drawing operations for the duration of this test.", "documentation": "Skip all drawing operations for the duration of this test.", "signature": "pub fn skip_drawing (& mut self)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Run the given task on the main thread.", "documentation": "Run the given task on the main thread.", "signature": "pub fn spawn (& self, f : impl FnOnce (AsyncApp) -> Fut) -> Task where Fut : Future + 'static, R : 'static,", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::test_function_name", "name": "test_function_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "The name of the test function that created this `TestAppContext`", "documentation": "The name of the test function that created this `TestAppContext`", "signature": "pub fn test_function_name (& self) -> Option<& 'static str>", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "returns the TextSystem", "documentation": "returns the TextSystem", "signature": "pub fn text_system (& self) -> & Arc", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::to_async", "name": "to_async", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns an `AsyncApp` which can be used to run tasks that expect to be on a background thread on the current thread in tests.", "documentation": "Returns an `AsyncApp` which can be used to run tasks that expect to be on a background\nthread on the current thread in tests.", "signature": "pub fn to_async (& self) -> AsyncApp", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::try_read_global", "name": "try_read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "runs the given closure with a reference to the global (if set)", "documentation": "runs the given closure with a reference to the global (if set)", "signature": "pub fn try_read_global (& self, read : impl FnOnce (& G, & App) -> R) -> Option", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Gives you an `&mut App` for the duration of the closure", "documentation": "Gives you an `&mut App` for the duration of the closure", "signature": "pub fn update (& self, f : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::update_global", "name": "update_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "updates the global in this context. (panics if `has_global` would return false)", "documentation": "updates the global in this context. (panics if `has_global` would return false)", "signature": "pub fn update_global (& mut self, update : impl FnOnce (& mut G, & mut App) -> R) -> R", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::windows", "name": "windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Returns all windows open in the test.", "documentation": "Returns all windows open in the test.", "signature": "pub fn windows (& self) -> Vec", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::TestAppContext::write_to_clipboard", "name": "write_to_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates writing to the platform clipboard", "documentation": "Simulates writing to the platform clipboard", "signature": "pub fn write_to_clipboard (& self, item : ClipboardItem)", "cfg": [], "target": "TestAppContext" }, { "id": "gpui::app::test_context::VisualTestContext", "name": "VisualTestContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "A VisualTestContext is the test-equivalent of a `Window` and `App`. It allows you to run window-specific test code. It can be dereferenced to a `TextAppContext`.", "documentation": "A VisualTestContext is the test-equivalent of a `Window` and `App`. It allows you to\nrun window-specific test code. It can be dereferenced to a `TextAppContext`.", "signature": "# [derive (Deref, DerefMut, Clone)] # [doc = \" A VisualTestContext is the test-equivalent of a `Window` and `App`. It allows you to\"] # [doc = \" run window-specific test code. It can be dereferenced to a `TextAppContext`.\"] pub struct VisualTestContext { # [deref] # [deref_mut] # [doc = \" cx is the original TestAppContext (you can more easily access this using Deref)\"] pub cx : TestAppContext, window : AnyWindowHandle, }", "cfg": [] }, { "id": "gpui::app::test_context::VisualTestContext::deactivate_window", "name": "deactivate_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates the user blurring the window.", "documentation": "Simulates the user blurring the window.", "signature": "pub fn deactivate_window (& mut self)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::debug_bounds", "name": "debug_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "debug_bounds returns the bounds of the element with the given selector.", "documentation": "debug_bounds returns the bounds of the element with the given selector.", "signature": "pub fn debug_bounds (& mut self, selector : & 'static str) -> Option>", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::dispatch_action", "name": "dispatch_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Dispatch the action to the currently focused node.", "documentation": "Dispatch the action to the currently focused node.", "signature": "pub fn dispatch_action (& mut self, action : A) where A : Action,", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::document_path", "name": "document_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Read the document path off the window (set by `Window#set_document_path`)", "documentation": "Read the document path off the window (set by `Window#set_document_path`)", "signature": "pub fn document_path (& mut self) -> Option", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::draw", "name": "draw", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Draw an element to the window. Useful for simulating events or actions", "documentation": "Draw an element to the window. Useful for simulating events or actions", "signature": "pub fn draw (& mut self, origin : Point, space : impl Into>, f : impl FnOnce (& mut Window, & mut App) -> E,) -> (E::RequestLayoutState, E::PrepaintState) where E : Element,", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::from_window", "name": "from_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Creates a new VisualTestContext. You would typically shadow the passed in TestAppContext with this, as this is typically more useful. `let cx = VisualTestContext::from_window(window, cx);`", "documentation": "Creates a new VisualTestContext. You would typically shadow the passed in\nTestAppContext with this, as this is typically more useful.\n`let cx = VisualTestContext::from_window(window, cx);`", "signature": "pub fn from_window (window : AnyWindowHandle, cx : & TestAppContext) -> Self", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::into_mut", "name": "into_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Get an &mut VisualTestContext (which is mostly what you need to pass to other methods). This method internally retains the VisualTestContext until the end of the test.", "documentation": "Get an &mut VisualTestContext (which is mostly what you need to pass to other methods).\nThis method internally retains the VisualTestContext until the end of the test.", "signature": "pub fn into_mut (self) -> & 'static mut Self", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Wait until there are no more pending tasks.", "documentation": "Wait until there are no more pending tasks.", "signature": "pub fn run_until_parked (& self)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_capslock_change", "name": "simulate_capslock_change", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a capslock changed event", "documentation": "Simulate a capslock changed event", "signature": "pub fn simulate_capslock_change (& mut self, on : bool)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_click", "name": "simulate_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a primary mouse click at the given point", "documentation": "Simulate a primary mouse click at the given point", "signature": "pub fn simulate_click (& mut self, position : Point, modifiers : Modifiers)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_close", "name": "simulate_close", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates the user closing the window. Returns true if the window was closed.", "documentation": "Simulates the user closing the window.\nReturns true if the window was closed.", "signature": "pub fn simulate_close (& mut self) -> bool", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_event", "name": "simulate_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate an event from the platform, e.g. a ScrollWheelEvent Make sure you've called [VisualTestContext::draw] first!", "documentation": "Simulate an event from the platform, e.g. a ScrollWheelEvent\nMake sure you've called [VisualTestContext::draw] first!", "signature": "pub fn simulate_event (& mut self, event : E)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_input", "name": "simulate_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate typing text `cx.simulate_input(\"hello\")` Automatically runs until parked.", "documentation": "Simulate typing text `cx.simulate_input(\"hello\")`\nAutomatically runs until parked.", "signature": "pub fn simulate_input (& mut self, input : & str)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_insets", "name": "simulate_insets", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates viewport insets and their redraw notification, not a native keyboard.", "documentation": "Simulates viewport insets and their redraw notification, not a native keyboard.", "signature": "pub fn simulate_insets (& self, insets : crate::WindowInsets)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_keystrokes", "name": "simulate_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a sequence of keystrokes `cx.simulate_keystrokes(\"cmd-p escape\")` Automatically runs until parked.", "documentation": "Simulate a sequence of keystrokes `cx.simulate_keystrokes(\"cmd-p escape\")`\nAutomatically runs until parked.", "signature": "pub fn simulate_keystrokes (& mut self, keystrokes : & str)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_modifiers_change", "name": "simulate_modifiers_change", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a modifiers changed event", "documentation": "Simulate a modifiers changed event", "signature": "pub fn simulate_modifiers_change (& mut self, modifiers : Modifiers)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_mouse_down", "name": "simulate_mouse_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a mouse down event to the given point", "documentation": "Simulate a mouse down event to the given point", "signature": "pub fn simulate_mouse_down (& mut self, position : Point, button : MouseButton, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_mouse_move", "name": "simulate_mouse_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a mouse move event to the given point", "documentation": "Simulate a mouse move event to the given point", "signature": "pub fn simulate_mouse_move (& mut self, position : Point, button : impl Into>, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_mouse_up", "name": "simulate_mouse_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulate a mouse up event to the given point", "documentation": "Simulate a mouse up event to the given point", "signature": "pub fn simulate_mouse_up (& mut self, position : Point, button : MouseButton, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::simulate_resize", "name": "simulate_resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Simulates the user resizing the window to the new size.", "documentation": "Simulates the user resizing the window to the new size.", "signature": "pub fn simulate_resize (& self, size : Size)", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Provides a `Window` and `App` for the duration of the closure.", "documentation": "Provides a `Window` and `App` for the duration of the closure.", "signature": "pub fn update (& mut self, f : impl FnOnce (& mut Window, & mut App) -> R) -> R", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::test_context::VisualTestContext::window_title", "name": "window_title", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::test_context", "path": "gpui::app::test_context", "source": "crates/gpui/src/app/test_context.rs", "summary": "Read the title off the window (set by `Window#set_window_title`)", "documentation": "Read the title off the window (set by `Window#set_window_title`)", "signature": "pub fn window_title (& mut self) -> Option", "cfg": [], "target": "VisualTestContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext", "name": "VisualTestAppContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "A test context that uses real macOS rendering instead of mocked rendering. This is used for visual tests that need to capture actual screenshots.", "documentation": "A test context that uses real macOS rendering instead of mocked rendering.\nThis is used for visual tests that need to capture actual screenshots.\n\nUnlike `TestAppContext` which uses `TestPlatform` with mocked rendering,\n`VisualTestAppContext` uses the real `MacPlatform` to produce actual rendered output.\n\nWindows created through this context are positioned off-screen (at coordinates like -10000, -10000)\nso they are invisible to the user but still fully rendered by the compositor.", "signature": "# [doc = \" A test context that uses real macOS rendering instead of mocked rendering.\"] # [doc = \" This is used for visual tests that need to capture actual screenshots.\"] # [doc = \"\"] # [doc = \" Unlike `TestAppContext` which uses `TestPlatform` with mocked rendering,\"] # [doc = \" `VisualTestAppContext` uses the real `MacPlatform` to produce actual rendered output.\"] # [doc = \"\"] # [doc = \" Windows created through this context are positioned off-screen (at coordinates like -10000, -10000)\"] # [doc = \" so they are invisible to the user but still fully rendered by the compositor.\"] # [derive (Clone)] pub struct VisualTestAppContext { # [doc = \" The underlying app cell\"] pub app : Rc, # [doc = \" The background executor for running async tasks\"] pub background_executor : BackgroundExecutor, # [doc = \" The foreground executor for running tasks on the main thread\"] pub foreground_executor : ForegroundExecutor, # [doc = \" The test dispatcher for deterministic task scheduling\"] dispatcher : TestDispatcher, platform : Rc, text_system : Arc, }", "cfg": [] }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::advance_clock", "name": "advance_clock", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Advances the simulated clock by the given duration and processes any tasks that become ready. This is essential for testing time-based behaviors like tooltip delays.", "documentation": "Advances the simulated clock by the given duration and processes any tasks\nthat become ready. This is essential for testing time-based behaviors like\ntooltip delays.", "signature": "pub fn advance_clock (& self, duration : Duration)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::capture_screenshot", "name": "capture_screenshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Captures a screenshot of the specified window using direct texture capture.", "documentation": "Captures a screenshot of the specified window using direct texture capture.\n\nThis renders the scene to a Metal texture and reads the pixels directly,\nwhich does not require the window to be visible on screen.", "signature": "pub fn capture_screenshot (& mut self, window : AnyWindowHandle) -> Result", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::dispatch_action", "name": "dispatch_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Dispatches an action to the given window.", "documentation": "Dispatches an action to the given window.", "signature": "pub fn dispatch_action (& mut self, window : AnyWindowHandle, action : impl Action)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::dispatch_keystroke", "name": "dispatch_keystroke", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Dispatches a single keystroke to a window.", "documentation": "Dispatches a single keystroke to a window.", "signature": "pub fn dispatch_keystroke (& mut self, window : AnyWindowHandle, keystroke : Keystroke)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::executor", "name": "executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Returns the background executor.", "documentation": "Returns the background executor.", "signature": "pub fn executor (& self) -> BackgroundExecutor", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Returns the foreground executor.", "documentation": "Returns the foreground executor.", "signature": "pub fn foreground_executor (& self) -> ForegroundExecutor", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::has_global", "name": "has_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Checks if a global of type G exists.", "documentation": "Checks if a global of type G exists.", "signature": "pub fn has_global (& self) -> bool", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::is_screen_capture_supported", "name": "is_screen_capture_supported", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Returns whether screen capture is supported on this platform.", "documentation": "Returns whether screen capture is supported on this platform.", "signature": "pub fn is_screen_capture_supported (& self) -> bool", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Creates a new `VisualTestAppContext` with real macOS platform rendering but deterministic task scheduling via TestDispatcher.", "documentation": "Creates a new `VisualTestAppContext` with real macOS platform rendering\nbut deterministic task scheduling via TestDispatcher.\n\nThis provides:\n- Real Metal/compositor rendering for accurate screenshots\n- Deterministic task scheduling via TestDispatcher\n- Controllable time via `advance_clock`\n\nNote: This uses a no-op asset source, so SVG icons won't render.\nUse `with_asset_source` to provide real assets for icon rendering.", "signature": "pub fn new (platform : Rc) -> Self", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::open_offscreen_window", "name": "open_offscreen_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Opens a window positioned off-screen for invisible rendering.", "documentation": "Opens a window positioned off-screen for invisible rendering.\n\nThe window is positioned at (-10000, -10000) so it's not visible on any display,\nbut it's still fully rendered by the compositor and can be captured via ScreenCaptureKit.\n\n# Arguments\n* `size` - The size of the window to create\n* `build_root` - A closure that builds the root view for the window", "signature": "pub fn open_offscreen_window (& mut self, size : Size, build_root : impl FnOnce (& mut Window, & mut App) -> Entity,) -> Result>", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::open_offscreen_window_default", "name": "open_offscreen_window_default", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Opens an off-screen window with default size (1280x800).", "documentation": "Opens an off-screen window with default size (1280x800).", "signature": "pub fn open_offscreen_window_default (& mut self, build_root : impl FnOnce (& mut Window, & mut App) -> Entity,) -> Result>", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Reads from the app state.", "documentation": "Reads from the app state.", "signature": "pub fn read (& self, f : impl FnOnce (& App) -> R) -> R", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::read_from_clipboard", "name": "read_from_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Reads from the clipboard.", "documentation": "Reads from the clipboard.", "signature": "pub fn read_from_clipboard (& self) -> Option", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::read_global", "name": "read_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Reads a global value.", "documentation": "Reads a global value.", "signature": "pub fn read_global (& self, f : impl FnOnce (& G, & App) -> R) -> R", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Runs all pending foreground and background tasks until there's nothing left to do. This is essential for processing async operations like tooltip timers.", "documentation": "Runs all pending foreground and background tasks until there's nothing left to do.\nThis is essential for processing async operations like tooltip timers.", "signature": "pub fn run_until_parked (& self)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::set_global", "name": "set_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Sets a global value.", "documentation": "Sets a global value.", "signature": "pub fn set_global (& mut self, global : G)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_click", "name": "simulate_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates a click (mouse down followed by mouse up).", "documentation": "Simulates a click (mouse down followed by mouse up).", "signature": "pub fn simulate_click (& mut self, window : AnyWindowHandle, position : Point, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_event", "name": "simulate_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates an input event on the given window.", "documentation": "Simulates an input event on the given window.", "signature": "pub fn simulate_event (& mut self, window : AnyWindowHandle, event : E)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_input", "name": "simulate_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates typing text input on the given window.", "documentation": "Simulates typing text input on the given window.", "signature": "pub fn simulate_input (& mut self, window : AnyWindowHandle, input : & str)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_keystrokes", "name": "simulate_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates a sequence of keystrokes on the given window.", "documentation": "Simulates a sequence of keystrokes on the given window.\n\nKeystrokes are specified as a space-separated string, e.g., \"cmd-p escape\".", "signature": "pub fn simulate_keystrokes (& mut self, window : AnyWindowHandle, keystrokes : & str)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_mouse_down", "name": "simulate_mouse_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates a mouse down event.", "documentation": "Simulates a mouse down event.", "signature": "pub fn simulate_mouse_down (& mut self, window : AnyWindowHandle, position : Point, button : MouseButton, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_mouse_move", "name": "simulate_mouse_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates a mouse move event.", "documentation": "Simulates a mouse move event.", "signature": "pub fn simulate_mouse_move (& mut self, window : AnyWindowHandle, position : Point, button : impl Into>, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::simulate_mouse_up", "name": "simulate_mouse_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Simulates a mouse up event.", "documentation": "Simulates a mouse up event.", "signature": "pub fn simulate_mouse_up (& mut self, window : AnyWindowHandle, position : Point, button : MouseButton, modifiers : Modifiers,)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Spawns a task on the foreground executor.", "documentation": "Spawns a task on the foreground executor.", "signature": "pub fn spawn (& self, f : F) -> Task where F : Future + 'static, R : 'static,", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Returns the text system used by this context.", "documentation": "Returns the text system used by this context.", "signature": "pub fn text_system (& self) -> & Arc", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Updates the app state.", "documentation": "Updates the app state.", "signature": "pub fn update (& mut self, f : impl FnOnce (& mut App) -> R) -> R", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::update_global", "name": "update_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Updates a global value.", "documentation": "Updates a global value.", "signature": "pub fn update_global (& mut self, f : impl FnOnce (& mut G, & mut App) -> R) -> R", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::update_window", "name": "update_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Updates a window.", "documentation": "Updates a window.", "signature": "pub fn update_window (& mut self, window : AnyWindowHandle, f : F) -> Result where F : FnOnce (AnyView, & mut Window, & mut App) -> T,", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::wait_for", "name": "wait_for", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Waits for a condition to become true, with a timeout.", "documentation": "Waits for a condition to become true, with a timeout.", "signature": "pub async fn wait_for (& mut self, entity : & Entity, predicate : impl Fn (& T) -> bool, timeout : Duration,) -> Result<()>", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::wait_for_animations", "name": "wait_for_animations", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Waits for animations to complete by waiting a couple of frames.", "documentation": "Waits for animations to complete by waiting a couple of frames.", "signature": "pub async fn wait_for_animations (& self)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::with_asset_source", "name": "with_asset_source", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Creates a new `VisualTestAppContext` with a custom asset source.", "documentation": "Creates a new `VisualTestAppContext` with a custom asset source.\n\nUse this when you need SVG icons to render properly in visual tests.\nPass the real `Assets` struct to enable icon rendering.", "signature": "pub fn with_asset_source (platform : Rc, asset_source : Arc,) -> Self", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::app::visual_test_context::VisualTestAppContext::write_to_clipboard", "name": "write_to_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "app::visual_test_context", "path": "gpui::app::visual_test_context", "source": "crates/gpui/src/app/visual_test_context.rs", "summary": "Writes to the clipboard.", "documentation": "Writes to the clipboard.", "signature": "pub fn write_to_clipboard (& self, item : ClipboardItem)", "cfg": [], "target": "VisualTestAppContext" }, { "id": "gpui::arena::Arena", "name": "Arena", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "", "documentation": "", "signature": "pub struct Arena { chunks : Vec, elements : Vec, valid : Rc>, current_chunk_index : usize, chunk_size : NonZeroUsize, scope_depth : usize, }", "cfg": [] }, { "id": "gpui::arena::Arena::alloc", "name": "alloc", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "", "documentation": "", "signature": "pub fn alloc (& mut self, f : impl FnOnce () -> T) -> ArenaBox", "cfg": [], "target": "Arena" }, { "id": "gpui::arena::Arena::begin_scope", "name": "begin_scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "Marks the start of a scope (e.g. a window draw) whose allocations must stay live until the scope ends, even if `clear` is called by a nested scope in the meantime.", "documentation": "Marks the start of a scope (e.g. a window draw) whose allocations must stay\nlive until the scope ends, even if `clear` is called by a nested scope in\nthe meantime.", "signature": "pub fn begin_scope (& mut self)", "cfg": [], "target": "Arena" }, { "id": "gpui::arena::Arena::capacity", "name": "capacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "", "documentation": "", "signature": "pub fn capacity (& self) -> usize", "cfg": [], "target": "Arena" }, { "id": "gpui::arena::Arena::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "Drops all allocations and resets the arena, unless a scope is still active.", "documentation": "Drops all allocations and resets the arena, unless a scope is still active.\n\nWhen a draw triggers a nested draw (e.g. re-entrant window procedure\ninvocations on Windows, or opening a window from within a draw), the nested\ndraw's clear must not free memory the outer draw still references, so it is\ndeferred: the outer draw's own clear will drop both draws' allocations.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "Arena" }, { "id": "gpui::arena::Arena::end_scope", "name": "end_scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "Ends the innermost scope started with `begin_scope`.", "documentation": "Ends the innermost scope started with `begin_scope`.\n\nPanics if no scope is active: an unbalanced `end_scope` would let `clear`\nrun while an enclosing scope still references arena memory, which is\nexactly the use-after-free this bookkeeping exists to prevent, so failing\nloudly here is preferable.", "signature": "pub fn end_scope (& mut self)", "cfg": [], "target": "Arena" }, { "id": "gpui::arena::Arena::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "", "documentation": "", "signature": "pub fn new (chunk_size : usize) -> Self", "cfg": [], "target": "Arena" }, { "id": "gpui::arena::ArenaBox", "name": "ArenaBox", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "", "documentation": "", "signature": "pub struct ArenaBox { ptr : * mut T, valid : Rc>, }", "cfg": [] }, { "id": "gpui::arena::ArenaBox::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "arena", "path": "gpui::arena", "source": "crates/gpui/src/arena.rs", "summary": "", "documentation": "", "signature": "pub fn map (mut self, f : impl FnOnce (& mut T) -> & mut U) -> ArenaBox", "cfg": [], "target": "ArenaBox" }, { "id": "gpui::asset_cache::Asset", "name": "Asset", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "asset_cache", "path": "gpui::asset_cache", "source": "crates/gpui/src/asset_cache.rs", "summary": "A trait for asynchronous asset loading.", "documentation": "A trait for asynchronous asset loading.", "signature": "# [doc = \" A trait for asynchronous asset loading.\"] pub trait Asset : 'static { # [doc = \" The source of the asset.\"] type Source : Clone + Hash + Send; # [doc = \" The loaded asset\"] type Output : Clone + Send; # [doc = \" Load the asset asynchronously\"] fn load (source : Self::Source, cx : & mut App,) -> impl Future + Send + 'static; }", "cfg": [] }, { "id": "gpui::asset_cache::AssetLogger", "name": "AssetLogger", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "asset_cache", "path": "gpui::asset_cache", "source": "crates/gpui/src/asset_cache.rs", "summary": "An asset Loader which logs the [`Err`] variant of a [`Result`] during loading", "documentation": "An asset Loader which logs the [`Err`] variant of a [`Result`] during loading", "signature": "# [doc = \" An asset Loader which logs the [`Err`] variant of a [`Result`] during loading\"] pub enum AssetLogger { # [doc (hidden)] _Phantom (PhantomData, & 'static dyn crate::seal::Sealed), }", "cfg": [] }, { "id": "gpui::asset_cache::Resource", "name": "Resource", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "asset_cache", "path": "gpui::asset_cache", "source": "crates/gpui/src/asset_cache.rs", "summary": "An enum representing", "documentation": "An enum representing", "signature": "# [doc = \" An enum representing\"] # [derive (Debug, PartialEq, Eq, Hash, Clone)] pub enum Resource { # [doc = \" This resource is at a given URI\"] Uri (SharedUri), # [doc = \" This resource is at a given path in the file system\"] Path (Arc), # [doc = \" This resource is embedded in the application binary\"] Embedded (SharedString), }", "cfg": [] }, { "id": "gpui::asset_cache::hash", "name": "hash", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "asset_cache", "path": "gpui::asset_cache", "source": "crates/gpui/src/asset_cache.rs", "summary": "Use a quick, non-cryptographically secure hash function to get an identifier from data", "documentation": "Use a quick, non-cryptographically secure hash function to get an identifier from data", "signature": "pub fn hash (data : & T) -> u64", "cfg": [] }, { "id": "gpui::assets::AssetSource", "name": "AssetSource", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "A source of assets for this app to use.", "documentation": "A source of assets for this app to use.", "signature": "# [doc = \" A source of assets for this app to use.\"] pub trait AssetSource : 'static + Send + Sync { # [doc = \" Load the given asset from the source path.\"] fn load (& self, path : & str) -> Result>>; # [doc = \" List the assets at the given path.\"] fn list (& self, path : & str) -> Result>; }", "cfg": [] }, { "id": "gpui::assets::ImageId", "name": "ImageId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "A unique identifier for the image cache", "documentation": "A unique identifier for the image cache", "signature": "# [doc = \" A unique identifier for the image cache\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)] pub struct ImageId (pub usize);", "cfg": [] }, { "id": "gpui::assets::RenderImage", "name": "RenderImage", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "A cached and processed image, in BGRA format", "documentation": "A cached and processed image, in BGRA format", "signature": "# [doc = \" A cached and processed image, in BGRA format\"] pub struct RenderImage { # [doc = \" The ID associated with this image\"] pub id : ImageId, # [doc = \" The scale factor of this image on render.\"] pub (crate) scale_factor : f32, data : SmallVec<[Frame; 1]>, }", "cfg": [] }, { "id": "gpui::assets::RenderImage::as_bytes", "name": "as_bytes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "Convert this image into a byte slice.", "documentation": "Convert this image into a byte slice.", "signature": "pub fn as_bytes (& self, frame_index : usize) -> Option<& [u8]>", "cfg": [], "target": "RenderImage" }, { "id": "gpui::assets::RenderImage::delay", "name": "delay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "Get the delay of this frame from the previous", "documentation": "Get the delay of this frame from the previous", "signature": "pub fn delay (& self, frame_index : usize) -> Delay", "cfg": [], "target": "RenderImage" }, { "id": "gpui::assets::RenderImage::frame_count", "name": "frame_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "Get the number of frames for this image.", "documentation": "Get the number of frames for this image.", "signature": "pub fn frame_count (& self) -> usize", "cfg": [], "target": "RenderImage" }, { "id": "gpui::assets::RenderImage::from_rgba", "name": "from_rgba", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "Creates a single-frame image from tightly packed RGBA8 pixels.", "documentation": "Creates a single-frame image from tightly packed RGBA8 pixels.\n\n`size` is measured in physical pixels. The byte length must be exactly\n`width × height × 4`; the channels are converted to the renderer's\ninternal BGRA layout so callers do not need to know the atlas format.", "signature": "pub fn from_rgba (size : Size, mut bytes : Vec) -> Result", "cfg": [], "target": "RenderImage" }, { "id": "gpui::assets::RenderImage::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "Create a new image from the given data.", "documentation": "Create a new image from the given data.", "signature": "pub fn new (data : impl Into>) -> Self", "cfg": [], "target": "RenderImage" }, { "id": "gpui::assets::RenderImage::size", "name": "size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "Get the size of this image, in pixels.", "documentation": "Get the size of this image, in pixels.", "signature": "pub fn size (& self, frame_index : usize) -> Size", "cfg": [], "target": "RenderImage" }, { "id": "gpui::assets::RenderImageParams", "name": "RenderImageParams", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "assets", "path": "gpui::assets", "source": "crates/gpui/src/assets.rs", "summary": "", "documentation": "", "signature": "# [derive (PartialEq, Eq, Hash, Clone)] # [expect (missing_docs)] pub struct RenderImageParams { pub image_id : ImageId, pub frame_index : usize, }", "cfg": [] }, { "id": "gpui::atlas_lease::AtlasLease", "name": "AtlasLease", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Keeps atlas allocations alive. A reset invalidates the lease permanently. Clones share ownership; the final drop releases only the leased allocations. Native leases are Send + Sync; Wasm leases retain thread-local GPU resources.", "documentation": "Keeps atlas allocations alive. A reset invalidates the lease permanently.\nClones share ownership; the final drop releases only the leased allocations.\nNative leases are Send + Sync; Wasm leases retain thread-local GPU resources.", "signature": "# [doc = \" Keeps atlas allocations alive. A reset invalidates the lease permanently.\"] # [doc = \" Clones share ownership; the final drop releases only the leased allocations.\"] # [doc = \" Native leases are Send + Sync; Wasm leases retain thread-local GPU resources.\"] # [derive (Clone)] pub struct AtlasLease (Arc);", "cfg": [] }, { "id": "gpui::atlas_lease::AtlasLease::is_valid", "name": "is_valid", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "False after renderer resource reset, even if tile coordinates were reused.", "documentation": "False after renderer resource reset, even if tile coordinates were reused.", "signature": "pub fn is_valid (& self) -> bool", "cfg": [], "target": "AtlasLease" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry", "name": "AtlasLeaseRegistry", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Internal renderer bookkeeping. Call under the atlas allocation lock.", "documentation": "Internal renderer bookkeeping. Call under the atlas allocation lock.", "signature": "# [doc = \" Internal renderer bookkeeping. Call under the atlas allocation lock.\"] # [doc (hidden)] pub struct AtlasLeaseRegistry { epoch : u64, revision : u64, valid : Arc, pins : HashMap, tiles : HashMap<(AtlasTextureId, u32), (AtlasTile, AtlasKey)>, # [cfg (test)] tile_lookups : usize, }", "cfg": [] }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::defer_remove", "name": "defer_remove", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Returns true when eviction must wait for the final lease release.", "documentation": "Returns true when eviction must wait for the final lease release.", "signature": "pub fn defer_remove (& mut self, key : & AtlasKey) -> bool", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::insert_tile", "name": "insert_tile", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Register an allocation under the same lock as the atlas key map.", "documentation": "Register an allocation under the same lock as the atlas key map.", "signature": "pub fn insert_tile (& mut self, key : AtlasKey, tile : AtlasTile)", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::invalidate", "name": "invalidate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Must precede recycling resources on device loss or atlas clear.", "documentation": "Must precede recycling resources on device loss or atlas clear.", "signature": "pub fn invalidate (& mut self)", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::pin", "name": "pin", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "The caller must first verify every key still names its requested tile.", "documentation": "The caller must first verify every key still names its requested tile.", "signature": "pub fn pin (& mut self, keys : Vec, release : impl FnOnce (u64, Vec) + AtlasLeaseThreadBound + 'static,) -> AtlasLease", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::pin_tiles", "name": "pin_tiles", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Retain tiles with one expected-constant-time lookup per reference, independent of unrelated atlas population. Complete identity is checked.", "documentation": "Retain tiles with one expected-constant-time lookup per reference,\nindependent of unrelated atlas population. Complete identity is checked.", "signature": "pub fn pin_tiles (& mut self, tiles : & [AtlasTile], release : impl FnOnce (u64, Vec) + AtlasLeaseThreadBound + 'static,) -> Option", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::release", "name": "release", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Returns deferred keys to remove while still holding the allocation lock, so reset/reallocation cannot occur between release and removal.", "documentation": "Returns deferred keys to remove while still holding the allocation lock,\nso reset/reallocation cannot occur between release and removal.", "signature": "pub fn release (& mut self, epoch : u64, keys : Vec) -> Vec", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::remove_tile", "name": "remove_tile", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Forget an allocation only when its actual eviction occurs.", "documentation": "Forget an allocation only when its actual eviction occurs.", "signature": "pub fn remove_tile (& mut self, tile : AtlasTile)", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseRegistry::revision", "name": "revision", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "source": "crates/gpui/src/atlas_lease.rs", "summary": "Changes before any unleased coordinates can be recycled. Paint marks use this to detect eviction/reset during the live capture interval.", "documentation": "Changes before any unleased coordinates can be recycled. Paint marks\nuse this to detect eviction/reset during the live capture interval.", "signature": "pub fn revision (& self) -> u64", "cfg": [], "target": "AtlasLeaseRegistry" }, { "id": "gpui::atlas_lease::AtlasLeaseThreadBound", "name": "AtlasLeaseThreadBound", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "atlas_lease", "path": "gpui::atlas_lease", "summary": "Native submission callbacks may release resources on another thread. Wasm GPU resources are thread-confined, so their leases must remain local too.", "declarations": [ { "source": "crates/gpui/src/atlas_lease.rs", "documentation": "Native submission callbacks may release resources on another thread. Wasm\nGPU resources are thread-confined, so their leases must remain local too.", "signature": "# [doc = \" Native submission callbacks may release resources on another thread. Wasm\"] # [doc = \" GPU resources are thread-confined, so their leases must remain local too.\"] # [doc (hidden)] # [cfg (not (target_family = \"wasm\"))] pub trait AtlasLeaseThreadBound : Send + Sync { }", "cfg": [ "cfg (not (target_family = \"wasm\"))" ] }, { "source": "crates/gpui/src/atlas_lease.rs", "documentation": "Wasm counterpart of the native submission callback bound.", "signature": "# [doc = \" Wasm counterpart of the native submission callback bound.\"] # [doc (hidden)] # [cfg (target_family = \"wasm\")] pub trait AtlasLeaseThreadBound { }", "cfg": [ "cfg (target_family = \"wasm\")" ] } ] }, { "id": "gpui::bounds_tree::BoundsTree::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "bounds_tree", "path": "gpui::bounds_tree", "source": "crates/gpui/src/bounds_tree.rs", "summary": "Clears all nodes from the tree.", "documentation": "Clears all nodes from the tree.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "BoundsTree" }, { "id": "gpui::bounds_tree::BoundsTree::insert", "name": "insert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "bounds_tree", "path": "gpui::bounds_tree", "source": "crates/gpui/src/bounds_tree.rs", "summary": "Inserts bounds into the tree and returns its assigned ordering.", "documentation": "Inserts bounds into the tree and returns its assigned ordering.\n\nThe ordering is one greater than the maximum ordering of any\nexisting bounds that intersect with the new bounds.", "signature": "pub fn insert (& mut self, new_bounds : Bounds) -> u32", "cfg": [], "target": "BoundsTree" }, { "id": "gpui::color::Background", "name": "Background", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "A renderer-backed solid, gradient, or pattern background.", "documentation": "A renderer-backed solid, gradient, or pattern background.", "signature": "# [doc = \" A renderer-backed solid, gradient, or pattern background.\"] # [derive (Clone, Copy, PartialEq, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub struct Background { pub (crate) tag : BackgroundTag, pub (crate) color_space : ColorSpace, pub (crate) solid : Hsla, pub (crate) gradient_angle_or_pattern_height : f32, pub (crate) gradient_center : Point, pub (crate) gradient_radius : Point, pub (crate) colors : [LinearColorStop; MAX_GRADIENT_STOPS], pub (crate) color_stop_count : u32, }", "cfg": [] }, { "id": "gpui::color::Background::as_solid", "name": "as_solid", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns the solid color if this is a solid background, None otherwise.", "documentation": "Returns the solid color if this is a solid background, None otherwise.", "signature": "pub fn as_solid (& self) -> Option", "cfg": [], "target": "Background" }, { "id": "gpui::color::Background::color_space", "name": "color_space", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Use specified color space for color interpolation.", "documentation": "Use specified color space for color interpolation.\n\n", "signature": "pub fn color_space (mut self, color_space : ColorSpace) -> Self", "cfg": [], "target": "Background" }, { "id": "gpui::color::Background::is_transparent", "name": "is_transparent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns whether the background color is transparent.", "documentation": "Returns whether the background color is transparent.", "signature": "pub fn is_transparent (& self) -> bool", "cfg": [], "target": "Background" }, { "id": "gpui::color::Background::opacity", "name": "opacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns a new background color with the same hue, saturation, and lightness, but with a modified alpha value.", "documentation": "Returns a new background color with the same hue, saturation, and lightness, but with a modified alpha value.", "signature": "pub fn opacity (& self, factor : f32) -> Self", "cfg": [], "target": "Background" }, { "id": "gpui::color::ColorSpace", "name": "ColorSpace", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "A color space for color interpolation.", "documentation": "A color space for color interpolation.\n\nReferences:\n- \n- ", "signature": "# [doc = \" A color space for color interpolation.\"] # [doc = \"\"] # [doc = \" References:\"] # [doc = \" - \"] # [doc = \" - \"] # [derive (Debug, Clone, Copy, PartialEq, Default, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub enum ColorSpace { # [default] # [doc = \" The sRGB color space.\"] Srgb = 0, # [doc = \" The Oklab color space.\"] Oklab = 1, }", "cfg": [] }, { "id": "gpui::color::Hsla", "name": "Hsla", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "An HSLA color", "documentation": "An HSLA color", "signature": "# [doc = \" An HSLA color\"] # [derive (Default, Copy, Clone, Debug)] # [repr (C)] pub struct Hsla { # [doc = \" Hue, in a range from 0 to 1\"] pub h : f32, # [doc = \" Saturation, in a range from 0 to 1\"] pub s : f32, # [doc = \" Lightness, in a range from 0 to 1\"] pub l : f32, # [doc = \" Alpha, in a range from 0 to 1\"] pub a : f32, }", "cfg": [] }, { "id": "gpui::color::Hsla::alpha", "name": "alpha", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns a new HSLA color with the same hue, saturation, and lightness, but with a new alpha value.", "documentation": "Returns a new HSLA color with the same hue, saturation,\nand lightness, but with a new alpha value.\n\nExample:\n```\nlet color = gpui::red();\nlet red_color = color.alpha(0.25);\nassert_eq!(red_color.a, 0.25);\n```\n\nThis will return a red color with 25% opacity.\n\nExample:\n```\nuse gpui::hsla;\nlet color = hsla(0.7, 1.0, 0.5, 0.7); // A saturated blue\nlet faded_color = color.alpha(0.25);\nassert_eq!(faded_color.a, 0.25);\n```\n\nThis will return a blue color with 25% opacity.", "signature": "pub fn alpha (& self, a : f32) -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::black", "name": "black", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color black", "documentation": "The color black", "signature": "pub const fn black () -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::blend", "name": "blend", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Blends `other` on top of `self` based on `other`'s alpha value. The resulting color is a combination of `self`'s and `other`'s colors.", "documentation": "Blends `other` on top of `self` based on `other`'s alpha value. The resulting color is a combination of `self`'s and `other`'s colors.\n\nIf `other`'s alpha value is 1.0 or greater, `other` color is fully opaque, thus `other` is returned as the output color.\nIf `other`'s alpha value is 0.0 or less, `other` color is fully transparent, thus `self` is returned as the output color.\nElse, the output color is calculated as a blend of `self` and `other` based on their weighted alpha values.\n\nAssumptions:\n- Alpha values are contained in the range [0, 1], with 1 as fully opaque and 0 as fully transparent.\n- The relative contributions of `self` and `other` is based on `self`'s alpha value (`self.a`) and `other`'s alpha value (`other.a`), `self` contributing `self.a * (1.0 - other.a)` and `other` contributing its own alpha value.\n- RGB color components are contained in the range [0, 1].\n- If `self` and `other` colors are out of the valid range, the blend operation's output and behavior is undefined.", "signature": "pub fn blend (self, other : Hsla) -> Hsla", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::blue", "name": "blue", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color blue", "documentation": "The color blue", "signature": "pub const fn blue () -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::fade_out", "name": "fade_out", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Fade out the color by a given factor. This factor should be between 0.0 and 1.0. Where 0.0 will leave the color unchanged, and 1.0 will completely fade out the color.", "documentation": "Fade out the color by a given factor. This factor should be between 0.0 and 1.0.\nWhere 0.0 will leave the color unchanged, and 1.0 will completely fade out the color.", "signature": "pub fn fade_out (& mut self, factor : f32)", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::grayscale", "name": "grayscale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns a new HSLA color with the same hue, and lightness, but with no saturation.", "documentation": "Returns a new HSLA color with the same hue, and lightness, but with no saturation.", "signature": "pub fn grayscale (& self) -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::green", "name": "green", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color green", "documentation": "The color green", "signature": "pub const fn green () -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::is_opaque", "name": "is_opaque", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns true if the HSLA color is fully opaque, false otherwise.", "documentation": "Returns true if the HSLA color is fully opaque, false otherwise.", "signature": "pub fn is_opaque (& self) -> bool", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::is_transparent", "name": "is_transparent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns true if the HSLA color is fully transparent, false otherwise.", "documentation": "Returns true if the HSLA color is fully transparent, false otherwise.", "signature": "pub fn is_transparent (& self) -> bool", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::opacity", "name": "opacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Multiplies the alpha value of the color by a given factor and returns a new HSLA color.", "documentation": "Multiplies the alpha value of the color by a given factor\nand returns a new HSLA color.\n\nUseful for transforming colors with dynamic opacity,\nlike a color from an external source.\n\nExample:\n```\nlet color = gpui::red();\nlet faded_color = color.opacity(0.5);\nassert_eq!(faded_color.a, 0.5);\n```\n\nThis will return a red color with half the opacity.\n\nExample:\n```\nuse gpui::hsla;\nlet color = hsla(0.7, 1.0, 0.5, 0.7); // A saturated blue\nlet faded_color = color.opacity(0.16);\nassert!((faded_color.a - 0.112).abs() < 1e-6);\n```\n\nThis will return a blue color with around ~10% opacity,\nsuitable for an element's hover or selected state.\n", "signature": "pub fn opacity (& self, factor : f32) -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::red", "name": "red", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color red", "documentation": "The color red", "signature": "pub const fn red () -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::to_rgb", "name": "to_rgb", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Converts this HSLA color to an RGBA color.", "documentation": "Converts this HSLA color to an RGBA color.", "signature": "pub fn to_rgb (self) -> Rgba", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::transparent_black", "name": "transparent_black", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color transparent black", "documentation": "The color transparent black", "signature": "pub const fn transparent_black () -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::Hsla::white", "name": "white", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color white", "documentation": "The color white", "signature": "pub const fn white () -> Self", "cfg": [], "target": "Hsla" }, { "id": "gpui::color::LinearColorStop", "name": "LinearColorStop", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "A color stop in a linear gradient.", "documentation": "A color stop in a linear gradient.\n\n", "signature": "# [doc = \" A color stop in a linear gradient.\"] # [doc = \"\"] # [doc = \" \"] # [derive (Debug, Clone, Copy, Default, PartialEq, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub struct LinearColorStop { # [doc = \" The color of the color stop.\"] pub color : Hsla, # [doc = \" The percentage of the gradient, in the range 0.0 to 1.0.\"] pub percentage : f32, }", "cfg": [] }, { "id": "gpui::color::LinearColorStop::opacity", "name": "opacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns a new color stop with the same color, but with a modified alpha value.", "documentation": "Returns a new color stop with the same color, but with a modified alpha value.", "signature": "pub fn opacity (& self, factor : f32) -> Self", "cfg": [], "target": "LinearColorStop" }, { "id": "gpui::color::MAX_GRADIENT_STOPS", "name": "MAX_GRADIENT_STOPS", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The number of stops one renderer-backed gradient can carry.", "documentation": "The number of stops one renderer-backed gradient can carry.\n\nStops are stored inline with scene primitives so quads and paths use the\nsame representation on Metal, Direct3D, and WGPU. Eight covers ordinary\nUI washes, charts, heat scales, and shimmer signatures without introducing\na renderer-specific side buffer.", "signature": "pub const MAX_GRADIENT_STOPS: usize", "cfg": [] }, { "id": "gpui::color::MAX_LINEAR_GRADIENT_STOPS", "name": "MAX_LINEAR_GRADIENT_STOPS", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Compatibility name for the renderer-backed gradient stop capacity.", "documentation": "Compatibility name for the renderer-backed gradient stop capacity.", "signature": "pub const MAX_LINEAR_GRADIENT_STOPS: usize", "cfg": [] }, { "id": "gpui::color::Rgba", "name": "Rgba", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "An RGBA color", "documentation": "An RGBA color", "signature": "# [doc = \" An RGBA color\"] # [derive (PartialEq, Clone, Copy, Default)] # [repr (C)] pub struct Rgba { # [doc = \" The red component of the color, in the range 0.0 to 1.0\"] pub r : f32, # [doc = \" The green component of the color, in the range 0.0 to 1.0\"] pub g : f32, # [doc = \" The blue component of the color, in the range 0.0 to 1.0\"] pub b : f32, # [doc = \" The alpha component of the color, in the range 0.0 to 1.0\"] pub a : f32, }", "cfg": [] }, { "id": "gpui::color::Rgba::alpha", "name": "alpha", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns a new RGBA color with the same red, green and blue channels, but with a new alpha value.", "documentation": "Returns a new RGBA color with the same red, green and blue channels, but\nwith a new alpha value.\n\nExample:\n```\nuse gpui::rgba;\nlet color = rgba(0xFF0000FF);\nlet faded = color.alpha(0.25);\nassert_eq!(faded.a, 0.25);\n```\n\nThis will return a red color with 25% opacity.\n\nExample:\n```\nuse gpui::rgba;\nlet color = rgba(0x3399FFCC);\nlet transparent = color.alpha(0.0);\nassert_eq!(transparent.a, 0.0);\n```\n\nThis will return the same blue color, fully transparent.", "signature": "pub fn alpha (& self, a : f32) -> Self", "cfg": [], "target": "Rgba" }, { "id": "gpui::color::Rgba::blend", "name": "blend", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Create a new [`Rgba`] color by blending this and another color together", "documentation": "Create a new [`Rgba`] color by blending this and another color together", "signature": "pub fn blend (& self, other : Rgba) -> Self", "cfg": [], "target": "Rgba" }, { "id": "gpui::color::Rgba::opacity", "name": "opacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Returns a new RGBA color with the same red, green, and blue channels, but with the alpha channel multiplied by the given factor.", "documentation": "Returns a new RGBA color with the same red, green, and blue channels,\nbut with the alpha channel multiplied by the given factor.\n\nExample:\n```\nuse gpui::rgba;\nlet color = rgba(0xFF0000FF); // Fully opaque red\nlet faded = color.opacity(0.5);\nassert_eq!(faded.a, 0.5);\n```\n\nThis will return a red color with 50% opacity.\n\nExample:\n```\nuse gpui::rgba;\nlet color = rgba(0x3399FFCC); // A light blue with 80% opacity\nlet faded = color.opacity(0.5);\nassert!((faded.a - 0.4).abs() < 1e-6);\n```\n\nThis will return the same blue color scaled down to 40% opacity.", "signature": "pub fn opacity (& self, factor : f32) -> Self", "cfg": [], "target": "Rgba" }, { "id": "gpui::color::black", "name": "black", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Pure black in [`Hsla`]", "documentation": "Pure black in [`Hsla`]", "signature": "pub const fn black () -> Hsla", "cfg": [] }, { "id": "gpui::color::blue", "name": "blue", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color blue in [`Hsla`]", "documentation": "The color blue in [`Hsla`]", "signature": "pub const fn blue () -> Hsla", "cfg": [] }, { "id": "gpui::color::checkerboard", "name": "checkerboard", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a checkerboard pattern background", "documentation": "Creates a checkerboard pattern background", "signature": "pub fn checkerboard (color : impl Into, size : f32) -> Background", "cfg": [] }, { "id": "gpui::color::conic_gradient", "name": "conic_gradient", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a conic gradient between two color stops.", "documentation": "Creates a conic gradient between two color stops.\n\n`start_angle` uses CSS gradient geometry: zero degrees starts at the top and\nincreasing values rotate clockwise. `center` is expressed as fractions of\nthe painted bounds and may lie outside them.", "signature": "pub fn conic_gradient (start_angle : f32, center : Point, from : impl Into, to : impl Into,) -> Background", "cfg": [] }, { "id": "gpui::color::conic_gradient_stops", "name": "conic_gradient_stops", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a conic gradient from two through eight color stops.", "documentation": "Creates a conic gradient from two through eight color stops.", "signature": "pub fn conic_gradient_stops (start_angle : f32, center : Point, stops : impl IntoIterator,) -> Background where S : Into,", "cfg": [] }, { "id": "gpui::color::green", "name": "green", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color green in [`Hsla`]", "documentation": "The color green in [`Hsla`]", "signature": "pub const fn green () -> Hsla", "cfg": [] }, { "id": "gpui::color::hsla", "name": "hsla", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Construct an [`Hsla`] object from plain values", "documentation": "Construct an [`Hsla`] object from plain values", "signature": "pub const fn hsla (h : f32, s : f32, l : f32, a : f32) -> Hsla", "cfg": [] }, { "id": "gpui::color::linear_color_stop", "name": "linear_color_stop", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a new linear color stop.", "documentation": "Creates a new linear color stop.\n\nThe percentage of the gradient, in the range 0.0 to 1.0.", "signature": "pub fn linear_color_stop (color : impl Into, percentage : f32) -> LinearColorStop", "cfg": [] }, { "id": "gpui::color::linear_gradient", "name": "linear_gradient", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a LinearGradient background color.", "documentation": "Creates a LinearGradient background color.\n\nThe gradient line's angle of direction. A value of `0.` is equivalent to top; increasing values rotate clockwise from there.\n\nThe `angle` is in degrees value in the range 0.0 to 360.0.\n\n", "signature": "pub fn linear_gradient (angle : f32, from : impl Into, to : impl Into,) -> Background", "cfg": [] }, { "id": "gpui::color::linear_gradient_stops", "name": "linear_gradient_stops", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a linear-gradient background from two through eight color stops.", "documentation": "Creates a linear-gradient background from two through eight color stops.\n\nStops must be finite, lie in `0.0..=1.0`, and appear in non-decreasing\norder. Equal percentages create a hard color transition. The bounded stop\ncount is part of the renderer primitive contract rather than a limitation\ncallers need to reproduce with adjacent elements.", "signature": "pub fn linear_gradient_stops (angle : f32, stops : impl IntoIterator) -> Background where S : Into,", "cfg": [] }, { "id": "gpui::color::opaque_grey", "name": "opaque_grey", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Opaque grey in [`Hsla`], values will be clamped to the range [0, 1]", "documentation": "Opaque grey in [`Hsla`], values will be clamped to the range [0, 1]", "signature": "pub const fn opaque_grey (lightness : f32, opacity : f32) -> Hsla", "cfg": [] }, { "id": "gpui::color::pattern_slash", "name": "pattern_slash", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a hash pattern background", "documentation": "Creates a hash pattern background", "signature": "pub fn pattern_slash (color : impl Into, width : f32, interval : f32) -> Background", "cfg": [] }, { "id": "gpui::color::radial_gradient", "name": "radial_gradient", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates an elliptical radial gradient between two color stops.", "documentation": "Creates an elliptical radial gradient between two color stops.\n\n`center` and `radius` are fractions of the painted bounds. A center of\n`(0.5, 0.5)` and radius of `(0.5, 0.5)` reaches the midpoint of every side;\nunequal radii produce an ellipse. Centers may lie outside the bounds, while\nboth radii must be finite and greater than zero.", "signature": "pub fn radial_gradient (center : Point, radius : Point, from : impl Into, to : impl Into,) -> Background", "cfg": [] }, { "id": "gpui::color::radial_gradient_stops", "name": "radial_gradient_stops", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates an elliptical radial gradient from two through eight color stops.", "documentation": "Creates an elliptical radial gradient from two through eight color stops.", "signature": "pub fn radial_gradient_stops (center : Point, radius : Point, stops : impl IntoIterator,) -> Background where S : Into,", "cfg": [] }, { "id": "gpui::color::red", "name": "red", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color red in [`Hsla`]", "documentation": "The color red in [`Hsla`]", "signature": "pub const fn red () -> Hsla", "cfg": [] }, { "id": "gpui::color::rgb", "name": "rgb", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Convert an RGB hex color code number to a color type", "documentation": "Convert an RGB hex color code number to a color type", "signature": "pub fn rgb (hex : u32) -> Rgba", "cfg": [] }, { "id": "gpui::color::rgba", "name": "rgba", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Convert an RGBA hex color code number to [`Rgba`]", "documentation": "Convert an RGBA hex color code number to [`Rgba`]", "signature": "pub fn rgba (hex : u32) -> Rgba", "cfg": [] }, { "id": "gpui::color::solid_background", "name": "solid_background", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Creates a solid background color.", "documentation": "Creates a solid background color.", "signature": "pub fn solid_background (color : impl Into) -> Background", "cfg": [] }, { "id": "gpui::color::swap_rgba_pa_to_bgra", "name": "swap_rgba_pa_to_bgra", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Swap from RGBA with premultiplied alpha to BGRA", "documentation": "Swap from RGBA with premultiplied alpha to BGRA", "signature": "pub fn swap_rgba_pa_to_bgra (color : & mut [u8])", "cfg": [] }, { "id": "gpui::color::transparent_black", "name": "transparent_black", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Transparent black in [`Hsla`]", "documentation": "Transparent black in [`Hsla`]", "signature": "pub const fn transparent_black () -> Hsla", "cfg": [] }, { "id": "gpui::color::transparent_white", "name": "transparent_white", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Transparent white in [`Hsla`]", "documentation": "Transparent white in [`Hsla`]", "signature": "pub const fn transparent_white () -> Hsla", "cfg": [] }, { "id": "gpui::color::white", "name": "white", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "Pure white in [`Hsla`]", "documentation": "Pure white in [`Hsla`]", "signature": "pub const fn white () -> Hsla", "cfg": [] }, { "id": "gpui::color::yellow", "name": "yellow", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "color", "path": "gpui::color", "source": "crates/gpui/src/color.rs", "summary": "The color yellow in [`Hsla`]", "documentation": "The color yellow in [`Hsla`]", "signature": "pub const fn yellow () -> Hsla", "cfg": [] }, { "id": "gpui::colors::Colors", "name": "Colors", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "The default set of colors for gpui.", "documentation": "The default set of colors for gpui.\n\nThese are used for styling base components, examples and more.", "signature": "# [doc = \" The default set of colors for gpui.\"] # [doc = \"\"] # [doc = \" These are used for styling base components, examples and more.\"] # [derive (Clone, Debug)] pub struct Colors { # [doc = \" Text color\"] pub text : Rgba, # [doc = \" Selected text color\"] pub selected_text : Rgba, # [doc = \" Background color\"] pub background : Rgba, # [doc = \" Disabled color\"] pub disabled : Rgba, # [doc = \" Selected color\"] pub selected : Rgba, # [doc = \" Border color\"] pub border : Rgba, # [doc = \" Separator color\"] pub separator : Rgba, # [doc = \" Container color\"] pub container : Rgba, }", "cfg": [] }, { "id": "gpui::colors::Colors::dark", "name": "dark", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "Returns the default dark colors.", "documentation": "Returns the default dark colors.", "signature": "pub fn dark () -> Self", "cfg": [], "target": "Colors" }, { "id": "gpui::colors::Colors::for_appearance", "name": "for_appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "Returns the default colors for the given window appearance.", "documentation": "Returns the default colors for the given window appearance.", "signature": "pub fn for_appearance (window : & Window) -> Self", "cfg": [], "target": "Colors" }, { "id": "gpui::colors::Colors::get_global", "name": "get_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "Get [Colors] from the global state", "documentation": "Get [Colors] from the global state", "signature": "pub fn get_global (cx : & App) -> & Arc", "cfg": [], "target": "Colors" }, { "id": "gpui::colors::Colors::light", "name": "light", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "Returns the default light colors.", "documentation": "Returns the default light colors.", "signature": "pub fn light () -> Self", "cfg": [], "target": "Colors" }, { "id": "gpui::colors::DefaultAppearance", "name": "DefaultAppearance", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "The appearance of the base GPUI colors, used to style GPUI elements", "documentation": "The appearance of the base GPUI colors, used to style GPUI elements\n\nVaries based on the system's current [`WindowAppearance`].", "signature": "# [doc = \" The appearance of the base GPUI colors, used to style GPUI elements\"] # [doc = \"\"] # [doc = \" Varies based on the system's current [`WindowAppearance`].\"] # [derive (Debug, Default, Clone, Copy, PartialEq, Eq)] pub enum DefaultAppearance { # [doc = \" Use the set of colors for light appearances.\"] # [default] Light, # [doc = \" Use the set of colors for dark appearances.\"] Dark, }", "cfg": [] }, { "id": "gpui::colors::DefaultColors", "name": "DefaultColors", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "Implement this trait to allow global [Colors] access via `cx.default_colors()`.", "documentation": "Implement this trait to allow global [Colors] access via `cx.default_colors()`.", "signature": "# [doc = \" Implement this trait to allow global [Colors] access via `cx.default_colors()`.\"] pub trait DefaultColors { # [doc = \" Returns the default [`Colors`]\"] fn default_colors (& self) -> & Arc; }", "cfg": [] }, { "id": "gpui::colors::GlobalColors", "name": "GlobalColors", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "colors", "path": "gpui::colors", "source": "crates/gpui/src/colors.rs", "summary": "Get [Colors] from the global state", "documentation": "Get [Colors] from the global state", "signature": "# [doc = \" Get [Colors] from the global state\"] # [derive (Clone, Debug)] pub struct GlobalColors (pub Arc);", "cfg": [] }, { "id": "gpui::editable_text::buffer::EditBuffer", "name": "EditBuffer", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "One control's editable value.", "documentation": "One control's editable value.", "signature": "# [doc = \" One control's editable value.\"] # [derive (Debug)] pub struct EditBuffer { text : EditSnapshot, # [doc = \" A caret is an empty selection, so one range describes both.\"] selection : Range, reversed : bool, # [doc = \" Primary anchor/head affinity, independent of normalized range order.\"] affinities : [TextAffinity; 2], secondary : Vec<(Range, bool)>, # [doc = \" The range an input method is composing, underlined and replaced whole\"] # [doc = \" as composition continues.\"] marked : Option>, history : EditHistory, rules : EditRules, }", "cfg": [] }, { "id": "gpui::editable_text::buffer::EditBuffer::can_redo", "name": "can_redo", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns whether an undone edit can be replayed.", "documentation": "Returns whether an undone edit can be replayed.", "signature": "pub fn can_redo (& self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::can_undo", "name": "can_undo", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns whether an edit can be undone.", "documentation": "Returns whether an edit can be undone.", "signature": "pub fn can_undo (& self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::cancel_composition", "name": "cancel_composition", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Rolls back only the active IME composition, restoring its original primary affinities and secondary selection set. Unlike undo, this is available for secret fields and retains no completed text history.", "documentation": "Rolls back only the active IME composition, restoring its original\nprimary affinities and secondary selection set. Unlike undo, this is\navailable for secret fields and retains no completed text history.", "signature": "pub fn cancel_composition (& mut self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::delete_ranges", "name": "delete_ranges", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Deletes primary-first ranges as one transaction, merging overlaps and clamping to graphemes. Undo restores the selections before expansion.", "documentation": "Deletes primary-first ranges as one transaction, merging overlaps and\nclamping to graphemes. Undo restores the selections before expansion.", "signature": "pub fn delete_ranges (& mut self, ranges : impl IntoIterator>) -> EditOutcome", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::delete_selections", "name": "delete_selections", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Deletes selections, extending empty carets by one grapheme. Overlapping deletion spans merge, so shared text is deleted only once. Undo restores the original primary-first selections, not the expanded deletion spans.", "documentation": "Deletes selections, extending empty carets by one grapheme. Overlapping\ndeletion spans merge, so shared text is deleted only once. Undo restores\nthe original primary-first selections, not the expanded deletion spans.", "signature": "pub fn delete_selections (& mut self, backward : bool) -> EditOutcome", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::end_composition", "name": "end_composition", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Closes a composition, recording the whole run as one step.", "documentation": "Closes a composition, recording the whole run as one step.", "signature": "pub fn end_composition (& mut self)", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::extend_selection", "name": "extend_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Moves the end that is moving, keeping the other one anchored.", "documentation": "Moves the end that is moving, keeping the other one anchored.", "signature": "pub fn extend_selection (& mut self, offset : usize)", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::forbid_history", "name": "forbid_history", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Stops recording, permanently.", "documentation": "Stops recording, permanently.\n\nA credential that could be undone back into view would outlive the\nmoment it was replaced, so a secret field never has a history rather\nthan having one it clears.", "signature": "pub fn forbid_history (& mut self)", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::has_multiple_selections", "name": "has_multiple_selections", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns whether secondary selections accompany the primary selection.", "documentation": "Returns whether secondary selections accompany the primary selection.", "signature": "pub fn has_multiple_selections (& self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns whether the current value is empty.", "documentation": "Returns whether the current value is empty.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::is_reversed", "name": "is_reversed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns whether the selection focus precedes its anchor.", "documentation": "Returns whether the selection focus precedes its anchor.", "signature": "pub fn is_reversed (& self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::marked", "name": "marked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns the UTF-8 range currently owned by an input composition.", "documentation": "Returns the UTF-8 range currently owned by an input composition.", "signature": "pub fn marked (& self) -> Option>", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::native_selection", "name": "native_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "The atomic UTF-16 primary selection, including both visual affinities. Secondary selections retain their existing logical-only policy.", "documentation": "The atomic UTF-16 primary selection, including both visual affinities.\nSecondary selections retain their existing logical-only policy.", "signature": "pub fn native_selection (& self) -> NativeTextSelection", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Creates an empty editable value governed by `rules`.", "documentation": "Creates an empty editable value governed by `rules`.", "signature": "pub fn new (rules : EditRules) -> Self", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::redo", "name": "redo", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Applies the last undone transaction forwards.", "documentation": "Applies the last undone transaction forwards.", "signature": "pub fn redo (& mut self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::replace", "name": "replace", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Replaces `range` with `text`, recording it as `cause` requires.", "documentation": "Replaces `range` with `text`, recording it as `cause` requires.\n\nThe insertion is normalised and trimmed to the control's rules first,\nso what is recorded is what was actually kept rather than what was\noffered.", "signature": "pub fn replace (& mut self, range : Range, text : & str, cause : EditCause) -> EditOutcome", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::replace_and_mark", "name": "replace_and_mark", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Replaces `range` with `text` and marks the result as composing.", "documentation": "Replaces `range` with `text` and marks the result as composing.\n\nThe composition is not a step of its own until it ends; see\n[`EditBuffer::end_composition`].", "signature": "pub fn replace_and_mark (& mut self, range : Range, text : & str, selection_in_insertion : Option>,) -> EditOutcome", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::replace_many", "name": "replace_many", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Applies original-document replacements as one undo transaction. Invalid grapheme boundaries, overlaps and duplicate insertions are refused before mutation. Each edit produces a caret; the first is primary.", "documentation": "Applies original-document replacements as one undo transaction. Invalid\ngrapheme boundaries, overlaps and duplicate insertions are refused\nbefore mutation. Each edit produces a caret; the first is primary.", "signature": "pub fn replace_many (& mut self, edits : impl IntoIterator, SharedString)>, cause : EditCause,) -> Option", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::replace_selections", "name": "replace_selections", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Replaces all selections atomically in original source coordinates. One call is one undo transaction; single-caret typing keeps its normal coalescing. Each insertion follows the control's ordinary edit rules.", "documentation": "Replaces all selections atomically in original source coordinates.\nOne call is one undo transaction; single-caret typing keeps its normal\ncoalescing. Each insertion follows the control's ordinary edit rules.", "signature": "pub fn replace_selections (& mut self, text : & str, cause : EditCause) -> EditOutcome", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::rules_mut", "name": "rules_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns the limits applied to subsequent replacements.", "documentation": "Returns the limits applied to subsequent replacements.", "signature": "pub fn rules_mut (& mut self) -> & mut EditRules", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::selection", "name": "selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns the current normalized UTF-8 selection range.", "documentation": "Returns the current normalized UTF-8 selection range.", "signature": "pub fn selection (& self) -> Range", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::selections", "name": "selections", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Selections in primary-first order. Secondary ranges do not overlap.", "documentation": "Selections in primary-first order. Secondary ranges do not overlap.", "signature": "pub fn selections (& self) -> Vec<(Range, bool)>", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::set_caret", "name": "set_caret", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Collapses the selection to the nearest valid offset at or before `offset`.", "documentation": "Collapses the selection to the nearest valid offset at or before `offset`.", "signature": "pub fn set_caret (& mut self, offset : usize)", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::set_marked", "name": "set_marked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Replaces the marked-composition range without changing text.", "documentation": "Replaces the marked-composition range without changing text.", "signature": "pub fn set_marked (& mut self, marked : Option>)", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::set_native_selection", "name": "set_native_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Validates both UTF-16 endpoints as complete grapheme boundaries before changing anything. Successful native selection clears secondary cursors, just like set_selection, but retains both primary endpoint affinities. This does not end an active composition or create an undo transaction.", "documentation": "Validates both UTF-16 endpoints as complete grapheme boundaries before\nchanging anything. Successful native selection clears secondary cursors,\njust like set_selection, but retains both primary endpoint affinities.\nThis does not end an active composition or create an undo transaction.", "signature": "pub fn set_native_selection (& mut self, selection : NativeTextSelection) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::set_selection", "name": "set_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Sets a normalized selection and which endpoint carries focus.", "documentation": "Sets a normalized selection and which endpoint carries focus.", "signature": "pub fn set_selection (& mut self, range : Range, reversed : bool)", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::set_selections", "name": "set_selections", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Sets primary-first selections, clamped to graphemes. Overlaps and duplicate carets merge, preserving primary direction. Empty input is refused.", "documentation": "Sets primary-first selections, clamped to graphemes. Overlaps and\nduplicate carets merge, preserving primary direction. Empty input is refused.", "signature": "pub fn set_selections (& mut self, selections : impl IntoIterator, bool)>,) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::set_text", "name": "set_text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Puts a value in place without it becoming a step the reader can walk back through, and forgets the steps that described the old one.", "documentation": "Puts a value in place without it becoming a step the reader can walk\nback through, and forgets the steps that described the old one.", "signature": "pub fn set_text (& mut self, text : & str) -> EditOutcome", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::snapshot", "name": "snapshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Shares the current document without copying its bytes. Indexed line and range access on this snapshot does not materialize a contiguous value.", "documentation": "Shares the current document without copying its bytes. Indexed line and\nrange access on this snapshot does not materialize a contiguous value.", "signature": "pub fn snapshot (& self) -> EditSnapshot", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Returns the current UTF-8 value.", "documentation": "Returns the current UTF-8 value.", "signature": "pub fn text (& self) -> & SharedString", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditBuffer::undo", "name": "undo", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "Applies the last transaction backwards. Returns whether anything moved. Native composition cancellation uses cancel_composition instead.", "documentation": "Applies the last transaction backwards. Returns whether anything moved.\nNative composition cancellation uses cancel_composition instead.", "signature": "pub fn undo (& mut self) -> bool", "cfg": [], "target": "EditBuffer" }, { "id": "gpui::editable_text::buffer::EditOutcome", "name": "EditOutcome", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "The result of an edit: what actually happened, for the caller to report.", "documentation": "The result of an edit: what actually happened, for the caller to report.", "signature": "# [doc = \" The result of an edit: what actually happened, for the caller to report.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub struct EditOutcome { # [doc = \" Whether the text is different from what it was.\"] pub changed : bool, }", "cfg": [] }, { "id": "gpui::editable_text::buffer::EditRules", "name": "EditRules", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::buffer", "path": "gpui::editable_text::buffer", "source": "crates/gpui/src/editable_text/buffer.rs", "summary": "What a particular control accepts.", "documentation": "What a particular control accepts.", "signature": "# [doc = \" What a particular control accepts.\"] # [derive (Clone, Copy, Debug, Default)] pub struct EditRules { # [doc = \" A byte limit, applied by trimming an over-long insertion rather than\"] # [doc = \" refusing it.\"] pub max_length : Option, # [doc = \" A limit in user-perceived characters, for a field whose slots are\"] # [doc = \" graphemes rather than bytes.\"] pub max_graphemes : Option, # [doc = \" True for a field that holds one line, where a newline arriving from a\"] # [doc = \" paste becomes a space rather than a second line nobody can see.\"] pub single_line : bool, }", "cfg": [] }, { "id": "gpui::editable_text::document::EditDifference", "name": "EditDifference", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "An exact scalar-aligned replacement between two persistent snapshots.", "documentation": "An exact scalar-aligned replacement between two persistent snapshots.", "signature": "# [doc = \" An exact scalar-aligned replacement between two persistent snapshots.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct EditDifference { # [doc = \" Bytes replaced in the preceding snapshot.\"] pub replaced : Range, # [doc = \" Only the replacement bytes are copied.\"] pub inserted : String, # [doc = \" Bytes actually compared when shared chunk identity did not suffice.\"] pub compared_bytes : usize, # [doc = \" Equal bytes skipped by live shared-chunk identity.\"] pub shared_bytes : usize, }", "cfg": [] }, { "id": "gpui::editable_text::document::EditSnapshot", "name": "EditSnapshot", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "An immutable, cheap-to-clone document revision with indexed hard lines.", "documentation": "An immutable, cheap-to-clone document revision with indexed hard lines.", "signature": "# [doc = \" An immutable, cheap-to-clone document revision with indexed hard lines.\"] # [derive (Clone, Default)] pub struct EditSnapshot { rope : Rope, contiguous : OnceLock, }", "cfg": [] }, { "id": "gpui::editable_text::document::EditSnapshot::byte_chunks", "name": "byte_chunks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Borrows byte chunks intersecting a range, clipped to document bounds. Chunks concatenate to that exact byte range without allocating or flattening. Byte boundaries need not be UTF-8 scalar boundaries, which lets incremental parsers request input at arbitrary decoder offsets.", "documentation": "Borrows byte chunks intersecting a range, clipped to document bounds.\nChunks concatenate to that exact byte range without allocating or\nflattening. Byte boundaries need not be UTF-8 scalar boundaries, which\nlets incremental parsers request input at arbitrary decoder offsets.", "signature": "pub fn byte_chunks (& self, range : Range) -> impl Iterator", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::difference_from", "name": "difference_from", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Computes one exact replacement without flattening either snapshot. Shared chunks skip byte comparisons. Separate equal documents still require linear comparison; widely separated edits include intervening unchanged text in this single replacement.", "documentation": "Computes one exact replacement without flattening either snapshot.\nShared chunks skip byte comparisons. Separate equal documents still\nrequire linear comparison; widely separated edits include intervening\nunchanged text in this single replacement.", "signature": "pub fn difference_from (& self, before : & Self) -> EditDifference", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Whether there are no bytes (an empty document still has one line).", "documentation": "Whether there are no bytes (an empty document still has one line).", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "UTF-8 byte length, without flattening the rope.", "documentation": "UTF-8 byte length, without flattening the rope.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::line_at", "name": "line_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Zero-based hard line containing the clamped byte offset.", "documentation": "Zero-based hard line containing the clamped byte offset.", "signature": "pub fn line_at (& self, offset : usize) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::line_count", "name": "line_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Number of LF-delimited lines, including an empty trailing line.", "documentation": "Number of LF-delimited lines, including an empty trailing line.", "signature": "pub fn line_count (& self) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::line_range", "name": "line_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Byte range of a zero-based hard line, including its LF if present.", "documentation": "Byte range of a zero-based hard line, including its LF if present.", "signature": "pub fn line_range (& self, line : usize) -> Option>", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::materialized_bytes", "name": "materialized_bytes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Bytes held by this snapshot's optional contiguous compatibility cache. Reading this counter never materializes text.", "documentation": "Bytes held by this snapshot's optional contiguous compatibility cache.\nReading this counter never materializes text.", "signature": "pub fn materialized_bytes (& self) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::next_grapheme_boundary", "name": "next_grapheme_boundary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Next extended-grapheme boundary, without materializing a hard line.", "documentation": "Next extended-grapheme boundary, without materializing a hard line.", "signature": "pub fn next_grapheme_boundary (& self, offset : usize) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::offset_from_utf16", "name": "offset_from_utf16", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Converts UTF-16 units to bytes. An offset inside a surrogate pair rounds upward to the end of that scalar, matching the existing API.", "documentation": "Converts UTF-16 units to bytes. An offset inside a surrogate pair\nrounds upward to the end of that scalar, matching the existing API.", "signature": "pub fn offset_from_utf16 (& self, offset : usize) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::offset_to_utf16", "name": "offset_to_utf16", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Converts a byte offset to UTF-16 units, rounding an interior scalar offset upward, as the platform editable-text API does.", "documentation": "Converts a byte offset to UTF-16 units, rounding an interior scalar\noffset upward, as the platform editable-text API does.", "signature": "pub fn offset_to_utf16 (& self, offset : usize) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::previous_grapheme_boundary", "name": "previous_grapheme_boundary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Previous extended-grapheme boundary, traversing borrowed rope chunks.", "documentation": "Previous extended-grapheme boundary, traversing borrowed rope chunks.", "signature": "pub fn previous_grapheme_boundary (& self, offset : usize) -> usize", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::shares_storage_with", "name": "shares_storage_with", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Constant-time identity check for unchanged persistent storage. Equal contents constructed independently need not share storage. This does not compare or materialize document bytes.", "documentation": "Constant-time identity check for unchanged persistent storage. Equal\ncontents constructed independently need not share storage. This does\nnot compare or materialize document bytes.", "signature": "pub fn shares_storage_with (& self, other : & Self) -> bool", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::slice", "name": "slice", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Copies only the requested range. Invalid UTF-8 boundaries return None.", "documentation": "Copies only the requested range. Invalid UTF-8 boundaries return None.", "signature": "pub fn slice (& self, range : Range) -> Option", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::document::EditSnapshot::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::document", "path": "gpui::editable_text::document", "source": "crates/gpui/src/editable_text/document.rs", "summary": "Compatibility snapshot. The first call in a revision copies all bytes; subsequent calls reuse that allocation. Prefer indexed slices for views.", "documentation": "Compatibility snapshot. The first call in a revision copies all bytes;\nsubsequent calls reuse that allocation. Prefer indexed slices for views.", "signature": "pub fn text (& self) -> & SharedString", "cfg": [], "target": "EditSnapshot" }, { "id": "gpui::editable_text::history::EditCause", "name": "EditCause", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "editable_text::history", "path": "gpui::editable_text::history", "source": "crates/gpui/src/editable_text/history.rs", "summary": "What the reader did, which decides whether an edit joins the step before it and whether it is remembered at all.", "documentation": "What the reader did, which decides whether an edit joins the step before\nit and whether it is remembered at all.", "signature": "# [doc = \" What the reader did, which decides whether an edit joins the step before\"] # [doc = \" it and whether it is remembered at all.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum EditCause { # [doc = \" Text the reader typed or an input method committed.\"] Typing, # [doc = \" A backspace or a delete.\"] Deleting, # [doc = \" One whole clipboard insertion, which is one step whatever its length.\"] Paste, # [doc = \" A cut, which is a deletion that also left with something.\"] Cut, # [doc = \" The value the host set. It is not the reader's edit, so it ends the\"] # [doc = \" history rather than joining it.\"] Programmatic, # [doc = \" Undo or redo replaying a transaction, which must never record one.\"] Replay, }", "cfg": [] }, { "id": "gpui::editable_text::layout::EditableTextLayout", "name": "EditableTextLayout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The shaped geometry of one editable UTF-8 document.", "documentation": "The shaped geometry of one editable UTF-8 document.", "signature": "# [doc = \" The shaped geometry of one editable UTF-8 document.\"] # [derive (Clone)] pub struct EditableTextLayout { lines : Arc<[Arc]>, # [doc = \" Where each hard line starts in the source text.\"] starts : Arc<[usize]>, # [doc = \" The first visual row of each hard line.\"] rows : Arc<[usize]>, total_rows : usize, text_len : usize, line_height : Pixels, source : Option>, paint_rows : Option>, work : Option, width : Pixels, }", "cfg": [] }, { "id": "gpui::editable_text::layout::EditableTextLayout::bounds_for_range", "name": "bounds_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Rectangles occupied by a logical source range, including offscreen rows.", "documentation": "Rectangles occupied by a logical source range, including offscreen rows.\n\nWrapped and bidirectional ranges may produce several rectangles. The\nreturned bounds are relative to `origin` and use the same alignment\nand width that the caller will pass to [`WrappedLine::paint`].", "signature": "pub fn bounds_for_range (& self, range : Range, origin : Point, align : TextAlign, align_width : Pixels,) -> Vec>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::caret_bounds", "name": "caret_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The caret rectangle for an offset, relative to `origin`.", "documentation": "The caret rectangle for an offset, relative to `origin`.", "signature": "pub fn caret_bounds (& self, offset : usize, origin : Point, width : Pixels,) -> Bounds", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::caret_bounds_aligned", "name": "caret_bounds_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The caret rectangle when every hard line uses the given alignment.", "documentation": "The caret rectangle when every hard line uses the given alignment.", "signature": "pub fn caret_bounds_aligned (& self, offset : usize, origin : Point, width : Pixels, align : TextAlign, align_width : Pixels,) -> Bounds", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::enclosing_bounds_for_range", "name": "enclosing_bounds_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The smallest rectangle containing a logical range.", "documentation": "The smallest rectangle containing a logical range.\n\nInput-method and native accessibility APIs often accept one rectangle\neven though wrapped or bidirectional text occupies several. Painting\nshould use [`Self::bounds_for_range`]; this method is the explicit\nlossy projection for those single-rectangle platform boundaries.", "signature": "pub fn enclosing_bounds_for_range (& self, range : Range, origin : Point, align : TextAlign, align_width : Pixels,) -> Bounds", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::height", "name": "height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The full shaped document height.", "documentation": "The full shaped document height.", "signature": "pub fn height (& self) -> Pixels", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::horizontal_scroll_offset_to_reveal", "name": "horizontal_scroll_offset_to_reveal", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "A horizontal scroll offset that reveals the caret while moving no more than necessary.", "documentation": "A horizontal scroll offset that reveals the caret while moving no\nmore than necessary.", "signature": "pub fn horizontal_scroll_offset_to_reveal (& self, offset : usize, viewport_width : Pixels, current : Pixels,) -> Pixels", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Returns whether this layout represents no source bytes.", "documentation": "Returns whether this layout represents no source bytes.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The UTF-8 byte length represented by this layout.", "documentation": "The UTF-8 byte length represented by this layout.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::line_height", "name": "line_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The line height used to shape and paint every visual row.", "documentation": "The line height used to shape and paint every visual row.", "signature": "pub fn line_height (& self) -> Pixels", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Builds document geometry from the shaped hard lines that will paint.", "documentation": "Builds document geometry from the shaped hard lines that will paint.", "signature": "pub fn new (text : & str, lines : Vec, line_height : Pixels) -> Self", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::offset_at_row", "name": "offset_at_row", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The offset at an x coordinate on one visual row.", "documentation": "The offset at an x coordinate on one visual row.", "signature": "pub fn offset_at_row (& self, row : usize, x : Pixels) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::offset_at_row_aligned", "name": "offset_at_row_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The offset at an x coordinate on one aligned visual row.", "documentation": "The offset at an x coordinate on one aligned visual row.", "signature": "pub fn offset_at_row_aligned (& self, row : usize, x : Pixels, align : TextAlign, align_width : Pixels,) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::offset_for_position", "name": "offset_for_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The UTF-8 offset nearest a point relative to the text origin.", "documentation": "The UTF-8 offset nearest a point relative to the text origin.", "signature": "pub fn offset_for_position (& self, position : Point) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::offset_for_position_aligned", "name": "offset_for_position_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The offset nearest a painted point when every hard line uses the same alignment and width.", "documentation": "The offset nearest a painted point when every hard line uses the same\nalignment and width.", "signature": "pub fn offset_for_position_aligned (& self, position : Point, align : TextAlign, align_width : Pixels,) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::painted_bounds_for_range", "name": "painted_bounds_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Selection rectangles limited to rows eligible to paint. Unlike ordinary range geometry, selecting the whole document never shapes hidden rows.", "documentation": "Selection rectangles limited to rows eligible to paint. Unlike ordinary\nrange geometry, selecting the whole document never shapes hidden rows.", "signature": "pub fn painted_bounds_for_range (& self, mut range : Range, origin : Point, align : TextAlign, align_width : Pixels,) -> Vec>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::painted_lines", "name": "painted_lines", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Where each hard line should be painted relative to the text origin.", "documentation": "Where each hard line should be painted relative to the text origin.", "signature": "pub fn painted_lines (& self) -> Box, Pixels)> + '_>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::painted_source_ranges", "name": "painted_source_ranges", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Source ranges eligible to paint in this layout. Accessibility geometry collectors can skip unpainted text without losing its logical content.", "documentation": "Source ranges eligible to paint in this layout. Accessibility geometry\ncollectors can skip unpainted text without losing its logical content.", "signature": "pub fn painted_source_ranges (& self) -> Vec>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::position_for_offset", "name": "position_for_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The top-left position of a UTF-8 byte offset relative to the text origin.", "documentation": "The top-left position of a UTF-8 byte offset relative to the text origin.", "signature": "pub fn position_for_offset (& self, offset : usize) -> Point", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::position_for_offset_aligned", "name": "position_for_offset_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The painted position of an offset when every hard line uses the same alignment and width.", "documentation": "The painted position of an offset when every hard line uses the same\nalignment and width.", "signature": "pub fn position_for_offset_aligned (& self, offset : usize, align : TextAlign, align_width : Pixels,) -> Point", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::row_for_offset", "name": "row_for_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The visual row containing a UTF-8 byte offset.", "documentation": "The visual row containing a UTF-8 byte offset.", "signature": "pub fn row_for_offset (& self, offset : usize) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::row_range", "name": "row_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The source byte range occupied by a visual row.", "documentation": "The source byte range occupied by a visual row.", "signature": "pub fn row_range (& self, row : usize) -> Range", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::scroll_offset_to_reveal", "name": "scroll_offset_to_reveal", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "A vertical scroll offset that reveals the caret while moving no more than necessary.", "documentation": "A vertical scroll offset that reveals the caret while moving no more\nthan necessary.", "signature": "pub fn scroll_offset_to_reveal (& self, offset : usize, viewport_height : Pixels, current : Pixels,) -> Pixels", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::set_painted_rows", "name": "set_painted_rows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Restricts painting and painted-range geometry to these visual rows. Logical geometry and native text remain complete. Rows are clamped to the exact index, so this can be applied after scrolling/caret reveal.", "documentation": "Restricts painting and painted-range geometry to these visual rows.\nLogical geometry and native text remain complete. Rows are clamped to\nthe exact index, so this can be applied after scrolling/caret reveal.", "signature": "pub fn set_painted_rows (& mut self, rows : Range)", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::shaping_work", "name": "shaping_work", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Shaping performed so far by this layout, including on-demand queries.", "documentation": "Shaping performed so far by this layout, including on-demand queries.", "signature": "pub fn shaping_work (& self) -> EditableTextWork", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::shares_row_index_with", "name": "shares_row_index_with", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Proves that two layouts share the same logical row index without enumerating source lines. False means unknown, not necessarily unequal. Viewport changes and line height do not change source row boundaries.", "documentation": "Proves that two layouts share the same logical row index without\nenumerating source lines. False means unknown, not necessarily unequal.\nViewport changes and line height do not change source row boundaries.", "signature": "pub fn shares_row_index_with (& self, other : & Self) -> bool", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::text_width", "name": "text_width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Width of the widest measured hard line. A lazy no-wrap document reports the maximum of visible and explicitly queried lines, not unseen lines.", "documentation": "Width of the widest measured hard line. A lazy no-wrap document reports\nthe maximum of visible and explicitly queried lines, not unseen lines.", "signature": "pub fn text_width (& self) -> Pixels", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::total_rows", "name": "total_rows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "The number of shaped visual rows, including an empty final row.", "documentation": "The number of shaped visual rows, including an empty final row.", "signature": "pub fn total_rows (& self) -> usize", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::unwrapped", "name": "unwrapped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "No-wrap document layout with indexed hard lines. Only `visible` rows paint; geometry queries shape other rows lazily through the same text system and style partition, so hit testing and IME never guess widths. `painted_bounds_for_range` limits selection painting to visible rows; ordinary geometry queries address every offset. Soft wrapping uses `new`.", "documentation": "No-wrap document layout with indexed hard lines. Only `visible` rows\npaint; geometry queries shape other rows lazily through the same text\nsystem and style partition, so hit testing and IME never guess widths.\n`painted_bounds_for_range` limits selection painting to visible rows;\nordinary geometry queries address every offset. Soft wrapping uses `new`.", "signature": "pub fn unwrapped (document : EditSnapshot, text_system : Arc, font_size : Pixels, line_height : Pixels, runs : Vec, visible : Range,) -> Self", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::unwrapped_projected", "name": "unwrapped_projected", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "No-wrap geometry with omitted complete source lines. `visible` indexes projected rows, not source lines. Painting, hit testing, selections and IME share this mapping; omitted positions map to the preceding displayed row's end, or the first row's start when no predecessor exists. Returns None for a projection of a different source line count.", "documentation": "No-wrap geometry with omitted complete source lines. `visible` indexes\nprojected rows, not source lines. Painting, hit testing, selections and\nIME share this mapping; omitted positions map to the preceding displayed\nrow's end, or the first row's start when no predecessor exists. Returns\nNone for a projection of a different source line count.", "signature": "pub fn unwrapped_projected (document : EditSnapshot, text_system : Arc, font_size : Pixels, line_height : Pixels, runs : Vec, visible : Range, projection : EditableLineProjection,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextLayout::visual_rows", "name": "visual_rows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Source byte ranges for every shaped visual row.", "documentation": "Source byte ranges for every shaped visual row.\n\nThe final row of a hard line owns its line break. GPUI shapes hard\nlines separately, but selection and accessibility must retain the\nbreak as one source character on the preceding row.", "signature": "pub fn visual_rows (& self, text : & str) -> Vec>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::EditableTextWork", "name": "EditableTextWork", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "Actual shaping input consumed by one layout, including on-demand geometry. Bytes count UTF-8 input, not allocation calls or a guessed glyph count.", "documentation": "Actual shaping input consumed by one layout, including on-demand geometry.\nBytes count UTF-8 input, not allocation calls or a guessed glyph count.", "signature": "# [doc = \" Actual shaping input consumed by one layout, including on-demand geometry.\"] # [doc = \" Bytes count UTF-8 input, not allocation calls or a guessed glyph count.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct EditableTextWork { # [doc = \" Number of hard lines actually passed to the shaper.\"] pub shaped_lines : usize, # [doc = \" Sum of UTF-8 bytes actually passed to the shaper.\"] pub shaped_bytes : usize, }", "cfg": [] }, { "id": "gpui::editable_text::layout::native::EditableTextLayout::native_base_writing_direction", "name": "native_base_writing_direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "Resolves the Unicode paragraph base direction. This is a query only: the editable model has no paragraph-direction override to mutate.", "documentation": "Resolves the Unicode paragraph base direction. This is a query only:\nthe editable model has no paragraph-direction override to mutate.", "signature": "pub fn native_base_writing_direction (& self, text : & str, position : usize,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::EditableTextLayout::native_caret_bounds", "name": "native_caret_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "Actual cluster-edge caret, using downstream logical affinity at bidi and soft-wrap boundaries. Returns None for an interior ligature stop absent from the shaping result, rather than interpolating its width.", "documentation": "Actual cluster-edge caret, using downstream logical affinity at bidi\nand soft-wrap boundaries. Returns None for an interior ligature stop\nabsent from the shaping result, rather than interpolating its width.", "signature": "pub fn native_caret_bounds (& self, text : & str, position : usize, origin : Point, width : Pixels, align : TextAlign, align_width : Pixels,) -> Option>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::EditableTextLayout::native_farthest_position", "name": "native_farthest_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "The visual extreme among available caret stops inside a UTF-8 range.", "documentation": "The visual extreme among available caret stops inside a UTF-8 range.", "signature": "pub fn native_farthest_position (& self, text : & str, range : Range, direction : TextNavigationDirection, align : TextAlign, align_width : Pixels,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::EditableTextLayout::native_selection_rects", "name": "native_selection_rects", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "Annotated visual fragments for UTF-8 offsets in the exact painted text. Fragments are ordered top-to-bottom, then left-to-right, and never merged across a direction boundary. Partial shaping clusters occupy their complete painted cell; no font ligature caret is fabricated.", "documentation": "Annotated visual fragments for UTF-8 offsets in the exact painted text.\nFragments are ordered top-to-bottom, then left-to-right, and never\nmerged across a direction boundary. Partial shaping clusters occupy\ntheir complete painted cell; no font ligature caret is fabricated.", "signature": "pub fn native_selection_rects (& self, text : & str, range : Range, origin : Point, align : TextAlign, align_width : Pixels,) -> Vec", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::EditableTextLayout::native_text_position", "name": "native_text_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "Moves between actual visual cluster-edge stops, never UTF-16 units. Vertical movement addresses the layout's row index and preserves x across the entire request. Out-of-document movement returns None. This layout paints uniform-height horizontal rows; it does not claim support for a different rich-text layout's variable-height rows.", "documentation": "Moves between actual visual cluster-edge stops, never UTF-16 units.\nVertical movement addresses the layout's row index and preserves x\nacross the entire request. Out-of-document movement returns None.\nThis layout paints uniform-height horizontal rows; it does not claim\nsupport for a different rich-text layout's variable-height rows.", "signature": "pub fn native_text_position (& self, text : & str, position : usize, direction : TextNavigationDirection, offset : usize, align : TextAlign, align_width : Pixels,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::TextNavigationDirection", "name": "TextNavigationDirection", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "A physical direction in the painted text coordinate system.", "documentation": "A physical direction in the painted text coordinate system.", "signature": "# [doc = \" A physical direction in the painted text coordinate system.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum TextNavigationDirection { # [doc = \" Toward decreasing x.\"] Left, # [doc = \" Toward increasing x.\"] Right, # [doc = \" Toward the preceding visual row.\"] Up, # [doc = \" Toward the following visual row.\"] Down, }", "cfg": [] }, { "id": "gpui::editable_text::layout::native::TextSelectionRect", "name": "TextSelectionRect", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "One visual selection fragment in the caller's logical coordinate system.", "documentation": "One visual selection fragment in the caller's logical coordinate system.", "signature": "# [doc = \" One visual selection fragment in the caller's logical coordinate system.\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct TextSelectionRect { # [doc = \" Painted fragment bounds, without viewport clipping.\"] pub bounds : Bounds, # [doc = \" Resolved direction of this fragment.\"] pub writing_direction : TextWritingDirection, # [doc = \" This fragment contains the logical start of the selection.\"] pub contains_start : bool, # [doc = \" This fragment contains the logical end of the selection.\"] pub contains_end : bool, # [doc = \" Whether the text is vertically oriented (not merely on another row).\"] pub is_vertical : bool, }", "cfg": [] }, { "id": "gpui::editable_text::layout::native::TextWritingDirection", "name": "TextWritingDirection", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native", "path": "gpui::editable_text::layout::native", "source": "crates/gpui/src/editable_text/layout/native.rs", "summary": "Resolved horizontal writing direction, not a request to mutate a paragraph.", "documentation": "Resolved horizontal writing direction, not a request to mutate a paragraph.", "signature": "# [doc = \" Resolved horizontal writing direction, not a request to mutate a paragraph.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum TextWritingDirection { # [doc = \" Logical text advances toward increasing x.\"] LeftToRight, # [doc = \" Logical text advances toward decreasing x.\"] RightToLeft, }", "cfg": [] }, { "id": "gpui::editable_text::layout::native::affinity::EditableTextLayout::farthest_native_position", "name": "farthest_native_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native::affinity", "path": "gpui::editable_text::layout::native::affinity", "source": "crates/gpui/src/editable_text/layout/native/affinity.rs", "summary": "The actual visual endpoint inside a UTF-16 range, including secondary bidi and wrap affinities omitted by the legacy offset-only projection.", "documentation": "The actual visual endpoint inside a UTF-16 range, including secondary\nbidi and wrap affinities omitted by the legacy offset-only projection.", "signature": "pub fn farthest_native_position (& self, text : & str, range : Range, direction : TextNavigationDirection, align : TextAlign, align_width : Pixels,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::affinity::EditableTextLayout::native_position_bounds", "name": "native_position_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native::affinity", "path": "gpui::editable_text::layout::native::affinity", "source": "crates/gpui/src/editable_text/layout/native/affinity.rs", "summary": "Resolves either incident caret at a UTF-16 native position. The text must be the exact painted value, including any masking transformation. At document endpoints the sole available edge serves both affinities. Missing intra-ligature carets remain explicitly unavailable. This paint hot path resolves only the incident hard paragraph. Lazy source layouts convert UTF-16 through their document index and never shape unrelated offscreen lines or segment the entire document.", "documentation": "Resolves either incident caret at a UTF-16 native position. The text\nmust be the exact painted value, including any masking transformation.\nAt document endpoints the sole available edge serves both affinities.\nMissing intra-ligature carets remain explicitly unavailable.\nThis paint hot path resolves only the incident hard paragraph. Lazy\nsource layouts convert UTF-16 through their document index and never\nshape unrelated offscreen lines or segment the entire document.", "signature": "pub fn native_position_bounds (& self, text : & str, position : NativeTextPosition, origin : Point, caret_width : Pixels, align : TextAlign, align_width : Pixels,) -> Option>", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::affinity::EditableTextLayout::native_position_for_point", "name": "native_position_for_point", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native::affinity", "path": "gpui::editable_text::layout::native::affinity", "source": "crates/gpui/src/editable_text/layout/native/affinity.rs", "summary": "Nearest actual caret to a point relative to the painted text origin. Optional bounds are UTF-16 offsets in the exact painted text. Candidates are restricted before hit testing; logical clamping after a bidi hit would choose an unrelated visual location. Rows take precedence over horizontal distance. Coincident bidi aliases use the incident cell under the pointer, then downstream affinity as the deterministic tie.", "documentation": "Nearest actual caret to a point relative to the painted text origin.\nOptional bounds are UTF-16 offsets in the exact painted text. Candidates\nare restricted before hit testing; logical clamping after a bidi hit\nwould choose an unrelated visual location. Rows take precedence over\nhorizontal distance. Coincident bidi aliases use the incident cell\nunder the pointer, then downstream affinity as the deterministic tie.", "signature": "pub fn native_position_for_point (& self, text : & str, position : Point, within_range : Option>, align : TextAlign, align_width : Pixels,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::native::affinity::EditableTextLayout::native_position_in_direction", "name": "native_position_in_direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::native::affinity", "path": "gpui::editable_text::layout::native::affinity", "source": "crates/gpui/src/editable_text/layout/native/affinity.rs", "summary": "Moves through physical caret edges while retaining bidi and soft-wrap affinity. Horizontal steps cross one distinct visual location; aliases at the same location do not consume a step. The arriving cluster's edge determines the result affinity, so opposite travel can select different logical aliases at a bidi boundary. Vertical steps preserve the initial x across exact visual rows. All native offsets are UTF-16, not bytes.", "documentation": "Moves through physical caret edges while retaining bidi and soft-wrap\naffinity. Horizontal steps cross one distinct visual location; aliases\nat the same location do not consume a step. The arriving cluster's edge\ndetermines the result affinity, so opposite travel can select different\nlogical aliases at a bidi boundary. Vertical steps preserve the initial\nx across exact visual rows. All native offsets are UTF-16, not bytes.", "signature": "pub fn native_position_in_direction (& self, text : & str, position : NativeTextPosition, direction : TextNavigationDirection, offset : usize, align : TextAlign, align_width : Pixels,) -> Option", "cfg": [], "target": "EditableTextLayout" }, { "id": "gpui::editable_text::layout::reexport-1", "name": "native :: { TextNavigationDirection , TextSelectionRect , TextWritingDirection }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "", "documentation": "", "signature": "pub use native::{ TextNavigationDirection, TextSelectionRect, TextWritingDirection };", "cfg": [] }, { "id": "gpui::editable_text::layout::reexport-2", "name": "wrapped :: EditableWrappedCache", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout", "path": "gpui::editable_text::layout", "source": "crates/gpui/src/editable_text/layout.rs", "summary": "", "documentation": "", "signature": "pub use wrapped::EditableWrappedCache;", "cfg": [] }, { "id": "gpui::editable_text::layout::wrapped::EditableWrappedCache", "name": "EditableWrappedCache", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::wrapped", "path": "gpui::editable_text::layout::wrapped", "source": "crates/gpui/src/editable_text/layout/wrapped.rs", "summary": "Retains exact hard-paragraph layouts for one editable surface. Initial layout and width/font changes shape every paragraph; later edits shape only changed paragraphs or changed style partitions. Static/scroll updates reuse the complete row index. A text edit still rebuilds line-index metadata, and a single exceptionally long paragraph is still one shaping input.", "documentation": "Retains exact hard-paragraph layouts for one editable surface. Initial\nlayout and width/font changes shape every paragraph; later edits shape only\nchanged paragraphs or changed style partitions. Static/scroll updates reuse\nthe complete row index. A text edit still rebuilds line-index metadata, and\na single exceptionally long paragraph is still one shaping input.", "signature": "# [doc = \" Retains exact hard-paragraph layouts for one editable surface. Initial\"] # [doc = \" layout and width/font changes shape every paragraph; later edits shape only\"] # [doc = \" changed paragraphs or changed style partitions. Static/scroll updates reuse\"] # [doc = \" the complete row index. A text edit still rebuilds line-index metadata, and\"] # [doc = \" a single exceptionally long paragraph is still one shaping input.\"] # [derive (Default)] pub struct EditableWrappedCache { state : Option, indexed_lines : usize, }", "cfg": [] }, { "id": "gpui::editable_text::layout::wrapped::EditableWrappedCache::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::wrapped", "path": "gpui::editable_text::layout::wrapped", "source": "crates/gpui/src/editable_text/layout/wrapped.rs", "summary": "Drops retained layouts, for example after the host changes available font faces without changing the requested font/style identities.", "documentation": "Drops retained layouts, for example after the host changes available\nfont faces without changing the requested font/style identities.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "EditableWrappedCache" }, { "id": "gpui::editable_text::layout::wrapped::EditableWrappedCache::indexed_lines", "name": "indexed_lines", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::wrapped", "path": "gpui::editable_text::layout::wrapped", "source": "crates/gpui/src/editable_text/layout/wrapped.rs", "summary": "Number of hard-line metadata entries built by the most recent update. Separate from `EditableTextLayout::shaping_work`: an edit may reuse almost every shaped paragraph while rebuilding the exact row index.", "documentation": "Number of hard-line metadata entries built by the most recent update.\nSeparate from `EditableTextLayout::shaping_work`: an edit may reuse\nalmost every shaped paragraph while rebuilding the exact row index.", "signature": "pub fn indexed_lines (& self) -> usize", "cfg": [], "target": "EditableWrappedCache" }, { "id": "gpui::editable_text::layout::wrapped::EditableWrappedCache::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::layout::wrapped", "path": "gpui::editable_text::layout::wrapped", "source": "crates/gpui/src/editable_text/layout/wrapped.rs", "summary": "Updates exact wrapping with the same text system and byte-style partition used to paint. Viewport restriction is applied afterward via `EditableTextLayout::set_painted_rows`, including after caret reveal.", "documentation": "Updates exact wrapping with the same text system and byte-style\npartition used to paint. Viewport restriction is applied afterward via\n`EditableTextLayout::set_painted_rows`, including after caret reveal.", "signature": "pub fn update (& mut self, document : EditSnapshot, text_system : Arc, font_size : Pixels, line_height : Pixels, runs : Vec, width : Pixels,) -> EditableTextLayout", "cfg": [], "target": "EditableWrappedCache" }, { "id": "gpui::editable_text::native_position::NativeTextPosition", "name": "NativeTextPosition", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::native_position", "path": "gpui::editable_text::native_position", "source": "crates/gpui/src/editable_text/native_position.rs", "summary": "A UTF-16 position and its visual affinity. Offsets alone do not identify a unique painted caret at bidi and soft-wrap boundaries.", "documentation": "A UTF-16 position and its visual affinity. Offsets alone do not identify\na unique painted caret at bidi and soft-wrap boundaries.", "signature": "# [doc = \" A UTF-16 position and its visual affinity. Offsets alone do not identify\"] # [doc = \" a unique painted caret at bidi and soft-wrap boundaries.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, Hash)] pub struct NativeTextPosition { # [doc = \" UTF-16 code units from the beginning of the caller's text.\"] pub utf16_offset : usize, # [doc = \" Incident logical edge used for this caret.\"] pub affinity : TextAffinity, }", "cfg": [] }, { "id": "gpui::editable_text::native_position::NativeTextSelection", "name": "NativeTextSelection", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::native_position", "path": "gpui::editable_text::native_position", "source": "crates/gpui/src/editable_text/native_position.rs", "summary": "Atomic primary selection, retaining both visual endpoints even when their logical offsets coincide. Secondary cursors use the legacy logical policy.", "documentation": "Atomic primary selection, retaining both visual endpoints even when their\nlogical offsets coincide. Secondary cursors use the legacy logical policy.", "signature": "# [doc = \" Atomic primary selection, retaining both visual endpoints even when their\"] # [doc = \" logical offsets coincide. Secondary cursors use the legacy logical policy.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct NativeTextSelection { # [doc = \" The fixed endpoint of the primary selection.\"] pub anchor : NativeTextPosition, # [doc = \" The moving endpoint of the primary selection.\"] pub head : NativeTextPosition, }", "cfg": [] }, { "id": "gpui::editable_text::native_position::TextAffinity", "name": "TextAffinity", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "editable_text::native_position", "path": "gpui::editable_text::native_position", "source": "crates/gpui/src/editable_text/native_position.rs", "summary": "Which incident logical text owns a caret at a bidi or soft-wrap boundary.", "documentation": "Which incident logical text owns a caret at a bidi or soft-wrap boundary.", "signature": "# [doc = \" Which incident logical text owns a caret at a bidi or soft-wrap boundary.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, Hash)] pub enum TextAffinity { # [doc = \" The trailing edge of the preceding logical text.\"] Upstream, # [doc = \" The leading edge of the following logical text. Legacy offset-only\"] # [doc = \" APIs use this affinity explicitly.\"] # [default] Downstream, }", "cfg": [] }, { "id": "gpui::editable_text::next_grapheme_boundary", "name": "next_grapheme_boundary", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Returns the following extended-grapheme boundary.", "documentation": "Returns the following extended-grapheme boundary.", "signature": "pub fn next_grapheme_boundary (text : & str, offset : usize) -> usize", "cfg": [] }, { "id": "gpui::editable_text::next_word_boundary", "name": "next_word_boundary", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Returns the end of the following non-whitespace word segment.", "documentation": "Returns the end of the following non-whitespace word segment.", "signature": "pub fn next_word_boundary (text : & str, offset : usize) -> usize", "cfg": [] }, { "id": "gpui::editable_text::normalize_multiline", "name": "normalize_multiline", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Normalizes CRLF and CR hard breaks to line feeds.", "documentation": "Normalizes CRLF and CR hard breaks to line feeds.", "signature": "pub fn normalize_multiline (text : & str) -> String", "cfg": [] }, { "id": "gpui::editable_text::normalize_single_line", "name": "normalize_single_line", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Normalizes hard breaks to spaces for a one-line editable value.", "documentation": "Normalizes hard breaks to spaces for a one-line editable value.", "signature": "pub fn normalize_single_line (text : & str) -> String", "cfg": [] }, { "id": "gpui::editable_text::offset_from_utf16", "name": "offset_from_utf16", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Converts a UTF-16 code-unit offset to a UTF-8 byte offset.", "documentation": "Converts a UTF-16 code-unit offset to a UTF-8 byte offset.", "signature": "pub fn offset_from_utf16 (text : & str, offset : usize) -> usize", "cfg": [] }, { "id": "gpui::editable_text::offset_to_utf16", "name": "offset_to_utf16", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Converts a UTF-8 byte offset to a UTF-16 code-unit offset.", "documentation": "Converts a UTF-8 byte offset to a UTF-16 code-unit offset.", "signature": "pub fn offset_to_utf16 (text : & str, offset : usize) -> usize", "cfg": [] }, { "id": "gpui::editable_text::paragraph_at", "name": "paragraph_at", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "The paragraph surrounding an offset: everything between two hard breaks.", "documentation": "The paragraph surrounding an offset: everything between two hard breaks.", "signature": "pub fn paragraph_at (text : & str, offset : usize) -> Range", "cfg": [] }, { "id": "gpui::editable_text::previous_grapheme_boundary", "name": "previous_grapheme_boundary", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Returns the preceding extended-grapheme boundary.", "documentation": "Returns the preceding extended-grapheme boundary.", "signature": "pub fn previous_grapheme_boundary (text : & str, offset : usize) -> usize", "cfg": [] }, { "id": "gpui::editable_text::previous_word_boundary", "name": "previous_word_boundary", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Returns the beginning of the preceding non-whitespace word segment.", "documentation": "Returns the beginning of the preceding non-whitespace word segment.", "signature": "pub fn previous_word_boundary (text : & str, offset : usize) -> usize", "cfg": [] }, { "id": "gpui::editable_text::projection::EditableLineProjection", "name": "EditableLineProjection", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "An immutable source-line ↔ displayed-row mapping. Omitted source remains in the document; this changes geometry, never editing coordinates or text.", "documentation": "An immutable source-line ↔ displayed-row mapping. Omitted source remains\nin the document; this changes geometry, never editing coordinates or text.", "signature": "# [doc = \" An immutable source-line ↔ displayed-row mapping. Omitted source remains\"] # [doc = \" in the document; this changes geometry, never editing coordinates or text.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct EditableLineProjection { source_lines : usize, rows : usize, spans : Arc<[Span]>, }", "cfg": [] }, { "id": "gpui::editable_text::projection::EditableLineProjection::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "Whether a source line has its own displayed row.", "documentation": "Whether a source line has its own displayed row.", "signature": "pub fn contains (& self, line : usize) -> bool", "cfg": [], "target": "EditableLineProjection" }, { "id": "gpui::editable_text::projection::EditableLineProjection::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "Builds an identity or omitted-line projection. Ranges are zero-based, half-open source-line indices. Overlap/nesting is unioned. Invalid bounds, an empty document line index, or hiding every line are refused.", "documentation": "Builds an identity or omitted-line projection. Ranges are zero-based,\nhalf-open source-line indices. Overlap/nesting is unioned. Invalid\nbounds, an empty document line index, or hiding every line are refused.", "signature": "pub fn new (source_lines : usize, omitted : impl IntoIterator>,) -> Option", "cfg": [], "target": "EditableLineProjection" }, { "id": "gpui::editable_text::projection::EditableLineProjection::row", "name": "row", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "Displayed row for a source line. Omitted lines map to the preceding displayed row, or row zero when the omitted range precedes all content.", "documentation": "Displayed row for a source line. Omitted lines map to the preceding\ndisplayed row, or row zero when the omitted range precedes all content.", "signature": "pub fn row (& self, line : usize) -> usize", "cfg": [], "target": "EditableLineProjection" }, { "id": "gpui::editable_text::projection::EditableLineProjection::rows", "name": "rows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "Number of displayed hard rows after omissions.", "documentation": "Number of displayed hard rows after omissions.", "signature": "pub fn rows (& self) -> usize", "cfg": [], "target": "EditableLineProjection" }, { "id": "gpui::editable_text::projection::EditableLineProjection::source_line", "name": "source_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "Source line for a displayed row, clamped at the last displayed row.", "documentation": "Source line for a displayed row, clamped at the last displayed row.", "signature": "pub fn source_line (& self, row : usize) -> usize", "cfg": [], "target": "EditableLineProjection" }, { "id": "gpui::editable_text::projection::EditableLineProjection::source_lines", "name": "source_lines", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::projection", "path": "gpui::editable_text::projection", "source": "crates/gpui/src/editable_text/projection.rs", "summary": "Number of source hard lines, including an empty final line.", "documentation": "Number of source hard lines, including an empty final line.", "signature": "pub fn source_lines (& self) -> usize", "cfg": [], "target": "EditableLineProjection" }, { "id": "gpui::editable_text::range_from_utf16", "name": "range_from_utf16", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Converts a UTF-16 code-unit range to UTF-8 byte offsets.", "documentation": "Converts a UTF-16 code-unit range to UTF-8 byte offsets.", "signature": "pub fn range_from_utf16 (text : & str, range_utf16 : & Range) -> Range", "cfg": [] }, { "id": "gpui::editable_text::range_to_utf16", "name": "range_to_utf16", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "Converts a UTF-8 byte range to UTF-16 code-unit offsets.", "documentation": "Converts a UTF-8 byte range to UTF-16 code-unit offsets.", "signature": "pub fn range_to_utf16 (text : & str, range : & Range) -> Range", "cfg": [] }, { "id": "gpui::editable_text::reexport-1", "name": "buffer :: { EditBuffer , EditOutcome , EditRules }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use buffer::{ EditBuffer, EditOutcome, EditRules };", "cfg": [] }, { "id": "gpui::editable_text::reexport-2", "name": "document :: { EditDifference , EditSnapshot }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use document::{ EditDifference, EditSnapshot };", "cfg": [] }, { "id": "gpui::editable_text::reexport-3", "name": "history :: EditCause", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use history::EditCause;", "cfg": [] }, { "id": "gpui::editable_text::reexport-4", "name": "layout :: { EditableTextLayout , EditableTextWork , EditableWrappedCache , TextNavigationDirection , TextSelectionRect , TextWritingDirection , }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use layout::{ EditableTextLayout, EditableTextWork, EditableWrappedCache, TextNavigationDirection, TextSelectionRect, TextWritingDirection, };", "cfg": [] }, { "id": "gpui::editable_text::reexport-5", "name": "native_position :: { NativeTextPosition , NativeTextSelection , TextAffinity }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use native_position::{ NativeTextPosition, NativeTextSelection, TextAffinity };", "cfg": [] }, { "id": "gpui::editable_text::reexport-6", "name": "projection :: EditableLineProjection", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use projection::EditableLineProjection;", "cfg": [] }, { "id": "gpui::editable_text::reexport-7", "name": "style_runs :: { EditableStyleRun , EditableStyleRuns }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "", "documentation": "", "signature": "pub use style_runs::{ EditableStyleRun, EditableStyleRuns };", "cfg": [] }, { "id": "gpui::editable_text::style_runs::EditableStyleRun", "name": "EditableStyleRun", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "One contiguous style run. Its length is measured in UTF-8 bytes.", "documentation": "One contiguous style run. Its length is measured in UTF-8 bytes.", "signature": "# [doc = \" One contiguous style run. Its length is measured in UTF-8 bytes.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct EditableStyleRun { # [doc = \" The number of source bytes carrying this style.\"] pub len : usize, # [doc = \" Product-neutral style metadata owned by the caller.\"] pub style : S, }", "cfg": [] }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns", "name": "EditableStyleRuns", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "Complete, normalized style coverage for an editable UTF-8 string.", "documentation": "Complete, normalized style coverage for an editable UTF-8 string.\n\nRuns never overlap, adjacent equal styles are merged, and their lengths\nalways sum to the associated text length. The collection does not own the\ntext or decide what a style means; rich text, syntax highlighting, and\ndiagnostics can each supply their own style vocabulary.", "signature": "# [doc = \" Complete, normalized style coverage for an editable UTF-8 string.\"] # [doc = \"\"] # [doc = \" Runs never overlap, adjacent equal styles are merged, and their lengths\"] # [doc = \" always sum to the associated text length. The collection does not own the\"] # [doc = \" text or decide what a style means; rich text, syntax highlighting, and\"] # [doc = \" diagnostics can each supply their own style vocabulary.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct EditableStyleRuns { default_style : S, len : usize, runs : Vec>, }", "cfg": [] }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "Returns whether the associated text is empty.", "documentation": "Returns whether the associated text is empty.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "The UTF-8 byte length covered by these runs.", "documentation": "The UTF-8 byte length covered by these runs.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "Covers `text` with one initial style.", "documentation": "Covers `text` with one initial style.", "signature": "pub fn new (text : & str, style : S) -> Self", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::replace", "name": "replace", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "Follows one grapheme-safe replacement from `text_before` to the text obtained by inserting `replacement` at `range`.", "documentation": "Follows one grapheme-safe replacement from `text_before` to the text\nobtained by inserting `replacement` at `range`.\n\nInserted text inherits the style at the replacement start, or the\npreceding style when appending. An empty document uses its remembered\ndefault style, including a style set at an empty caret.", "signature": "pub fn replace (& mut self, text_before : & str, range : Range, replacement : & str)", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::runs", "name": "runs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "The normalized runs in source order.", "documentation": "The normalized runs in source order.", "signature": "pub fn runs (& self) -> & [EditableStyleRun]", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::set", "name": "set", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "Applies a style to a grapheme-safe source range.", "documentation": "Applies a style to a grapheme-safe source range.", "signature": "pub fn set (& mut self, text : & str, range : Range, style : S)", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::style_runs::EditableStyleRuns::style_at", "name": "style_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "editable_text::style_runs", "path": "gpui::editable_text::style_runs", "source": "crates/gpui/src/editable_text/style_runs.rs", "summary": "The style at a source offset, preferring the preceding character at the end of the document.", "documentation": "The style at a source offset, preferring the preceding character at\nthe end of the document.", "signature": "pub fn style_at (& self, offset : usize) -> & S", "cfg": [], "target": "EditableStyleRuns" }, { "id": "gpui::editable_text::word_at", "name": "word_at", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "editable_text", "path": "gpui::editable_text", "source": "crates/gpui/src/editable_text/mod.rs", "summary": "The word surrounding an offset, for a double click.", "documentation": "The word surrounding an offset, for a double click.\n\nAn offset that falls on whitespace selects that whitespace run, which is\nwhat a double click between two words does elsewhere.", "signature": "pub fn word_at (text : & str, offset : usize) -> Range", "cfg": [] }, { "id": "gpui::effect_owner::App::current_effect_owner", "name": "current_effect_owner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "The explicitly scoped owner, never inferred from focus or current view.", "documentation": "The explicitly scoped owner, never inferred from focus or current view.", "signature": "pub fn current_effect_owner (& self) -> Option", "cfg": [], "target": "App" }, { "id": "gpui::effect_owner::App::set_clipboard_policy", "name": "set_clipboard_policy", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Installs host policy. Missing owners fail closed; native gestures do not bypass it. Ordinary apps without policy keep platform behavior.", "documentation": "Installs host policy. Missing owners fail closed; native gestures do\nnot bypass it. Ordinary apps without policy keep platform behavior.", "signature": "pub fn set_clipboard_policy (& mut self, policy : impl Fn (EffectOwner, ClipboardOperation) -> bool + 'static,)", "cfg": [], "target": "App" }, { "id": "gpui::effect_owner::App::try_read_from_clipboard", "name": "try_read_from_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Reads the clipboard, distinguishing refusal from an empty value.", "documentation": "Reads the clipboard, distinguishing refusal from an empty value.", "signature": "pub fn try_read_from_clipboard (& self) -> Result, ClipboardDenied>", "cfg": [], "target": "App" }, { "id": "gpui::effect_owner::App::try_read_from_find_pasteboard", "name": "try_read_from_find_pasteboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Reads the find pasteboard, distinguishing refusal from empty.", "documentation": "Reads the find pasteboard, distinguishing refusal from empty.", "signature": "pub fn try_read_from_find_pasteboard (& self) -> Result, ClipboardDenied>", "cfg": [ "cfg (target_os = \"macos\")" ], "target": "App" }, { "id": "gpui::effect_owner::App::try_read_from_primary", "name": "try_read_from_primary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Reads primary selection, distinguishing refusal from empty.", "documentation": "Reads primary selection, distinguishing refusal from empty.", "signature": "pub fn try_read_from_primary (& self) -> Result, ClipboardDenied>", "cfg": [ "cfg (any (target_os = \"linux\", target_os = \"freebsd\"))" ], "target": "App" }, { "id": "gpui::effect_owner::App::try_write_to_clipboard", "name": "try_write_to_clipboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Writes only if the current owner's host policy permits the operation.", "documentation": "Writes only if the current owner's host policy permits the operation.", "signature": "pub fn try_write_to_clipboard (& self, item : ClipboardItem) -> Result<(), ClipboardDenied>", "cfg": [], "target": "App" }, { "id": "gpui::effect_owner::App::try_write_to_find_pasteboard", "name": "try_write_to_find_pasteboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Writes the find pasteboard only after host permission.", "documentation": "Writes the find pasteboard only after host permission.", "signature": "pub fn try_write_to_find_pasteboard (& self, item : ClipboardItem) -> Result<(), ClipboardDenied>", "cfg": [ "cfg (target_os = \"macos\")" ], "target": "App" }, { "id": "gpui::effect_owner::App::try_write_to_primary", "name": "try_write_to_primary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Writes primary selection only after host permission.", "documentation": "Writes primary selection only after host permission.", "signature": "pub fn try_write_to_primary (& self, item : ClipboardItem) -> Result<(), ClipboardDenied>", "cfg": [ "cfg (any (target_os = \"linux\", target_os = \"freebsd\"))" ], "target": "App" }, { "id": "gpui::effect_owner::App::with_effect_owner", "name": "with_effect_owner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Runs a synchronous scope with an explicit owner (or without authority). Restores the previous context even when the callback unwinds.", "documentation": "Runs a synchronous scope with an explicit owner (or without authority).\nRestores the previous context even when the callback unwinds.", "signature": "pub fn with_effect_owner (& mut self, owner : Option, f : impl FnOnce (& mut App) -> R,) -> R", "cfg": [], "target": "App" }, { "id": "gpui::effect_owner::ClipboardDenied", "name": "ClipboardDenied", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "A host refused access; distinct from an empty clipboard.", "documentation": "A host refused access; distinct from an empty clipboard.", "signature": "# [doc = \" A host refused access; distinct from an empty clipboard.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq, thiserror::Error)] pub enum ClipboardDenied { # [doc = \" Policy is enabled but no owner was explicitly retained.\"] # [error (\"clipboard operation has no effect owner\")] MissingOwner, # [doc = \" The host refused the owner's operation, including stale identities.\"] # [error (\"clipboard operation denied by host\")] Denied, }", "cfg": [] }, { "id": "gpui::effect_owner::ClipboardOperation", "name": "ClipboardOperation", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "The clipboard effect requested by a native component.", "documentation": "The clipboard effect requested by a native component.", "signature": "# [doc = \" The clipboard effect requested by a native component.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq, Hash)] pub enum ClipboardOperation { # [doc = \" Read the ordinary clipboard.\"] Read, # [doc = \" Write the ordinary clipboard.\"] Write, # [doc = \" Read the primary selection (Linux/FreeBSD).\"] ReadPrimary, # [doc = \" Write the primary selection (Linux/FreeBSD).\"] WritePrimary, # [doc = \" Read the find pasteboard (macOS).\"] ReadFind, # [doc = \" Write the find pasteboard (macOS).\"] WriteFind, }", "cfg": [] }, { "id": "gpui::effect_owner::EffectOwner", "name": "EffectOwner", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Opaque host identity. A fresh token never reuses an earlier generation.", "documentation": "Opaque host identity. A fresh token never reuses an earlier generation.", "signature": "# [doc = \" Opaque host identity. A fresh token never reuses an earlier generation.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq, Hash)] pub struct EffectOwner (u64);", "cfg": [] }, { "id": "gpui::effect_owner::EffectOwner::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Allocates a fresh identity. Keep it for the lifetime of one host owner.", "documentation": "Allocates a fresh identity. Keep it for the lifetime of one host owner.", "signature": "pub fn new () -> Self", "cfg": [], "target": "EffectOwner" }, { "id": "gpui::effect_owner::EffectOwnerElement", "name": "EffectOwnerElement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "An inherited authority boundary with no layout or semantic identity of its own.", "documentation": "An inherited authority boundary with no layout or semantic identity of its own.", "signature": "# [doc = \" An inherited authority boundary with no layout or semantic identity of its own.\"] pub struct EffectOwnerElement { owner : Option, child : AnyElement, }", "cfg": [] }, { "id": "gpui::effect_owner::EffectScoped", "name": "EffectScoped", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "A typed child whose owner survives container transformations until render.", "documentation": "A typed child whose owner survives container transformations until render.\n\nContainers retain this wrapper instead of erasing a child into an element\nearly. Transform a child's options with `map`; inspect them with `as_ref`.\nPlain values converted with `From` inherit the eventual parent's context.", "signature": "# [doc = \" A typed child whose owner survives container transformations until render.\"] # [doc = \"\"] # [doc = \" Containers retain this wrapper instead of erasing a child into an element\"] # [doc = \" early. Transform a child's options with `map`; inspect them with `as_ref`.\"] # [doc = \" Plain values converted with `From` inherit the eventual parent's context.\"] # [derive (Clone, Debug)] pub struct EffectScoped { owner : Option, value : T, }", "cfg": [] }, { "id": "gpui::effect_owner::EffectScoped::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Transforms a typed value without discarding its scope.", "documentation": "Transforms a typed value without discarding its scope.", "signature": "pub fn map (self, transform : impl FnOnce (T) -> U) -> EffectScoped", "cfg": [], "target": "EffectScoped" }, { "id": "gpui::effect_owner::EffectScoped::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Attributes the child's eventual element lifecycle to this mount owner.", "documentation": "Attributes the child's eventual element lifecycle to this mount owner.", "signature": "pub fn new (owner : EffectOwner, value : T) -> Self", "cfg": [], "target": "EffectScoped" }, { "id": "gpui::effect_owner::effect_owner", "name": "effect_owner", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "effect_owner", "path": "gpui::effect_owner", "source": "crates/gpui/src/effect_owner.rs", "summary": "Attributes a subtree's native effects to the host-supplied opaque owner.", "documentation": "Attributes a subtree's native effects to the host-supplied opaque owner.", "signature": "pub fn effect_owner (owner : EffectOwner, child : impl IntoElement) -> EffectOwnerElement", "cfg": [] }, { "id": "gpui::element::AccessibilityRelationship", "name": "AccessibilityRelationship", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "A non-topological relationship between two accessibility nodes.", "documentation": "A non-topological relationship between two accessibility nodes.\n\nThe referenced [`ElementId`] must identify exactly one role-bearing element\nin the active window. Unlike layout parentage, relationships are resolved\nafter every ordinary and deferred subtree has prepainted, so either endpoint\nmay appear first. An absent or ambiguous endpoint omits the relationship for\nthat frame instead of retaining a stale node id.", "signature": "# [doc = \" A non-topological relationship between two accessibility nodes.\"] # [doc = \"\"] # [doc = \" The referenced [`ElementId`] must identify exactly one role-bearing element\"] # [doc = \" in the active window. Unlike layout parentage, relationships are resolved\"] # [doc = \" after every ordinary and deferred subtree has prepainted, so either endpoint\"] # [doc = \" may appear first. An absent or ambiguous endpoint omits the relationship for\"] # [doc = \" that frame instead of retaining a stale node id.\"] # [derive (Clone, Debug, Eq, PartialEq)] pub enum AccessibilityRelationship { # [doc = \" The current node is named by the referenced node.\"] LabelledBy (ElementId), # [doc = \" The current node is described by the referenced node.\"] DescribedBy (ElementId), # [doc = \" The current node names the referenced node.\"] Labels (ElementId), # [doc = \" The current node describes the referenced node.\"] Describes (ElementId), # [doc = \" The current node is the active descendant of the referenced focused\"] # [doc = \" composite, even when an overlay places the two in separate subtrees.\"] ActiveDescendantOf (ElementId), }", "cfg": [] }, { "id": "gpui::element::AnyElement", "name": "AnyElement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "A dynamically typed element that can be used to store any element type.", "documentation": "A dynamically typed element that can be used to store any element type.", "signature": "# [doc = \" A dynamically typed element that can be used to store any element type.\"] pub struct AnyElement (ArenaBox);", "cfg": [] }, { "id": "gpui::element::AnyElement::downcast_mut", "name": "downcast_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Attempt to downcast a reference to the boxed element to a specific type.", "documentation": "Attempt to downcast a reference to the boxed element to a specific type.", "signature": "pub fn downcast_mut (& mut self) -> Option<& mut T>", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::layout_as_root", "name": "layout_as_root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Performs layout for this element within the given available space and returns its size.", "documentation": "Performs layout for this element within the given available space and returns its size.", "signature": "pub fn layout_as_root (& mut self, available_space : Size, window : & mut Window, cx : & mut App,) -> Size", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::layout_as_root_with_size", "name": "layout_as_root_with_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Lay out this root with assigned border-box dimensions, independently of available space. For this invocation, authored root width, height, min/max size and aspect ratio are overridden; descendants reflow using their normal styles. Subsequent natural measurement restores the authored root style, including within the same frame.", "documentation": "Lay out this root with assigned border-box dimensions, independently\nof available space. For this invocation, authored root width, height,\nmin/max size and aspect ratio are overridden; descendants reflow using\ntheir normal styles. Subsequent natural measurement restores the authored\nroot style, including within the same frame.\n\nDimensions must be finite and nonnegative. Padding and borders are not\nremoved: if they cannot fit, the layout engine may enlarge the box.\nThe return value is the actual laid-out size, including device-pixel\nrounding, not a promise that impossible dimensions were honored.", "signature": "pub fn layout_as_root_with_size (& mut self, available_space : Size, assigned_size : Size, window : & mut Window, cx : & mut App,) -> Size", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::paint", "name": "paint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Paints the element stored in this `AnyElement`.", "documentation": "Paints the element stored in this `AnyElement`.", "signature": "pub fn paint (& mut self, window : & mut Window, cx : & mut App)", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::prepaint", "name": "prepaint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Prepares the element to be painted by storing its bounds, giving it a chance to draw hitboxes and request autoscroll before the final paint pass is confirmed.", "documentation": "Prepares the element to be painted by storing its bounds, giving it a chance to draw hitboxes and\nrequest autoscroll before the final paint pass is confirmed.", "signature": "pub fn prepaint (& mut self, window : & mut Window, cx : & mut App) -> Option", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::prepaint_as_root", "name": "prepaint_as_root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Performs layout on this element in the available space, then prepaints it at the given absolute origin. If any element in the subtree beneath this element is focused, its FocusHandle is returned.", "documentation": "Performs layout on this element in the available space, then prepaints it at the given absolute origin.\nIf any element in the subtree beneath this element is focused, its FocusHandle is returned.", "signature": "pub fn prepaint_as_root (& mut self, origin : Point, available_space : Size, window : & mut Window, cx : & mut App,) -> Option", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::prepaint_as_root_with_size", "name": "prepaint_as_root_with_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Lay out using [`Self::layout_as_root_with_size`] then prepaint at the given origin. Paint, hitboxes and accessibility use actual layout bounds.", "documentation": "Lay out using [`Self::layout_as_root_with_size`] then prepaint at the\ngiven origin. Paint, hitboxes and accessibility use actual layout bounds.", "signature": "pub fn prepaint_as_root_with_size (& mut self, origin : Point, available_space : Size, assigned_size : Size, window : & mut Window, cx : & mut App,) -> Option", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::prepaint_at", "name": "prepaint_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Prepaints this element at the given absolute origin. If any element in the subtree beneath this element is focused, its FocusHandle is returned.", "documentation": "Prepaints this element at the given absolute origin.\nIf any element in the subtree beneath this element is focused, its FocusHandle is returned.", "signature": "pub fn prepaint_at (& mut self, origin : Point, window : & mut Window, cx : & mut App,) -> Option", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::AnyElement::request_layout", "name": "request_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Request the layout ID of the element stored in this `AnyElement`. Used for laying out child elements in a parent element.", "documentation": "Request the layout ID of the element stored in this `AnyElement`.\nUsed for laying out child elements in a parent element.", "signature": "pub fn request_layout (& mut self, window : & mut Window, cx : & mut App) -> LayoutId", "cfg": [], "target": "AnyElement" }, { "id": "gpui::element::Drawable", "name": "Drawable", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "A wrapper around an implementer of [`Element`] that allows it to be drawn in a window.", "documentation": "A wrapper around an implementer of [`Element`] that allows it to be drawn in a window.", "signature": "# [doc = \" A wrapper around an implementer of [`Element`] that allows it to be drawn in a window.\"] pub struct Drawable { # [doc = \" The drawn element.\"] pub element : E, phase : ElementDrawPhase, }", "cfg": [] }, { "id": "gpui::element::Element", "name": "Element", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Implemented by types that participate in laying out and painting the contents of a window. Elements form a tree and are laid out according to web-based layout rules, as implemented by Taffy. You can create custom elements by implementing this trait, see the module-level documentation for more details.", "documentation": "Implemented by types that participate in laying out and painting the contents of a window.\nElements form a tree and are laid out according to web-based layout rules, as implemented by Taffy.\nYou can create custom elements by implementing this trait, see the module-level documentation\nfor more details.", "signature": "# [doc = \" Implemented by types that participate in laying out and painting the contents of a window.\"] # [doc = \" Elements form a tree and are laid out according to web-based layout rules, as implemented by Taffy.\"] # [doc = \" You can create custom elements by implementing this trait, see the module-level documentation\"] # [doc = \" for more details.\"] pub trait Element : 'static + IntoElement { # [doc = \" The type of state returned from [`Element::request_layout`]. A mutable reference to this state is subsequently\"] # [doc = \" provided to [`Element::prepaint`] and [`Element::paint`].\"] type RequestLayoutState : 'static; # [doc = \" The type of state returned from [`Element::prepaint`]. A mutable reference to this state is subsequently\"] # [doc = \" provided to [`Element::paint`].\"] type PrepaintState : 'static; # [doc = \" If this element has a unique identifier, return it here. This is used to track elements across frames, and\"] # [doc = \" will cause a GlobalElementId to be passed to the request_layout, prepaint, and paint methods.\"] # [doc = \"\"] # [doc = \" The global id can in turn be used to access state that's connected to an element with the same id across\"] # [doc = \" frames. This id must be unique among children of the first containing element with an id.\"] fn id (& self) -> Option; # [doc = \" Source location where this element was constructed, used to disambiguate elements in the\"] # [doc = \" inspector and navigate to their source code.\"] fn source_location (& self) -> Option<& 'static panic::Location<'static>>; # [doc = \" Before an element can be painted, we need to know where it's going to be and how big it is.\"] # [doc = \" Use this method to request a layout from Taffy and initialize the element's state.\"] fn request_layout (& mut self, id : Option<& GlobalElementId>, inspector_id : Option<& InspectorElementId>, window : & mut Window, cx : & mut App,) -> (LayoutId, Self::RequestLayoutState); # [doc = \" After laying out an element, we need to commit its bounds to the current frame for hitbox\"] # [doc = \" purposes. The state argument is the same state that was returned from [`Element::request_layout()`].\"] fn prepaint (& mut self, id : Option<& GlobalElementId>, inspector_id : Option<& InspectorElementId>, bounds : Bounds, request_layout : & mut Self::RequestLayoutState, window : & mut Window, cx : & mut App,) -> Self::PrepaintState; # [doc = \" Once layout has been completed, this method will be called to paint the element to the screen.\"] # [doc = \" The state argument is the same state that was returned from [`Element::request_layout()`].\"] # [allow (clippy::too_many_arguments)] fn paint (& mut self, id : Option<& GlobalElementId>, inspector_id : Option<& InspectorElementId>, bounds : Bounds, request_layout : & mut Self::RequestLayoutState, prepaint : & mut Self::PrepaintState, window : & mut Window, cx : & mut App,); # [doc = \" Returns the accessible role for this element, if any.\"] # [doc = \" Elements that return `None` are not included in the accessibility tree.\"] # [doc = \"\"] # [doc = \" Note: inclusion in accessibility tree requires non-`None` [`id`][Element::id].\"] # [doc = \"\"] # [doc = \" See the [accessibility guide](crate::_accessibility) for an overview.\"] fn a11y_role (& self) -> Option { None } # [doc = \" Write accessibility properties to the given node.\"] # [doc = \" Called only when `a11y_role()` returns `Some`.\"] # [doc = \"\"] # [doc = \" See the [accessibility guide](crate::_accessibility) for an overview.\"] fn write_a11y_info (& self, _node : & mut accesskit::Node) { } # [doc = \" Writes properties while optionally supplying the complete value as\"] # [doc = \" shared storage. GPUI materializes it only when the final node changes;\"] # [doc = \" this is native-node retention, not an abbreviated accessible value.\"] # [doc = \" Implementations returning a value must omit it from `node` here.\"] # [doc = \" The ordinary `write_a11y_info` contract remains fully materialized.\"] fn write_a11y_info_shared (& self, node : & mut accesskit::Node) -> Option { self . write_a11y_info (node); None } # [doc = \" Returns this element's non-topological accessibility relationships.\"] # [doc = \"\"] # [doc = \" Called only when [`Element::a11y_role`] returns `Some`. GPUI resolves\"] # [doc = \" the referenced element identities after deferred prepaint completes.\"] fn a11y_relationships (& self) -> & [AccessibilityRelationship] { & [] } # [doc = \" Add synthetic child nodes to an [`Element`] that has an\"] # [doc = \" [`.id()`][Element::id] and a [`.role()`][Element::a11y_role].\"] # [doc = \"\"] # [doc = \" Some elements may want to inject accessibility nodes that do not\"] # [doc = \" correspond to any GPUI element. For example, a custom text field element\"] # [doc = \" may want to inject synthetic child nodes for the text content.\"] # [doc = \"\"] # [doc = \" See [Synthetic children](crate::_accessibility#synthetic-children) in\"] # [doc = \" the accessibility guide for more detail.\"] fn a11y_synthetic_children (& mut self, _prepaint : & mut Self::PrepaintState, _builder : & mut A11ySubtreeBuilder,) { } # [doc = \" Convert this element into a dynamically-typed [`AnyElement`].\"] fn into_any (self) -> AnyElement { AnyElement::new (self) } }", "cfg": [] }, { "id": "gpui::element::Empty", "name": "Empty", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "The empty element, which renders nothing.", "documentation": "The empty element, which renders nothing.", "signature": "# [doc = \" The empty element, which renders nothing.\"] pub struct Empty;", "cfg": [] }, { "id": "gpui::element::GlobalElementId", "name": "GlobalElementId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "A globally unique identifier for an element, used to track state across frames.", "documentation": "A globally unique identifier for an element, used to track state across frames.", "signature": "# [doc = \" A globally unique identifier for an element, used to track state across frames.\"] # [derive (Deref, DerefMut, Clone, Default, Debug, Eq, PartialEq, Hash)] pub struct GlobalElementId (pub (crate) Arc<[ElementId]>);", "cfg": [] }, { "id": "gpui::element::IntoElement", "name": "IntoElement", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "Implemented by any type that can be converted into an element.", "documentation": "Implemented by any type that can be converted into an element.", "signature": "# [doc = \" Implemented by any type that can be converted into an element.\"] pub trait IntoElement : Sized { # [doc = \" The specific type of element into which the implementing type is converted.\"] # [doc = \" Useful for converting other types into elements automatically, like Strings\"] type Element : Element; # [doc = \" Convert self into a type that implements [`Element`].\"] fn into_element (self) -> Self::Element; # [doc = \" Convert self into a dynamically-typed [`AnyElement`].\"] fn into_any_element (self) -> AnyElement { self . into_element () . into_any () } }", "cfg": [] }, { "id": "gpui::element::ParentElement", "name": "ParentElement", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "This is a helper trait to provide a uniform interface for constructing elements that can accept any number of any kind of child elements", "documentation": "This is a helper trait to provide a uniform interface for constructing elements that\ncan accept any number of any kind of child elements", "signature": "# [doc = \" This is a helper trait to provide a uniform interface for constructing elements that\"] # [doc = \" can accept any number of any kind of child elements\"] pub trait ParentElement { # [doc = \" Extend this element's children with the given child elements.\"] fn extend (& mut self, elements : impl IntoIterator); # [doc = \" Add a single child element to this element.\"] fn child (mut self, child : impl IntoElement) -> Self where Self : Sized, { self . extend (std::iter::once (child . into_element () . into_any ())); self } # [doc = \" Add multiple child elements to this element.\"] fn children (mut self, children : impl IntoIterator) -> Self where Self : Sized, { self . extend (children . into_iter () . map (| child | child . into_any_element ())); self } }", "cfg": [] }, { "id": "gpui::element::Render", "name": "Render", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "An object that can be drawn to the screen. This is the trait that distinguishes \"views\" from other entities. Views are `Entity`'s which `impl Render` and drawn to the screen.", "documentation": "An object that can be drawn to the screen. This is the trait that distinguishes \"views\" from\nother entities. Views are `Entity`'s which `impl Render` and drawn to the screen.", "signature": "# [doc = \" An object that can be drawn to the screen. This is the trait that distinguishes \\\"views\\\" from\"] # [doc = \" other entities. Views are `Entity`'s which `impl Render` and drawn to the screen.\"] pub trait Render : 'static + Sized { # [doc = \" Render this view into an element tree.\"] fn render (& mut self, window : & mut Window, cx : & mut Context) -> impl IntoElement; }", "cfg": [] }, { "id": "gpui::element::RenderOnce", "name": "RenderOnce", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "element", "path": "gpui::element", "source": "crates/gpui/src/element.rs", "summary": "You can derive [`IntoElement`] on any type that implements this trait. It is used to construct reusable `components` out of plain data. Think of components as a recipe for a certain pattern of elements. RenderOnce allows you to invoke this pattern, without breaking the fluent builder pattern of the element APIs.", "documentation": "You can derive [`IntoElement`] on any type that implements this trait.\nIt is used to construct reusable `components` out of plain data. Think of\ncomponents as a recipe for a certain pattern of elements. RenderOnce allows\nyou to invoke this pattern, without breaking the fluent builder pattern of\nthe element APIs.", "signature": "# [doc = \" You can derive [`IntoElement`] on any type that implements this trait.\"] # [doc = \" It is used to construct reusable `components` out of plain data. Think of\"] # [doc = \" components as a recipe for a certain pattern of elements. RenderOnce allows\"] # [doc = \" you to invoke this pattern, without breaking the fluent builder pattern of\"] # [doc = \" the element APIs.\"] pub trait RenderOnce : 'static { # [doc = \" Render this component into an element tree. Note that this method\"] # [doc = \" takes ownership of self, as compared to [`Render::render()`] method\"] # [doc = \" which takes a mutable reference.\"] fn render (self, window : & mut Window, cx : & mut App) -> impl IntoElement; }", "cfg": [] }, { "id": "gpui::elements::anchored::Anchored", "name": "Anchored", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "An anchored element that can be used to display UI that will avoid overflowing the window bounds.", "documentation": "An anchored element that can be used to display UI that\nwill avoid overflowing the window bounds.", "signature": "# [doc = \" An anchored element that can be used to display UI that\"] # [doc = \" will avoid overflowing the window bounds.\"] pub struct Anchored { children : SmallVec<[AnyElement; 2]>, anchor : Anchor, fit_mode : AnchoredFitMode, anchor_position : Option>, position_mode : AnchoredPositionMode, offset : Option>, }", "cfg": [] }, { "id": "gpui::elements::anchored::Anchored::anchor", "name": "anchor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Sets which corner of the anchored element should be anchored to the current position.", "documentation": "Sets which corner of the anchored element should be anchored to the current position.", "signature": "pub fn anchor (mut self, anchor : Anchor) -> Self", "cfg": [], "target": "Anchored" }, { "id": "gpui::elements::anchored::Anchored::offset", "name": "offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Offset the final position by this amount. Useful when you want to anchor to an element but offset from it, such as in PopoverMenu.", "documentation": "Offset the final position by this amount.\nUseful when you want to anchor to an element but offset from it, such as in PopoverMenu.", "signature": "pub fn offset (mut self, offset : Point) -> Self", "cfg": [], "target": "Anchored" }, { "id": "gpui::elements::anchored::Anchored::position", "name": "position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Sets the position in window coordinates (otherwise the location the anchored element is rendered is used) Under a visual scale this remains layout-space. Inverse-map a displayed caret/selection anchor using the captured transform before supplying it.", "documentation": "Sets the position in window coordinates\n(otherwise the location the anchored element is rendered is used)\nUnder a visual scale this remains layout-space. Inverse-map a displayed\ncaret/selection anchor using the captured transform before supplying it.", "signature": "pub fn position (mut self, anchor : Point) -> Self", "cfg": [], "target": "Anchored" }, { "id": "gpui::elements::anchored::Anchored::position_mode", "name": "position_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Sets the position mode for this anchored element. Local will have this interpret its [`Anchored::position`] as relative to the parent element. While Window will have it interpret the position as relative to the window.", "documentation": "Sets the position mode for this anchored element. Local will have this\ninterpret its [`Anchored::position`] as relative to the parent element.\nWhile Window will have it interpret the position as relative to the window.", "signature": "pub fn position_mode (mut self, mode : AnchoredPositionMode) -> Self", "cfg": [], "target": "Anchored" }, { "id": "gpui::elements::anchored::Anchored::snap_to_window", "name": "snap_to_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Snap to window edge instead of switching anchor corner when an overflow would occur.", "documentation": "Snap to window edge instead of switching anchor corner when an overflow would occur.", "signature": "pub fn snap_to_window (mut self) -> Self", "cfg": [], "target": "Anchored" }, { "id": "gpui::elements::anchored::Anchored::snap_to_window_with_margin", "name": "snap_to_window_with_margin", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Snap to window edge and leave some margins.", "documentation": "Snap to window edge and leave some margins.", "signature": "pub fn snap_to_window_with_margin (mut self, edges : impl Into>) -> Self", "cfg": [], "target": "Anchored" }, { "id": "gpui::elements::anchored::AnchoredFitMode", "name": "AnchoredFitMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Which algorithm to use when fitting the anchored element to be inside the window.", "documentation": "Which algorithm to use when fitting the anchored element to be inside the window.", "signature": "# [doc = \" Which algorithm to use when fitting the anchored element to be inside the window.\"] # [derive (Copy, Clone, PartialEq)] pub enum AnchoredFitMode { # [doc = \" Snap the anchored element to the window edge.\"] SnapToWindow, # [doc = \" Snap to window edge and leave some margins.\"] SnapToWindowWithMargin (Edges), # [doc = \" Switch which corner anchor this anchored element is attached to.\"] SwitchAnchor, }", "cfg": [] }, { "id": "gpui::elements::anchored::AnchoredPositionMode", "name": "AnchoredPositionMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "Which algorithm to use when positioning the anchored element.", "documentation": "Which algorithm to use when positioning the anchored element.", "signature": "# [doc = \" Which algorithm to use when positioning the anchored element.\"] # [derive (Copy, Clone, PartialEq)] pub enum AnchoredPositionMode { # [doc = \" Position the anchored element relative to the window.\"] Window, # [doc = \" Position the anchored element relative to its parent.\"] Local, }", "cfg": [] }, { "id": "gpui::elements::anchored::AnchoredState", "name": "AnchoredState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "The state that the anchored element element uses to track its children.", "documentation": "The state that the anchored element element uses to track its children.", "signature": "# [doc = \" The state that the anchored element element uses to track its children.\"] pub struct AnchoredState { child_layout_ids : SmallVec<[LayoutId; 4]>, }", "cfg": [] }, { "id": "gpui::elements::anchored::anchored", "name": "anchored", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::anchored", "path": "gpui::elements::anchored", "source": "crates/gpui/src/elements/anchored.rs", "summary": "anchored gives you an element that will avoid overflowing the window bounds. Its children should have no margin to avoid measurement issues.", "documentation": "anchored gives you an element that will avoid overflowing the window bounds.\nIts children should have no margin to avoid measurement issues.", "signature": "pub fn anchored () -> Anchored", "cfg": [] }, { "id": "gpui::elements::animation::Animation", "name": "Animation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "An animation that can be applied to an element.", "documentation": "An animation that can be applied to an element.", "signature": "# [doc = \" An animation that can be applied to an element.\"] # [derive (Clone)] pub struct Animation { # [doc = \" The amount of time for which this animation should run\"] pub duration : Duration, # [doc = \" Whether to repeat this animation when it finishes\"] pub oneshot : bool, # [doc = \" A function that maps normalized time to an animated value.\"] # [doc = \" The result may exceed 0..1 for easing functions that overshoot.\"] pub easing : Rc f32>, }", "cfg": [] }, { "id": "gpui::elements::animation::Animation::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "Create a new animation with the given duration. By default the animation will only run once and will use a linear easing function.", "documentation": "Create a new animation with the given duration.\nBy default the animation will only run once and will use a linear easing function.", "signature": "pub fn new (duration : Duration) -> Self", "cfg": [], "target": "Animation" }, { "id": "gpui::elements::animation::Animation::repeat", "name": "repeat", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "Set the animation to loop when it finishes.", "documentation": "Set the animation to loop when it finishes.", "signature": "pub fn repeat (mut self) -> Self", "cfg": [], "target": "Animation" }, { "id": "gpui::elements::animation::Animation::with_easing", "name": "with_easing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "Sets the easing function used to map normalized time to an animated value.", "documentation": "Sets the easing function used to map normalized time to an animated value.\n\nThe output is not clamped, allowing physical easing functions such as\nsprings to overshoot.", "signature": "pub fn with_easing (mut self, easing : impl Fn (f32) -> f32 + 'static) -> Self", "cfg": [], "target": "Animation" }, { "id": "gpui::elements::animation::AnimationElement", "name": "AnimationElement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "A GPUI element that applies an animation to another element", "documentation": "A GPUI element that applies an animation to another element", "signature": "# [doc = \" A GPUI element that applies an animation to another element\"] pub struct AnimationElement { id : ElementId, element : Option, animations : SmallVec<[Animation; 1]>, animator : Box E + 'static>, }", "cfg": [] }, { "id": "gpui::elements::animation::AnimationElement::map_element", "name": "map_element", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "Returns a new [`AnimationElement`] after applying the given function to the element being animated.", "documentation": "Returns a new [`AnimationElement`] after applying the given function\nto the element being animated.", "signature": "pub fn map_element (mut self, f : impl FnOnce (E) -> E) -> AnimationElement", "cfg": [], "target": "AnimationElement" }, { "id": "gpui::elements::animation::AnimationExt", "name": "AnimationExt", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "An extension trait for adding the animation wrapper to both Elements and Components", "documentation": "An extension trait for adding the animation wrapper to both Elements and Components\n\nAnimations rendered through this trait automatically respect\n[`App::reduce_motion`](crate::App::reduce_motion): when it is set,\nthe element is rendered in a static state (the end state for oneshot\nanimations, the start state for repeating ones) and no animation frames are\nscheduled.", "signature": "# [doc = \" An extension trait for adding the animation wrapper to both Elements and Components\"] # [doc = \"\"] # [doc = \" Animations rendered through this trait automatically respect\"] # [doc = \" [`App::reduce_motion`](crate::App::reduce_motion): when it is set,\"] # [doc = \" the element is rendered in a static state (the end state for oneshot\"] # [doc = \" animations, the start state for repeating ones) and no animation frames are\"] # [doc = \" scheduled.\"] pub trait AnimationExt { # [doc = \" Render this component or element with an animation\"] fn with_animation (self, id : impl Into, animation : Animation, animator : impl Fn (Self, f32) -> Self + 'static,) -> AnimationElement where Self : Sized, { AnimationElement { id : id . into (), element : Some (self), animator : Box::new (move | this, _, value | animator (this, value)), animations : smallvec::smallvec ! [animation], } } # [doc = \" Render this component or element with a chain of animations\"] fn with_animations (self, id : impl Into, animations : Vec, animator : impl Fn (Self, usize, f32) -> Self + 'static,) -> AnimationElement where Self : Sized, { AnimationElement { id : id . into (), element : Some (self), animator : Box::new (animator), animations : animations . into (), } } # [doc = \" Renders this component or element at the value produced by a spring.\"] # [doc = \"\"] # [doc = \" The element ID preserves position and velocity across target changes.\"] # [doc = \" A newly mounted spring starts at its target unless configured with\"] # [doc = \" [`SpringAnimation::from`].\"] fn with_spring (self, id : impl Into, animation : SpringAnimation, animator : impl FnOnce (Self, T::Output) -> Self + 'static,) -> SpringAnimationElement where Self : Sized, T : SpringTarget, T::Output : 'static, { let SpringAnimation { config, target, epsilon, initial, playback, } = animation; let scalar_target = target . target (); SpringAnimationElement { id : id . into (), element : Some (self), config, target : scalar_target, epsilon, initial, playback, animator : Some (Box::new (move | this, value | { animator (this, target . resolve (value)) })), } } }", "cfg": [] }, { "id": "gpui::elements::animation::SpringAnimationElement", "name": "SpringAnimationElement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "A GPUI element driven by a stateful spring.", "documentation": "A GPUI element driven by a stateful spring.", "signature": "# [doc = \" A GPUI element driven by a stateful spring.\"] pub struct SpringAnimationElement { id : ElementId, element : Option, config : SpringConfig, target : f32, epsilon : f32, initial : Option, playback : SpringPlayback, animator : Option E + 'static>>, }", "cfg": [] }, { "id": "gpui::elements::animation::SpringAnimationElement::map_element", "name": "map_element", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "Returns a new [`SpringAnimationElement`] after applying the given function to the element being animated.", "documentation": "Returns a new [`SpringAnimationElement`] after applying the given function\nto the element being animated.", "signature": "pub fn map_element (mut self, f : impl FnOnce (E) -> E) -> SpringAnimationElement", "cfg": [], "target": "SpringAnimationElement" }, { "id": "gpui::elements::animation::reexport-1", "name": "easing :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements::animation", "path": "gpui::elements::animation", "source": "crates/gpui/src/elements/animation.rs", "summary": "", "documentation": "", "signature": "pub use easing::*;", "cfg": [] }, { "id": "gpui::elements::canvas::Canvas", "name": "Canvas", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::canvas", "path": "gpui::elements::canvas", "source": "crates/gpui/src/elements/canvas.rs", "summary": "A canvas element, meant for accessing the low level paint API without defining a whole custom element", "documentation": "A canvas element, meant for accessing the low level paint API without defining a whole\ncustom element", "signature": "# [doc = \" A canvas element, meant for accessing the low level paint API without defining a whole\"] # [doc = \" custom element\"] pub struct Canvas { prepaint : Option, & mut Window, & mut App) -> T>>, paint : Option, T, & mut Window, & mut App)>>, style : StyleRefinement, }", "cfg": [] }, { "id": "gpui::elements::canvas::canvas", "name": "canvas", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::canvas", "path": "gpui::elements::canvas", "source": "crates/gpui/src/elements/canvas.rs", "summary": "Construct a canvas element with the given paint callback. Useful for adding short term custom drawing to a view.", "documentation": "Construct a canvas element with the given paint callback.\nUseful for adding short term custom drawing to a view.", "signature": "pub fn canvas (prepaint : impl 'static + FnOnce (Bounds, & mut Window, & mut App) -> T, paint : impl 'static + FnOnce (Bounds, T, & mut Window, & mut App),) -> Canvas", "cfg": [] }, { "id": "gpui::elements::container_query::ContainerQuery", "name": "ContainerQuery", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::container_query", "path": "gpui::elements::container_query", "source": "crates/gpui/src/elements/container_query.rs", "summary": "A container query element, created with [`container_query`].", "documentation": "A container query element, created with [`container_query`].", "signature": "# [doc = \" A container query element, created with [`container_query`].\"] pub struct ContainerQuery { render : Option, & mut Window, & mut App) -> AnyElement>>, style : StyleRefinement, }", "cfg": [] }, { "id": "gpui::elements::container_query::container_query", "name": "container_query", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::container_query", "path": "gpui::elements::container_query", "source": "crates/gpui/src/elements/container_query.rs", "summary": "Construct a container query element with the given render callback. The callback receives the size the element was assigned during layout and returns the contents to display within it.", "documentation": "Construct a container query element with the given render callback.\nThe callback receives the size the element was assigned during layout and\nreturns the contents to display within it.\n\nBy default the element fills its parent (equivalent to `.size_full()`);\nuse the [`Styled`] methods to size it differently. Because the contents\ndon't exist until after layout, they cannot influence the element's size.\n\n# Example\n\n```\n# use gpui::{container_query, div, px, IntoElement, ParentElement};\ncontainer_query(|size, _window, _cx| {\nif size.width < px(240.) {\ndiv().child(\"Narrow layout\")\n} else {\ndiv().child(\"Wide layout\")\n}\n});\n```", "signature": "pub fn container_query (render : impl 'static + FnOnce (Size, & mut Window, & mut App) -> E,) -> ContainerQuery where E : IntoElement,", "cfg": [] }, { "id": "gpui::elements::deferred::Deferred", "name": "Deferred", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::deferred", "path": "gpui::elements::deferred", "source": "crates/gpui/src/elements/deferred.rs", "summary": "An element which delays the painting of its child until after all of its ancestors, while keeping its layout as part of the current element tree.", "documentation": "An element which delays the painting of its child until after all of\nits ancestors, while keeping its layout as part of the current element tree.", "signature": "# [doc = \" An element which delays the painting of its child until after all of\"] # [doc = \" its ancestors, while keeping its layout as part of the current element tree.\"] pub struct Deferred { child : Option, priority : usize, preserve_accessibility : bool, unclipped : bool, }", "cfg": [] }, { "id": "gpui::elements::deferred::Deferred::preserve_accessibility", "name": "preserve_accessibility", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::deferred", "path": "gpui::elements::deferred", "source": "crates/gpui/src/elements/deferred.rs", "summary": "Retains logical accessibility ancestry and reading order for inline content. By default, deferred overlay surfaces attach to the window root.", "documentation": "Retains logical accessibility ancestry and reading order for inline\ncontent. By default, deferred overlay surfaces attach to the window root.", "signature": "pub fn preserve_accessibility (mut self) -> Self", "cfg": [], "target": "Deferred" }, { "id": "gpui::elements::deferred::Deferred::priority", "name": "priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::deferred", "path": "gpui::elements::deferred", "source": "crates/gpui/src/elements/deferred.rs", "summary": "Sets a priority for the element. A higher priority conceptually means painting the element on top of deferred draws with a lower priority (i.e. closer to the viewer).", "documentation": "Sets a priority for the element. A higher priority conceptually means painting the element\non top of deferred draws with a lower priority (i.e. closer to the viewer).", "signature": "pub fn priority (mut self, priority : usize) -> Self", "cfg": [], "target": "Deferred" }, { "id": "gpui::elements::deferred::Deferred::unclipped", "name": "unclipped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::deferred", "path": "gpui::elements::deferred", "source": "crates/gpui/src/elements/deferred.rs", "summary": "Escapes inherited content masks when scheduling this subtree. Its own masks still apply. The inherited visual transform and logical layout coordinates are preserved, not reset to window-root coordinates. Accessibility ancestry is independent; combine with [`Self::preserve_accessibility`] for inline logical ownership. Without this opt-in, deferred clipping behavior is unchanged.", "documentation": "Escapes inherited content masks when scheduling this subtree. Its own\nmasks still apply. The inherited visual transform and logical layout\ncoordinates are preserved, not reset to window-root coordinates.\nAccessibility ancestry is independent; combine with\n[`Self::preserve_accessibility`] for inline logical ownership.\nWithout this opt-in, deferred clipping behavior is unchanged.", "signature": "pub fn unclipped (mut self) -> Self", "cfg": [], "target": "Deferred" }, { "id": "gpui::elements::deferred::Deferred::with_priority", "name": "with_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::deferred", "path": "gpui::elements::deferred", "source": "crates/gpui/src/elements/deferred.rs", "summary": "Sets the `priority` value of the `deferred` element, which determines the drawing order relative to other deferred elements, with higher values being drawn on top.", "documentation": "Sets the `priority` value of the `deferred` element, which\ndetermines the drawing order relative to other deferred elements,\nwith higher values being drawn on top.", "signature": "pub fn with_priority (mut self, priority : usize) -> Self", "cfg": [], "target": "Deferred" }, { "id": "gpui::elements::deferred::deferred", "name": "deferred", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::deferred", "path": "gpui::elements::deferred", "source": "crates/gpui/src/elements/deferred.rs", "summary": "Builds a `Deferred` element, which delays the layout and paint of its child.", "documentation": "Builds a `Deferred` element, which delays the layout and paint of its child.", "signature": "pub fn deferred (child : impl IntoElement) -> Deferred", "cfg": [] }, { "id": "gpui::elements::div::Div", "name": "Div", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "A [`Div`] element, the all-in-one element for building complex UIs in GPUI", "documentation": "A [`Div`] element, the all-in-one element for building complex UIs in GPUI", "signature": "# [doc = \" A [`Div`] element, the all-in-one element for building complex UIs in GPUI\"] pub struct Div { interactivity : Interactivity, children : SmallVec<[StackSafe; 2]>, prepaint_listener : Option>, & mut Window, & mut App) + 'static>>, image_cache : Option>, prepaint_order_fn : Option SmallVec<[usize; 8]>>>, }", "cfg": [] }, { "id": "gpui::elements::div::Div::image_cache", "name": "image_cache", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Add an image cache at the location of this div in the element tree.", "documentation": "Add an image cache at the location of this div in the element tree.", "signature": "pub fn image_cache (mut self, cache : impl ImageCacheProvider) -> Self", "cfg": [], "target": "Div" }, { "id": "gpui::elements::div::Div::on_children_prepainted", "name": "on_children_prepainted", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Add a listener to be called when the children of this `Div` are prepainted. This allows you to store the [`Bounds`] of the children for later use.", "documentation": "Add a listener to be called when the children of this `Div` are prepainted.\nThis allows you to store the [`Bounds`] of the children for later use.", "signature": "pub fn on_children_prepainted (mut self, listener : impl Fn (Vec>, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "Div" }, { "id": "gpui::elements::div::Div::with_dynamic_prepaint_order", "name": "with_dynamic_prepaint_order", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Specify a function that determines the order in which children are prepainted.", "documentation": "Specify a function that determines the order in which children are prepainted.\n\nThe function is called at prepaint time and should return a vector of child indices\nin the desired prepaint order. Each index should appear exactly once.\n\nThis is useful when the prepaint of one child affects state that another child reads.\nFor example, in split editor views, the editor with an autoscroll request should\nbe prepainted first so its scroll position update is visible to the other editor.", "signature": "pub fn with_dynamic_prepaint_order (mut self, order_fn : impl Fn (& mut Window, & mut App) -> SmallVec<[usize; 8]> + 'static,) -> Self", "cfg": [], "target": "Div" }, { "id": "gpui::elements::div::DivFrameState", "name": "DivFrameState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "A frame state for a `Div` element, which contains layout IDs for its children.", "documentation": "A frame state for a `Div` element, which contains layout IDs for its children.\n\nThis struct is used internally by the `Div` element to manage the layout state of its children\nduring the UI update cycle. It holds a small vector of `LayoutId` values, each corresponding to\na child element of the `Div`. These IDs are used to query the layout engine for the computed\nbounds of the children after the layout phase is complete.", "signature": "# [doc = \" A frame state for a `Div` element, which contains layout IDs for its children.\"] # [doc = \"\"] # [doc = \" This struct is used internally by the `Div` element to manage the layout state of its children\"] # [doc = \" during the UI update cycle. It holds a small vector of `LayoutId` values, each corresponding to\"] # [doc = \" a child element of the `Div`. These IDs are used to query the layout engine for the computed\"] # [doc = \" bounds of the children after the layout phase is complete.\"] pub struct DivFrameState { child_layout_ids : SmallVec<[LayoutId; 2]>, }", "cfg": [] }, { "id": "gpui::elements::div::DivInspectorState", "name": "DivInspectorState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Interactivity state displayed an manipulated in the inspector.", "documentation": "Interactivity state displayed an manipulated in the inspector.", "signature": "# [doc = \" Interactivity state displayed an manipulated in the inspector.\"] # [derive (Clone)] pub struct DivInspectorState { # [doc = \" The inspected element's base style. This is used for both inspecting and modifying the\"] # [doc = \" state. In the future it will make sense to separate the read and write, possibly tracking\"] # [doc = \" the modifications.\"] # [cfg (any (feature = \"inspector\", debug_assertions))] pub base_style : Box, # [doc = \" Inspects the bounds of the element.\"] pub bounds : Bounds, # [doc = \" Size of the children of the element, or `bounds.size` if it has no children.\"] pub content_size : Size, }", "cfg": [] }, { "id": "gpui::elements::div::DragMoveEvent", "name": "DragMoveEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "An event for when a drag is moving over this element, with the given state type.", "documentation": "An event for when a drag is moving over this element, with the given state type.", "signature": "# [doc = \" An event for when a drag is moving over this element, with the given state type.\"] pub struct DragMoveEvent { # [doc = \" The mouse move event that triggered this drag move event.\"] pub event : MouseMoveEvent, # [doc = \" The bounds of this element.\"] pub bounds : Bounds, drag : PhantomData, dragged_item : Arc, }", "cfg": [] }, { "id": "gpui::elements::div::DragMoveEvent::drag", "name": "drag", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Returns the drag state for this event.", "documentation": "Returns the drag state for this event.", "signature": "pub fn drag<'b> (& self, cx : & 'b App) -> & 'b T", "cfg": [], "target": "DragMoveEvent" }, { "id": "gpui::elements::div::DragMoveEvent::dragged_item", "name": "dragged_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "An item that is about to be dropped.", "documentation": "An item that is about to be dropped.", "signature": "pub fn dragged_item (& self) -> & dyn Any", "cfg": [], "target": "DragMoveEvent" }, { "id": "gpui::elements::div::ElementClickedState", "name": "ElementClickedState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Whether or not the element or a group that contains it is clicked by the mouse.", "documentation": "Whether or not the element or a group that contains it is clicked by the mouse.", "signature": "# [doc = \" Whether or not the element or a group that contains it is clicked by the mouse.\"] # [derive (Copy, Clone, Default, Eq, PartialEq)] pub struct ElementClickedState { # [doc = \" True if this element's group has been clicked, false otherwise\"] pub group : bool, # [doc = \" True if this element has been clicked, false otherwise\"] pub element : bool, # [doc = \" The button owning the current pressed appearance, if any.\"] pub button : Option, }", "cfg": [] }, { "id": "gpui::elements::div::ElementHoverState", "name": "ElementHoverState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Whether or not the element or a group that contains it is hovered.", "documentation": "Whether or not the element or a group that contains it is hovered.", "signature": "# [doc = \" Whether or not the element or a group that contains it is hovered.\"] # [derive (Copy, Clone, Default, Eq, PartialEq)] pub struct ElementHoverState { # [doc = \" True if this element's group is hovered, false otherwise\"] pub group : bool, # [doc = \" True if this element is hovered, false otherwise\"] pub element : bool, }", "cfg": [] }, { "id": "gpui::elements::div::GroupHitboxes::get", "name": "get", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "", "documentation": "", "signature": "pub fn get (name : & SharedString, cx : & mut App) -> Option", "cfg": [], "target": "GroupHitboxes" }, { "id": "gpui::elements::div::GroupHitboxes::pop", "name": "pop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "", "documentation": "", "signature": "pub fn pop (name : & SharedString, cx : & mut App)", "cfg": [], "target": "GroupHitboxes" }, { "id": "gpui::elements::div::GroupHitboxes::push", "name": "push", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "", "documentation": "", "signature": "pub fn push (name : SharedString, hitbox_id : HitboxId, cx : & mut App)", "cfg": [], "target": "GroupHitboxes" }, { "id": "gpui::elements::div::GroupStyle", "name": "GroupStyle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "The styling information for a given group.", "documentation": "The styling information for a given group.", "signature": "# [doc = \" The styling information for a given group.\"] pub struct GroupStyle { # [doc = \" The identifier for this group.\"] pub group : SharedString, # [doc = \" The specific style refinement that this group would apply\"] # [doc = \" to its children.\"] pub style : Box, }", "cfg": [] }, { "id": "gpui::elements::div::InteractiveElement", "name": "InteractiveElement", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "A trait for elements that want to use the standard GPUI event handlers that don't require any state.", "documentation": "A trait for elements that want to use the standard GPUI event handlers that don't\nrequire any state.", "signature": "# [doc = \" A trait for elements that want to use the standard GPUI event handlers that don't\"] # [doc = \" require any state.\"] pub trait InteractiveElement : Sized { # [doc = \" Retrieve the interactivity state associated with this element\"] fn interactivity (& mut self) -> & mut Interactivity; # [doc = \" Assign this element to a group of elements that can be styled together\"] fn group (mut self, group : impl Into) -> Self { self . interactivity () . group = Some (group . into ()); self } # [doc = \" Assign this element an ID, so that it can be used with interactivity\"] fn id (mut self, id : impl Into) -> Stateful { self . interactivity () . element_id = Some (id . into ()); Stateful { element : self } } # [doc = \" Track the focus state of the given focus handle on this element.\"] # [doc = \" If the focus handle is focused by the application, this element will\"] # [doc = \" apply its focused styles.\"] fn track_focus (mut self, focus_handle : & FocusHandle) -> Self { self . interactivity () . focusable = true; self . interactivity () . tracked_focus_handle = Some (focus_handle . clone ()); self } # [doc = \" Observe this element after its subtree has prepainted, with the exact\"] # [doc = \" focus handle GPUI resolved for it during layout.\"] # [doc = \"\"] # [doc = \" The handle is `None` when the element is not focusable. This keeps\"] # [doc = \" framework integrations on the same focus authority used for event\"] # [doc = \" dispatch and platform accessibility without creating another handle.\"] # [doc = \" Bounds are displayed window coordinates after inherited visual scale,\"] # [doc = \" not layout coordinates. They are not intersected with content clips.\"] fn on_focus_resolved (mut self, listener : impl Fn (Bounds, Option<& FocusHandle>, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . focus_resolved_listener = Some (Box::new (listener)); self } # [doc = \" Reveal this element inside `scroll_handle` whenever it receives focus.\"] # [doc = \"\"] # [doc = \" `insets` reserves physical viewport edges occupied by overlays such as\"] # [doc = \" frozen columns. Revealing moves only axes that actually overflow and by\"] # [doc = \" only the distance needed to expose the focused bounds.\"] fn reveal_on_focus (mut self, scroll_handle : & ScrollHandle, insets : impl Into>,) -> Self { self . interactivity () . focus_reveal = Some ((scroll_handle . clone (), insets . into ())); self } # [doc = \" Set whether this element is a tab stop.\"] # [doc = \"\"] # [doc = \" When false, the element remains in tab-index order but cannot be reached via keyboard navigation.\"] # [doc = \" Useful for container elements: focus the container, then call `window.focus_next(cx)` to focus\"] # [doc = \" the first tab stop inside it while having the container element itself be unreachable via the keyboard.\"] # [doc = \" Should only be used with `tab_index`.\"] fn tab_stop (mut self, tab_stop : bool) -> Self { self . interactivity () . tab_stop = tab_stop; self } # [doc = \" Set index of the tab stop order, and set this node as a tab stop.\"] # [doc = \" This will default the element to being a tab stop. See [`Self::tab_stop`] for more information.\"] # [doc = \" This should only be used in conjunction with `tab_group`\"] # [doc = \" in order to not interfere with the tab index of other elements.\"] fn tab_index (mut self, index : isize) -> Self { self . interactivity () . focusable = true; self . interactivity () . tab_index = Some (index); self . interactivity () . tab_stop = true; self } # [doc = \" Designate this div as a \\\"tab group\\\". Tab groups have their own location in the tab-index order,\"] # [doc = \" but for children of the tab group, the tab index is reset to 0. This can be useful for swapping\"] # [doc = \" the order of tab stops within the group, without having to renumber all the tab stops in the whole\"] # [doc = \" application.\"] fn tab_group (mut self) -> Self { self . interactivity () . tab_group = true; if self . interactivity () . tab_index . is_none () { self . interactivity () . tab_index = Some (0); } self } # [doc = \" Set the keymap context for this element. This will be used to determine\"] # [doc = \" which action to dispatch from the keymap.\"] fn key_context (mut self, key_context : C) -> Self where C : TryInto, E : std::fmt::Display, { if let Some (key_context) = key_context . try_into () . log_err () { self . interactivity () . key_context = Some (key_context); } self } # [doc = \" Apply the given style to this element when the mouse hovers over it\"] fn hover (mut self, f : impl FnOnce (StyleRefinement) -> StyleRefinement) -> Self { debug_assert ! (self . interactivity () . hover_style . is_none (), \"hover style already set\"); self . interactivity () . hover_style = Some (Box::new (f (StyleRefinement::default ()))); self } # [doc = \" Apply the given style to this element when the mouse hovers over a group member\"] fn group_hover (mut self, group_name : impl Into, f : impl FnOnce (StyleRefinement) -> StyleRefinement,) -> Self { self . interactivity () . group_hover_style = Some (GroupStyle { group : group_name . into (), style : Box::new (f (StyleRefinement::default ())), }); self } # [doc = \" Bind the given callback to the mouse down event for the given mouse button.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_mouse_down`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to the view state from this callback.\"] fn on_mouse_down (mut self, button : MouseButton, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_down (button, listener); self } # [doc = \" Bind the given callback to the mouse down event for the given mouse button, and capture\"] # [doc = \" the pointer for this element until that button is released or cancelled.\"] # [doc = \"\"] # [doc = \" While captured, mouse move and mouse up listeners on this element continue to receive\"] # [doc = \" events when the pointer is outside its bounds. The pointer is captured before `listener`\"] # [doc = \" runs and [`Window`] releases it automatically after dispatching the mouse up event.\"] # [doc = \" Give the element an id to preserve capture when the gesture redraws the window.\"] # [doc = \"\"] # [doc = \" The fluent API equivalent of [`Interactivity::on_mouse_down_with_pointer_capture`].\"] fn on_mouse_down_with_pointer_capture (mut self, button : MouseButton, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_down_with_pointer_capture (button, listener); self } # [cfg (any (test, feature = \"test-support\"))] # [doc = \" Set a key that can be used to look up this element's bounds\"] # [doc = \" with `VisualTestContext::debug_bounds`.\"] # [doc = \" This is a noop in release builds\"] fn debug_selector (mut self, f : impl FnOnce () -> String) -> Self { self . interactivity () . debug_selector = Some (f ()); self } # [cfg (not (any (test, feature = \"test-support\")))] # [doc = \" Set a key that can be used to look up this element's bounds\"] # [doc = \" with `VisualTestContext::debug_bounds`.\"] # [doc = \" This is a noop in release builds\"] # [inline] fn debug_selector (self, _ : impl FnOnce () -> String) -> Self { self } # [doc = \" Bind the given callback to the mouse down event for any button, during the capture phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::capture_any_mouse_down`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_any_mouse_down (mut self, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_any_mouse_down (listener); self } # [doc = \" Bind the given callback to the mouse down event for any button, during the capture phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_any_mouse_down`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_any_mouse_down (mut self, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_any_mouse_down (listener); self } # [doc = \" Bind the given callback to the mouse up event for the given button, during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_mouse_up`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_mouse_up (mut self, button : MouseButton, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_up (button, listener); self } # [doc = \" Bind the given callback to the mouse up event for any button, during the capture phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::capture_any_mouse_up`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_any_mouse_up (mut self, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_any_mouse_up (listener); self } # [doc = \" Bind the given callback to the mouse pressure event, during the bubble phase\"] # [doc = \" the fluent API equivalent to [`Interactivity::on_mouse_pressure`]\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_mouse_pressure (mut self, listener : impl Fn (& MousePressureEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_pressure (listener); self } # [doc = \" Bind the given callback to the mouse pressure event, during the capture phase\"] # [doc = \" the fluent API equivalent to [`Interactivity::on_mouse_pressure`]\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_mouse_pressure (mut self, listener : impl Fn (& MousePressureEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_mouse_pressure (listener); self } # [doc = \" Bind the given callback to the mouse down event, on any button, during the capture phase,\"] # [doc = \" when the mouse is outside of the bounds of this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_mouse_down_out`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_mouse_down_out (mut self, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_down_out (listener); self } # [doc = \" Bind the given callback to the mouse up event, for the given button, during the capture phase,\"] # [doc = \" when the mouse is outside of the bounds of this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_mouse_up_out`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_mouse_up_out (mut self, button : MouseButton, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_up_out (button, listener); self } # [doc = \" Bind the given callback to the mouse move event, during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_mouse_move`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_mouse_move (mut self, listener : impl Fn (& MouseMoveEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_move (listener); self } # [doc = \" Bind the given callback to the mouse exit event, during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_mouse_exit`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_mouse_exit (mut self, listener : impl Fn (& MouseExitEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_mouse_exit (listener); self } # [doc = \" Bind the given callback to the mouse drag event of the given type. Note that this\"] # [doc = \" will be called for all move events, inside or outside of this element, as long as the\"] # [doc = \" drag was started with this element under the mouse. Useful for implementing draggable\"] # [doc = \" UIs that don't conform to a drag and drop style interaction, like resizing.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_drag_move`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_drag_move (mut self, listener : impl Fn (& DragMoveEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_drag_move (listener); self } # [doc = \" Bind the given callback to scroll wheel events during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_scroll_wheel`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_scroll_wheel (mut self, listener : impl Fn (& ScrollWheelEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_scroll_wheel (listener); self } # [doc = \" Bind the given callback to pinch gesture events during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_pinch`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_pinch (mut self, listener : impl Fn (& PinchEvent, & mut Window, & mut App) + 'static) -> Self { self . interactivity () . on_pinch (listener); self } # [doc = \" Bind the given callback to pinch gesture events during the capture phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::capture_pinch`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_pinch (mut self, listener : impl Fn (& PinchEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_pinch (listener); self } # [doc = \" Capture the given action, before normal action dispatch can fire.\"] # [doc = \" The fluent API equivalent to [`Interactivity::capture_action`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_action (mut self, listener : impl Fn (& A, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_action (listener); self } # [doc = \" Bind the given callback to an action dispatch during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_action`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] # [track_caller] fn on_action (mut self, listener : impl Fn (& A, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_action (listener); self } # [doc = \" Bind the given callback to an action dispatch, based on a dynamic action parameter\"] # [doc = \" instead of a type parameter. Useful for component libraries that want to expose\"] # [doc = \" action bindings to their users.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_boxed_action`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_boxed_action (mut self, action : & dyn Action, listener : impl Fn (& dyn Action, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_boxed_action (action, listener); self } # [doc = \" Bind the given callback to key down events during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_key_down`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_key_down (mut self, listener : impl Fn (& KeyDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_key_down (listener); self } # [doc = \" Bind the given callback to key down events during the capture phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::capture_key_down`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_key_down (mut self, listener : impl Fn (& KeyDownEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_key_down (listener); self } # [doc = \" Bind the given callback to key up events during the bubble phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_key_up`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_key_up (mut self, listener : impl Fn (& KeyUpEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_key_up (listener); self } # [doc = \" Bind the given callback to key up events during the capture phase.\"] # [doc = \" The fluent API equivalent to [`Interactivity::capture_key_up`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn capture_key_up (mut self, listener : impl Fn (& KeyUpEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . capture_key_up (listener); self } # [doc = \" Bind the given callback to modifiers changing events.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_modifiers_changed`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_modifiers_changed (mut self, listener : impl Fn (& ModifiersChangedEvent, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_modifiers_changed (listener); self } # [doc = \" Apply the given style when the given data type is dragged over this element\"] fn drag_over (mut self, f : impl 'static + Fn (StyleRefinement, & S, & mut Window, & mut App) -> StyleRefinement,) -> Self { self . interactivity () . drag_over_styles . push ((TypeId::of::< S> (), Box::new (move | currently_dragged : & dyn Any, window, cx | { f (StyleRefinement::default (), currently_dragged . downcast_ref::< S> () . expect (\"required framework invariant must hold\"), window, cx,) }),)); self } # [doc = \" Apply the given style when the given data type is dragged over this element's group\"] fn group_drag_over (mut self, group_name : impl Into, f : impl FnOnce (StyleRefinement) -> StyleRefinement,) -> Self { self . interactivity () . group_drag_over_styles . push ((TypeId::of::< S> (), GroupStyle { group : group_name . into (), style : Box::new (f (StyleRefinement::default ())), },)); self } # [doc = \" Bind the given callback to drop events of the given type, whether or not the drag started on this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_drop`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_drop (mut self, listener : impl Fn (& T, & mut Window, & mut App) + 'static,) -> Self { self . interactivity () . on_drop (listener); self } # [doc = \" Use the given predicate to determine whether or not a drop event should be dispatched to this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::can_drop`].\"] fn can_drop (mut self, predicate : impl Fn (& dyn Any, & mut Window, & mut App) -> bool + 'static,) -> Self { self . interactivity () . can_drop (predicate); self } # [doc = \" Block the mouse from all interactions with elements behind this element's hitbox. Typically\"] # [doc = \" `block_mouse_except_scroll` should be preferred.\"] # [doc = \" The fluent API equivalent to [`Interactivity::occlude_mouse`].\"] fn occlude (mut self) -> Self { self . interactivity () . occlude_mouse (); self } # [doc = \" Set the bounds of this element as a window control area for the platform window.\"] # [doc = \" The fluent API equivalent to [`Interactivity::window_control_area`].\"] fn window_control_area (mut self, area : WindowControlArea) -> Self { self . interactivity () . window_control_area (area); self } # [doc = \" Block non-scroll mouse interactions with elements behind this element's hitbox.\"] # [doc = \" The fluent API equivalent to [`Interactivity::block_mouse_except_scroll`].\"] # [doc = \"\"] # [doc = \" See [`Hitbox::is_hovered`] for details.\"] fn block_mouse_except_scroll (mut self) -> Self { self . interactivity () . block_mouse_except_scroll (); self } # [doc = \" Set the given styles to be applied when this element, specifically, is focused.\"] # [doc = \" Requires that the element is focusable. Elements can be made focusable using [`InteractiveElement::track_focus`].\"] fn focus (mut self, f : impl FnOnce (StyleRefinement) -> StyleRefinement) -> Self where Self : Sized, { self . interactivity () . focus_style = Some (Box::new (f (StyleRefinement::default ()))); self } # [doc = \" Set the given styles to be applied when this element is inside another element that is focused.\"] # [doc = \" Requires that the element is focusable. Elements can be made focusable using [`InteractiveElement::track_focus`].\"] fn in_focus (mut self, f : impl FnOnce (StyleRefinement) -> StyleRefinement) -> Self where Self : Sized, { self . interactivity () . in_focus_style = Some (Box::new (f (StyleRefinement::default ()))); self } # [doc = \" Set the given styles to be applied when this element's focus is worth\"] # [doc = \" pointing out. This is CSS's `:focus-visible` pseudo-class: it applies\"] # [doc = \" when the element is focused and a pointer press is not what put focus\"] # [doc = \" there, so a tab stop, an action, or a dialog moving focus here shows,\"] # [doc = \" while clicking the element itself does not.\"] # [doc = \" Requires that the element is focusable. Elements can be made focusable using [`InteractiveElement::track_focus`].\"] fn focus_visible (mut self, f : impl FnOnce (StyleRefinement) -> StyleRefinement) -> Self where Self : Sized, { self . interactivity () . focus_visible_style = Some (Box::new (f (StyleRefinement::default ()))); self } }", "cfg": [] }, { "id": "gpui::elements::div::InteractiveElementState", "name": "InteractiveElementState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "The per-frame state of an interactive element. Used for tracking stateful interactions like clicks and scroll offsets.", "documentation": "The per-frame state of an interactive element. Used for tracking stateful interactions like clicks\nand scroll offsets.", "signature": "# [doc = \" The per-frame state of an interactive element. Used for tracking stateful interactions like clicks\"] # [doc = \" and scroll offsets.\"] # [derive (Default)] pub struct InteractiveElementState { pub (crate) focus_handle : Option, pub (crate) clicked_state : Option>>, pub (crate) hover_state : Option>>, pub (crate) hover_listener_state : Option>>, pub (crate) pending_mouse_down : Option>>>, # [doc = \" Set to the window's [`focus_generation`](crate::Window::focus_generation)\"] # [doc = \" when an Enter/Space keydown is received while this element is focused,\"] # [doc = \" recording that we are waiting for the matching keyup to fire a keyboard\"] # [doc = \" click. On keyup the click only fires if the stored generation still\"] # [doc = \" matches the window's current one, i.e. focus never moved during the\"] # [doc = \" press (mirroring the browser clearing a control's pressed state on\"] # [doc = \" blur). `None` means no activation key is pending.\"] pub (crate) pending_keyboard_down : Option>>>, pub (crate) scroll_offset : Option>>>, ongoing_scroll : Option>>, pub (crate) active_tooltip : Option>>>, }", "cfg": [] }, { "id": "gpui::elements::div::Interactivity", "name": "Interactivity", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "The interactivity struct. Powers all of the general-purpose interactivity in the `Div` element.", "documentation": "The interactivity struct. Powers all of the general-purpose\ninteractivity in the `Div` element.", "signature": "# [doc = \" The interactivity struct. Powers all of the general-purpose\"] # [doc = \" interactivity in the `Div` element.\"] # [derive (Default)] pub struct Interactivity { # [doc = \" The element ID of the element. In id is required to support a stateful subset of the interactivity such as on_click.\"] pub element_id : Option, # [doc = \" Whether the element was clicked. This will only be present after layout.\"] pub active : Option, # [doc = \" Whether the element was hovered. This will only be present after paint if an hitbox\"] # [doc = \" was created for the interactive element.\"] pub hovered : Option, pub (crate) tooltip_id : Option, pub (crate) content_size : Size, pub (crate) key_context : Option, pub (crate) focusable : bool, pub (crate) tracked_focus_handle : Option, pub (crate) focus_resolved_listener : Option, pub (crate) focus_reveal : Option<(ScrollHandle, Edges)>, pub (crate) tracked_scroll_handle : Option, pub (crate) scroll_anchor : Option, pub (crate) scroll_offset : Option>>>, pub (crate) ongoing_scroll : Option>>, pub (crate) group : Option, # [doc = \" The base style of the element, before any modifications are applied\"] # [doc = \" by focus, active, etc.\"] pub base_style : Box, pub (crate) focus_style : Option>, pub (crate) in_focus_style : Option>, pub (crate) focus_visible_style : Option>, pub (crate) hover_style : Option>, pub (crate) group_hover_style : Option, pub (crate) active_style : Option>, pub (crate) group_active_style : Option, pub (crate) drag_over_styles : Vec<(TypeId, Box StyleRefinement>,)>, pub (crate) group_drag_over_styles : Vec<(TypeId, GroupStyle)>, pub (crate) mouse_down_listeners : Vec, pub (crate) mouse_up_listeners : Vec, pub (crate) mouse_pressure_listeners : Vec, pub (crate) mouse_move_listeners : Vec, pub (crate) mouse_exit_listeners : Vec, pub (crate) scroll_wheel_listeners : Vec, pub (crate) pinch_listeners : Vec, pub (crate) key_down_listeners : Vec, pub (crate) key_up_listeners : Vec, pub (crate) modifiers_changed_listeners : Vec, pub (crate) action_listeners : Vec<(TypeId, ActionListener)>, pub (crate) drop_listeners : Vec<(TypeId, DropListener)>, pub (crate) can_drop_predicate : Option, pub (crate) click_listeners : Vec, pub (crate) aux_click_listeners : Vec, pub (crate) drag_listener : Option, pub (crate) hover_listener : Option>, pub (crate) tooltip_builder : Option, pub (crate) tooltip_show_delay : Option, pub (crate) window_control : Option, pub (crate) hitbox_behavior : HitboxBehavior, pub (crate) tab_index : Option, pub (crate) tab_group : bool, pub (crate) tab_stop : bool, pub (crate) a11y_action_listeners : Vec<(accesskit::Action, crate::window::a11y::A11yActionListener)>, pub (crate) a11y_synthetic_children : Option>, pub (crate) report_active_descendant_focus : bool, pub (crate) override_role : Option, pub (crate) aria : AriaProperties, # [cfg (any (feature = \"inspector\", debug_assertions))] pub (crate) source_location : Option<& 'static core::panic::Location<'static>>, # [cfg (any (test, feature = \"test-support\"))] pub (crate) debug_selector : Option, }", "cfg": [] }, { "id": "gpui::elements::div::Interactivity::block_mouse_except_scroll", "name": "block_mouse_except_scroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Block non-scroll mouse interactions with elements behind this element's hitbox. The imperative API equivalent to [`InteractiveElement::block_mouse_except_scroll`].", "documentation": "Block non-scroll mouse interactions with elements behind this element's hitbox.\nThe imperative API equivalent to [`InteractiveElement::block_mouse_except_scroll`].\n\nSee [`Hitbox::is_hovered`] for details.", "signature": "pub fn block_mouse_except_scroll (& mut self)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::can_drop", "name": "can_drop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Use the given predicate to determine whether or not a drop event should be dispatched to this element. The imperative API equivalent to [`InteractiveElement::can_drop`].", "documentation": "Use the given predicate to determine whether or not a drop event should be dispatched to this element.\nThe imperative API equivalent to [`InteractiveElement::can_drop`].", "signature": "pub fn can_drop (& mut self, predicate : impl Fn (& dyn Any, & mut Window, & mut App) -> bool + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_action", "name": "capture_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to an action dispatch during the capture phase. The imperative API equivalent to [`InteractiveElement::capture_action`].", "documentation": "Bind the given callback to an action dispatch during the capture phase.\nThe imperative API equivalent to [`InteractiveElement::capture_action`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_action (& mut self, listener : impl Fn (& A, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_any_mouse_down", "name": "capture_any_mouse_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse down event for any button, during the capture phase. The imperative API equivalent of [`InteractiveElement::capture_any_mouse_down`].", "documentation": "Bind the given callback to the mouse down event for any button, during the capture phase.\nThe imperative API equivalent of [`InteractiveElement::capture_any_mouse_down`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_any_mouse_down (& mut self, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_any_mouse_up", "name": "capture_any_mouse_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse up event for any button, during the capture phase. The imperative API equivalent to [`InteractiveElement::capture_any_mouse_up`].", "documentation": "Bind the given callback to the mouse up event for any button, during the capture phase.\nThe imperative API equivalent to [`InteractiveElement::capture_any_mouse_up`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_any_mouse_up (& mut self, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_key_down", "name": "capture_key_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to key down events during the capture phase. The imperative API equivalent to [`InteractiveElement::capture_key_down`].", "documentation": "Bind the given callback to key down events during the capture phase.\nThe imperative API equivalent to [`InteractiveElement::capture_key_down`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_key_down (& mut self, listener : impl Fn (& KeyDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_key_up", "name": "capture_key_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to key up events during the capture phase. The imperative API equivalent to [`InteractiveElement::on_key_up`].", "documentation": "Bind the given callback to key up events during the capture phase.\nThe imperative API equivalent to [`InteractiveElement::on_key_up`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_key_up (& mut self, listener : impl Fn (& KeyUpEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_mouse_pressure", "name": "capture_mouse_pressure", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse pressure event, during the capture phase the imperative API equivalent to [`InteractiveElement::on_mouse_pressure`].", "documentation": "Bind the given callback to the mouse pressure event, during the capture phase\nthe imperative API equivalent to [`InteractiveElement::on_mouse_pressure`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_mouse_pressure (& mut self, listener : impl Fn (& MousePressureEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::capture_pinch", "name": "capture_pinch", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to pinch gesture events during the capture phase.", "documentation": "Bind the given callback to pinch gesture events during the capture phase.\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn capture_pinch (& mut self, listener : impl Fn (& PinchEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::compute_style", "name": "compute_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Compute the visual style for this element, based on the current bounds and the element's state.", "documentation": "Compute the visual style for this element, based on the current bounds and the element's state.", "signature": "pub fn compute_style (& self, global_id : Option<& GlobalElementId>, hitbox : Option<& Hitbox>, window : & mut Window, cx : & mut App,) -> Style", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::external_drag_payload", "name": "external_drag_payload", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Registers a callback resolving a payload to offer the platform if a drag started by this element leaves the window. It is invoked at most once per drag gesture, when the pointer exits the viewport. Must be called after [`Self::on_drag`], with the same dragged value type `T`.", "documentation": "Registers a callback resolving a payload to offer the platform if a drag started by this\nelement leaves the window. It is invoked at most once per drag gesture, when the pointer\nexits the viewport. Must be called after [`Self::on_drag`], with the same dragged value\ntype `T`.", "signature": "pub fn external_drag_payload (& mut self, resolver : impl Fn (& T, & mut Window, & mut App) -> Option + 'static,) where Self : Sized, T : 'static,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::focus_handle", "name": "focus_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Returns the focus handle GPUI resolved for this element in the current draw.", "documentation": "Returns the focus handle GPUI resolved for this element in the current\ndraw.\n\nA handle passed to [`InteractiveElement::track_focus`] is available as\nsoon as it is attached. For an implicitly focusable element, such as\none configured with [`InteractiveElement::tab_index`], the generated\nhandle becomes available after the element requests layout.", "signature": "pub fn focus_handle (& self) -> Option<& FocusHandle>", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::hoverable_tooltip", "name": "hoverable_tooltip", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Use the given callback to construct a new tooltip view when the mouse hovers over this element. The tooltip itself is also hoverable and won't disappear when the user moves the mouse into the tooltip. The imperative API equivalent to [`StatefulInteractiveElement::hoverable_tooltip`].", "documentation": "Use the given callback to construct a new tooltip view when the mouse hovers over this element.\nThe tooltip itself is also hoverable and won't disappear when the user moves the mouse into\nthe tooltip. The imperative API equivalent to [`StatefulInteractiveElement::hoverable_tooltip`].", "signature": "pub fn hoverable_tooltip (& mut self, build_tooltip : impl Fn (& mut Window, & mut App) -> AnyView + 'static,) where Self : Sized,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "summary": "Create an `Interactivity`, capturing the caller location in debug mode.", "declarations": [ { "source": "crates/gpui/src/elements/div.rs", "documentation": "Create an `Interactivity`, capturing the caller location in debug mode.", "signature": "pub fn new () -> Interactivity", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ], "target": "Interactivity" }, { "source": "crates/gpui/src/elements/div.rs", "documentation": "Create an `Interactivity`, capturing the caller location in debug mode.", "signature": "pub fn new () -> Interactivity", "cfg": [ "cfg (not (any (feature = \"inspector\", debug_assertions)))" ], "target": "Interactivity" } ] }, { "id": "gpui::elements::div::Interactivity::occlude_mouse", "name": "occlude_mouse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Block the mouse from all interactions with elements behind this element's hitbox. Typically `block_mouse_except_scroll` should be preferred.", "documentation": "Block the mouse from all interactions with elements behind this element's hitbox. Typically\n`block_mouse_except_scroll` should be preferred.\n\nThe imperative API equivalent to [`InteractiveElement::occlude`]", "signature": "pub fn occlude_mouse (& mut self)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_action", "name": "on_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to an action dispatch during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_action`].", "documentation": "Bind the given callback to an action dispatch during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_action`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_action (& mut self, listener : impl Fn (& A, & mut Window, & mut App) + 'static)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_any_mouse_down", "name": "on_any_mouse_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse down event for any button, during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_any_mouse_down`].", "documentation": "Bind the given callback to the mouse down event for any button, during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_any_mouse_down`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_any_mouse_down (& mut self, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_any_mouse_up", "name": "on_any_mouse_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse up event for any button, during the bubble phase. The imperative API equivalent to [`Interactivity::on_any_mouse_up`].", "documentation": "Bind the given callback to the mouse up event for any button, during the bubble phase.\nThe imperative API equivalent to [`Interactivity::on_any_mouse_up`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_any_mouse_up (& mut self, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_aux_click", "name": "on_aux_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to non-primary click events of this element. The imperative API equivalent to [`StatefulInteractiveElement::on_aux_click`].", "documentation": "Bind the given callback to non-primary click events of this element.\nThe imperative API equivalent to [`StatefulInteractiveElement::on_aux_click`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_aux_click (& mut self, listener : impl Fn (& ClickEvent, & mut Window, & mut App) + 'static) where Self : Sized,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_boxed_action", "name": "on_boxed_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to an action dispatch, based on a dynamic action parameter instead of a type parameter. Useful for component libraries that want to expose action bindings to their users. The imperative API equivalent to [`InteractiveElement::on_boxed_action`].", "documentation": "Bind the given callback to an action dispatch, based on a dynamic action parameter\ninstead of a type parameter. Useful for component libraries that want to expose\naction bindings to their users.\nThe imperative API equivalent to [`InteractiveElement::on_boxed_action`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_boxed_action (& mut self, action : & dyn Action, listener : impl Fn (& dyn Action, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_click", "name": "on_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to click events of this element. The imperative API equivalent to [`StatefulInteractiveElement::on_click`].", "documentation": "Bind the given callback to click events of this element.\nThe imperative API equivalent to [`StatefulInteractiveElement::on_click`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_click (& mut self, listener : impl Fn (& ClickEvent, & mut Window, & mut App) + 'static) where Self : Sized,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_drag", "name": "on_drag", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "On drag initiation, this callback will be used to create a new view to render the dragged value for a drag and drop operation. This API should also be used as the equivalent of 'on drag start' with the [`Self::on_drag_move`] API. The imperative API equivalent to [`StatefulInteractiveElement::on_drag`].", "documentation": "On drag initiation, this callback will be used to create a new view to render the dragged value for a\ndrag and drop operation. This API should also be used as the equivalent of 'on drag start' with\nthe [`Self::on_drag_move`] API.\nThe imperative API equivalent to [`StatefulInteractiveElement::on_drag`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_drag (& mut self, value : T, constructor : impl Fn (& T, Point, & mut Window, & mut App) -> Entity + 'static,) where Self : Sized, T : 'static, W : 'static + Render,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_drag_move", "name": "on_drag_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse drag event of the given type. Note that this will be called for all move events, inside or outside of this element, as long as the drag was started with this element under the mouse. Useful for implementing draggable UIs that don't conform to a drag and drop style interaction, like resizing. The imperative API equivalent to [`InteractiveElement::on_drag_move`].", "documentation": "Bind the given callback to the mouse drag event of the given type. Note that this\nwill be called for all move events, inside or outside of this element, as long as the\ndrag was started with this element under the mouse. Useful for implementing draggable\nUIs that don't conform to a drag and drop style interaction, like resizing.\nThe imperative API equivalent to [`InteractiveElement::on_drag_move`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_drag_move (& mut self, listener : impl Fn (& DragMoveEvent, & mut Window, & mut App) + 'static,) where T : 'static,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_drop", "name": "on_drop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to drop events of the given type, whether or not the drag started on this element. The imperative API equivalent to [`InteractiveElement::on_drop`].", "documentation": "Bind the given callback to drop events of the given type, whether or not the drag started on this element.\nThe imperative API equivalent to [`InteractiveElement::on_drop`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_drop (& mut self, listener : impl Fn (& T, & mut Window, & mut App) + 'static)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_hover", "name": "on_hover", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback on the hover start and end events of this element. Note that the boolean passed to the callback is true when the hover starts and false when it ends. The imperative API equivalent to [`StatefulInteractiveElement::on_hover`].", "documentation": "Bind the given callback on the hover start and end events of this element. Note that the boolean\npassed to the callback is true when the hover starts and false when it ends.\nThe imperative API equivalent to [`StatefulInteractiveElement::on_hover`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_hover (& mut self, listener : impl Fn (& bool, & mut Window, & mut App) + 'static) where Self : Sized,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_key_down", "name": "on_key_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to key down events during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_key_down`].", "documentation": "Bind the given callback to key down events during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_key_down`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_key_down (& mut self, listener : impl Fn (& KeyDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_key_up", "name": "on_key_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to key up events during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_key_up`].", "documentation": "Bind the given callback to key up events during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_key_up`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_key_up (& mut self, listener : impl Fn (& KeyUpEvent, & mut Window, & mut App) + 'static)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_modifiers_changed", "name": "on_modifiers_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to modifiers changing events. The imperative API equivalent to [`InteractiveElement::on_modifiers_changed`].", "documentation": "Bind the given callback to modifiers changing events.\nThe imperative API equivalent to [`InteractiveElement::on_modifiers_changed`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_modifiers_changed (& mut self, listener : impl Fn (& ModifiersChangedEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_down", "name": "on_mouse_down", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse down event for the given mouse button, during the bubble phase. The imperative API equivalent of [`InteractiveElement::on_mouse_down`].", "documentation": "Bind the given callback to the mouse down event for the given mouse button, during the bubble phase.\nThe imperative API equivalent of [`InteractiveElement::on_mouse_down`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to the view state from this callback.", "signature": "pub fn on_mouse_down (& mut self, button : MouseButton, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_down_out", "name": "on_mouse_down_out", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse down event, on any button, during the capture phase, when the mouse is outside of the bounds of this element. The imperative API equivalent to [`InteractiveElement::on_mouse_down_out`].", "documentation": "Bind the given callback to the mouse down event, on any button, during the capture phase,\nwhen the mouse is outside of the bounds of this element.\nThe imperative API equivalent to [`InteractiveElement::on_mouse_down_out`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_mouse_down_out (& mut self, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_down_with_pointer_capture", "name": "on_mouse_down_with_pointer_capture", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse down event for the given mouse button, and capture the pointer for this element until that button is released or cancelled.", "documentation": "Bind the given callback to the mouse down event for the given mouse button, and capture\nthe pointer for this element until that button is released or cancelled.\n\nWhile captured, mouse move and mouse up listeners on this element continue to receive\nevents when the pointer is outside its bounds. The pointer is captured before `listener`\nruns and [`Window`] releases it automatically after dispatching the mouse up event.\nGive the element an id to preserve capture when the gesture redraws the window.\n\nThe imperative API equivalent of\n[`InteractiveElement::on_mouse_down_with_pointer_capture`].", "signature": "pub fn on_mouse_down_with_pointer_capture (& mut self, button : MouseButton, listener : impl Fn (& MouseDownEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_exit", "name": "on_mouse_exit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse exit event, during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_mouse_exit`].", "documentation": "Bind the given callback to the mouse exit event, during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_mouse_exit`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_mouse_exit (& mut self, listener : impl Fn (& MouseExitEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_move", "name": "on_mouse_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse move event, during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_mouse_move`].", "documentation": "Bind the given callback to the mouse move event, during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_mouse_move`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_mouse_move (& mut self, listener : impl Fn (& MouseMoveEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_pressure", "name": "on_mouse_pressure", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse pressure event, during the bubble phase the imperative API equivalent to [`InteractiveElement::on_mouse_pressure`].", "documentation": "Bind the given callback to the mouse pressure event, during the bubble phase\nthe imperative API equivalent to [`InteractiveElement::on_mouse_pressure`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_mouse_pressure (& mut self, listener : impl Fn (& MousePressureEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_up", "name": "on_mouse_up", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse up event for the given button, during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_mouse_up`].", "documentation": "Bind the given callback to the mouse up event for the given button, during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_mouse_up`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_mouse_up (& mut self, button : MouseButton, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_mouse_up_out", "name": "on_mouse_up_out", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to the mouse up event, for the given button, during the capture phase, when the mouse is outside of the bounds of this element. The imperative API equivalent to [`InteractiveElement::on_mouse_up_out`].", "documentation": "Bind the given callback to the mouse up event, for the given button, during the capture phase,\nwhen the mouse is outside of the bounds of this element.\nThe imperative API equivalent to [`InteractiveElement::on_mouse_up_out`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_mouse_up_out (& mut self, button : MouseButton, listener : impl Fn (& MouseUpEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_pinch", "name": "on_pinch", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to pinch gesture events during the bubble phase.", "documentation": "Bind the given callback to pinch gesture events during the bubble phase.\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_pinch (& mut self, listener : impl Fn (& PinchEvent, & mut Window, & mut App) + 'static)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::on_scroll_wheel", "name": "on_scroll_wheel", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Bind the given callback to scroll wheel events during the bubble phase. The imperative API equivalent to [`InteractiveElement::on_scroll_wheel`].", "documentation": "Bind the given callback to scroll wheel events during the bubble phase.\nThe imperative API equivalent to [`InteractiveElement::on_scroll_wheel`].\n\nSee [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.", "signature": "pub fn on_scroll_wheel (& mut self, listener : impl Fn (& ScrollWheelEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::paint", "name": "paint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Paint this element according to this interactivity state's configured styles and bind the element's mouse and keyboard events.", "documentation": "Paint this element according to this interactivity state's configured styles\nand bind the element's mouse and keyboard events.\n\ncontent_size is the size of the content of the element, which may be larger than the\nelement's bounds if the element is scrollable.\n\nthe final computed style will be passed to the provided function, along\nwith the current scroll offset", "signature": "pub fn paint (& mut self, global_id : Option<& GlobalElementId>, _inspector_id : Option<& InspectorElementId>, bounds : Bounds, hitbox : Option<& Hitbox>, window : & mut Window, cx : & mut App, f : impl FnOnce (& Style, & mut Window, & mut App),)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::prepaint", "name": "prepaint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Commit the bounds of this element according to this interactivity state's configured styles.", "documentation": "Commit the bounds of this element according to this interactivity state's configured styles.", "signature": "pub fn prepaint (& mut self, global_id : Option<& GlobalElementId>, _inspector_id : Option<& InspectorElementId>, bounds : Bounds, content_size : Size, window : & mut Window, cx : & mut App, f : impl FnOnce (& Style, Point, Option, & mut Window, & mut App) -> R,) -> R", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::request_layout", "name": "request_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Layout this element according to this interactivity state's configured styles", "documentation": "Layout this element according to this interactivity state's configured styles", "signature": "pub fn request_layout (& mut self, global_id : Option<& GlobalElementId>, _inspector_id : Option<& InspectorElementId>, window : & mut Window, cx : & mut App, f : impl FnOnce (Style, & mut Window, & mut App) -> LayoutId,) -> LayoutId", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::source_location", "name": "source_location", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Gets the source location of construction. Returns `None` when not in debug mode.", "documentation": "Gets the source location of construction. Returns `None` when not in debug mode.", "signature": "pub fn source_location (& self) -> Option<& 'static std::panic::Location<'static>>", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::tooltip", "name": "tooltip", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Use the given callback to construct a new tooltip view when the mouse hovers over this element. The imperative API equivalent to [`StatefulInteractiveElement::tooltip`].", "documentation": "Use the given callback to construct a new tooltip view when the mouse hovers over this element.\nThe imperative API equivalent to [`StatefulInteractiveElement::tooltip`].", "signature": "pub fn tooltip (& mut self, build_tooltip : impl Fn (& mut Window, & mut App) -> AnyView + 'static) where Self : Sized,", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::tooltip_show_delay", "name": "tooltip_show_delay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Set the delay before this element's tooltip is shown. The imperative API equivalent to [`StatefulInteractiveElement::tooltip_show_delay`].", "documentation": "Set the delay before this element's tooltip is shown.\nThe imperative API equivalent to [`StatefulInteractiveElement::tooltip_show_delay`].", "signature": "pub fn tooltip_show_delay (& mut self, delay : Duration)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::Interactivity::window_control_area", "name": "window_control_area", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Set the bounds of this element as a window control area for the platform window. The imperative API equivalent to [`InteractiveElement::window_control_area`]", "documentation": "Set the bounds of this element as a window control area for the platform window.\nThe imperative API equivalent to [`InteractiveElement::window_control_area`]", "signature": "pub fn window_control_area (& mut self, area : WindowControlArea)", "cfg": [], "target": "Interactivity" }, { "id": "gpui::elements::div::ScrollAnchor", "name": "ScrollAnchor", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Represents an element that can be scrolled *to* in its parent element. Contrary to `ScrollHandle::scroll_to_active_item`, an anchored element does not have to be an immediate child of the parent.", "documentation": "Represents an element that can be scrolled *to* in its parent element.\nContrary to `ScrollHandle::scroll_to_active_item`, an anchored element does\nnot have to be an immediate child of the parent.", "signature": "# [doc = \" Represents an element that can be scrolled *to* in its parent element.\"] # [doc = \" Contrary to `ScrollHandle::scroll_to_active_item`, an anchored element does\"] # [doc = \" not have to be an immediate child of the parent.\"] # [derive (Clone)] pub struct ScrollAnchor { handle : ScrollHandle, last_origin : Rc>>, }", "cfg": [] }, { "id": "gpui::elements::div::ScrollAnchor::for_handle", "name": "for_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Creates a [ScrollAnchor] associated with a given [ScrollHandle].", "documentation": "Creates a [ScrollAnchor] associated with a given [ScrollHandle].", "signature": "pub fn for_handle (handle : ScrollHandle) -> Self", "cfg": [], "target": "ScrollAnchor" }, { "id": "gpui::elements::div::ScrollAnchor::scroll_to", "name": "scroll_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Request scroll to this item on the next frame.", "documentation": "Request scroll to this item on the next frame.", "signature": "pub fn scroll_to (& self, window : & mut Window, _cx : & mut App)", "cfg": [], "target": "ScrollAnchor" }, { "id": "gpui::elements::div::ScrollHandle", "name": "ScrollHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "A handle to the scrollable aspects of an element. Used for accessing scroll state, like the current scroll offset, and for mutating the scroll state, like scrolling to a specific child.", "documentation": "A handle to the scrollable aspects of an element.\nUsed for accessing scroll state, like the current scroll offset,\nand for mutating the scroll state, like scrolling to a specific child.", "signature": "# [doc = \" A handle to the scrollable aspects of an element.\"] # [doc = \" Used for accessing scroll state, like the current scroll offset,\"] # [doc = \" and for mutating the scroll state, like scrolling to a specific child.\"] # [derive (Clone, Debug)] pub struct ScrollHandle (Rc>);", "cfg": [] }, { "id": "gpui::elements::div::ScrollHandle::bottom_item", "name": "bottom_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the bottom child that's scrolled into view.", "documentation": "Get the bottom child that's scrolled into view.", "signature": "pub fn bottom_item (& self) -> usize", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::bounds", "name": "bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Return the bounds into which this child is painted", "documentation": "Return the bounds into which this child is painted", "signature": "pub fn bounds (& self) -> Bounds", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::bounds_for_item", "name": "bounds_for_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the bounds for a specific child.", "documentation": "Get the bounds for a specific child.", "signature": "pub fn bounds_for_item (& self, ix : usize) -> Option>", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::children_count", "name": "children_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the count of children for scrollable item.", "documentation": "Get the count of children for scrollable item.", "signature": "pub fn children_count (& self) -> usize", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::logical_scroll_bottom", "name": "logical_scroll_bottom", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the logical scroll bottom, based on a child index and a pixel offset.", "documentation": "Get the logical scroll bottom, based on a child index and a pixel offset.", "signature": "pub fn logical_scroll_bottom (& self) -> (usize, Pixels)", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::logical_scroll_top", "name": "logical_scroll_top", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the logical scroll top, based on a child index and a pixel offset.", "documentation": "Get the logical scroll top, based on a child index and a pixel offset.", "signature": "pub fn logical_scroll_top (& self) -> (usize, Pixels)", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::max_offset", "name": "max_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the maximum scroll offset.", "documentation": "Get the maximum scroll offset.", "signature": "pub fn max_offset (& self) -> Point", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Construct a new scroll handle.", "documentation": "Construct a new scroll handle.", "signature": "pub fn new () -> Self", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::offset", "name": "offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the current scroll offset.", "documentation": "Get the current scroll offset.", "signature": "pub fn offset (& self) -> Point", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::reveal_bounds", "name": "reveal_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Moves the minimum distance needed to reveal `bounds` inside this handle's viewport, after reserving physical `insets` for content drawn over the viewport.", "documentation": "Moves the minimum distance needed to reveal `bounds` inside this\nhandle's viewport, after reserving physical `insets` for content drawn\nover the viewport.\n\nBounds are the element's current painted bounds, including the current\nscroll offset. Returns whether the offset changed.", "signature": "pub fn reveal_bounds (& self, bounds : Bounds, insets : impl Into>) -> bool", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::scroll_to_bottom", "name": "scroll_to_bottom", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Scrolls to the bottom.", "documentation": "Scrolls to the bottom.", "signature": "pub fn scroll_to_bottom (& self)", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::scroll_to_item", "name": "scroll_to_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Update the scroll handle's active item for scrolling to in prepaint.", "documentation": "Update the scroll handle's active item for scrolling to in prepaint.", "signature": "pub fn scroll_to_item (& self, ix : usize)", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::scroll_to_top_of_item", "name": "scroll_to_top_of_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Update the scroll handle's active item for scrolling to in prepaint. This scrolls the minimal amount to ensure that the child is the first visible element.", "documentation": "Update the scroll handle's active item for scrolling to in prepaint.\nThis scrolls the minimal amount to ensure that the child is the first visible element.", "signature": "pub fn scroll_to_top_of_item (& self, ix : usize)", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::set_measured_for_test", "name": "set_measured_for_test", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Pretend a frame has been laid out, so a test can ask a handle where it is without building a window to scroll.", "documentation": "Pretend a frame has been laid out, so a test can ask a handle where it\nis without building a window to scroll.", "signature": "pub fn set_measured_for_test (& self, bounds : Bounds, max_offset : Point)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::set_offset", "name": "set_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Set the offset explicitly. The offset is the distance from the top left of the parent container to the top left of the first child. As you scroll further down the offset becomes more negative.", "documentation": "Set the offset explicitly. The offset is the distance from the top left of the\nparent container to the top left of the first child.\nAs you scroll further down the offset becomes more negative.", "signature": "pub fn set_offset (& self, mut position : Point)", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::ScrollHandle::top_item", "name": "top_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Get the top child that's scrolled into view.", "documentation": "Get the top child that's scrolled into view.", "signature": "pub fn top_item (& self) -> usize", "cfg": [], "target": "ScrollHandle" }, { "id": "gpui::elements::div::Stateful", "name": "Stateful", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "A wrapper around an element that can store state, produced after assigning an ElementId.", "documentation": "A wrapper around an element that can store state, produced after assigning an ElementId.", "signature": "# [doc = \" A wrapper around an element that can store state, produced after assigning an ElementId.\"] pub struct Stateful { pub (crate) element : E, }", "cfg": [] }, { "id": "gpui::elements::div::StatefulInteractiveElement", "name": "StatefulInteractiveElement", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "A trait for elements that want to use the standard GPUI interactivity features that require state.", "documentation": "A trait for elements that want to use the standard GPUI interactivity features\nthat require state.", "signature": "# [doc = \" A trait for elements that want to use the standard GPUI interactivity features\"] # [doc = \" that require state.\"] pub trait StatefulInteractiveElement : InteractiveElement { # [doc = \" Set the accessible role for this element.\"] # [doc = \"\"] # [doc = \" See the [accessibility guide](crate::_accessibility) for an overview.\"] fn role (mut self, role : accesskit::Role) -> Self { debug_assert ! (role != accesskit::Role::GenericContainer, \"GenericContainer is filtered out of the a11y tree and has no effect\"); self . interactivity () . override_role = Some (role); self } # [doc = \" Set the accessible label for this element.\"] fn aria_label (mut self, label : impl Into) -> Self { self . interactivity () . aria . label = Some (label . into ()); self } # [doc = \" Set the accessible description for this element. Unlike the label (which\"] # [doc = \" names the element), the description provides supplementary information\"] # [doc = \" that assistive technology announces after the name, role, and value -\"] # [doc = \" for example a settings subtitle or a hint.\"] fn aria_description (mut self, description : impl Into) -> Self { self . interactivity () . aria . description = Some (description . into ()); self } # [doc = \" Name this element with another role-bearing element in the same\"] # [doc = \" window. The target id must resolve uniquely for the active frame.\"] fn aria_labelled_by (mut self, target : impl Into) -> Self { self . interactivity () . aria . relationships . push (crate::AccessibilityRelationship::LabelledBy (target . into ())); self } # [doc = \" Describe this element with another role-bearing element in the same\"] # [doc = \" window. The target id must resolve uniquely for the active frame.\"] fn aria_described_by (mut self, target : impl Into) -> Self { self . interactivity () . aria . relationships . push (crate::AccessibilityRelationship::DescribedBy (target . into ())); self } # [doc = \" Use this element as a label for another role-bearing element in the\"] # [doc = \" same window. This inverse form lets a label declare the relationship\"] # [doc = \" without rebuilding the control it names.\"] fn aria_labels (mut self, target : impl Into) -> Self { self . interactivity () . aria . relationships . push (crate::AccessibilityRelationship::Labels (target . into ())); self } # [doc = \" Use this element as a description for another role-bearing element in\"] # [doc = \" the same window. This inverse form supports deferred tooltips and help\"] # [doc = \" text rendered outside the control's element subtree.\"] fn aria_describes (mut self, target : impl Into) -> Self { self . interactivity () . aria . relationships . push (crate::AccessibilityRelationship::Describes (target . into ())); self } # [doc = \" Set the keyboard shortcut(s) that activate this element, announced by\"] # [doc = \" assistive technology (maps to AccessKit's `keyboard_shortcut`).\"] # [doc = \"\"] # [doc = \" Note that this does not create a keymap. It simply instructs assistive\"] # [doc = \" technology what the keymap is.\"] fn aria_keyshortcuts (mut self, keyshortcuts : impl Into) -> Self { self . interactivity () . aria . keyshortcuts = Some (keyshortcuts . into ()); self } # [doc = \" Report this element as the focused node in the accessibility tree,\"] # [doc = \" overriding the element that holds real keyboard focus — but only while\"] # [doc = \" one of its ancestors actually holds focus.\"] # [doc = \"\"] # [doc = \" This implements the `aria-activedescendant` pattern for composite\"] # [doc = \" widgets that keep keyboard focus on a container (e.g. a menu or\"] # [doc = \" listbox) while a child is \\\"selected\\\": set this on the selected child so\"] # [doc = \" assistive technology announces and highlights it as focused.\"] # [doc = \"\"] # [doc = \" The element must also have a [`role`][Self::role] (and an id) so it\"] # [doc = \" produces an accessibility node. Unlike the web's container-side\"] # [doc = \" `aria-activedescendant`, this is set on the descendant; GPUI honors it\"] # [doc = \" only when a focused ancestor is present in the tree, so it is safe to\"] # [doc = \" set unconditionally on the selected child — if the container isn't\"] # [doc = \" focused, the claim is ignored.\"] fn aria_active_descendant (mut self) -> Self { self . interactivity () . report_active_descendant_focus = true; self } # [doc = \" Report this element as the active descendant of a focused role-bearing\"] # [doc = \" element elsewhere in the same window.\"] # [doc = \"\"] # [doc = \" This is the deferred-overlay form of [`Self::aria_active_descendant`].\"] # [doc = \" The referenced id must resolve uniquely, and must own GPUI keyboard\"] # [doc = \" focus in the current frame; otherwise the claim is ignored. It does not\"] # [doc = \" reparent either accessibility node.\"] fn aria_active_descendant_of (mut self, owner : impl Into) -> Self { self . interactivity () . aria . relationships . push (crate::AccessibilityRelationship::ActiveDescendantOf (owner . into ()),); self } # [doc = \" Contribute synthetic accessibility nodes — nodes that don't correspond\"] # [doc = \" to any element — as children of this element's a11y node. For example,\"] # [doc = \" text runs describing an editor's text content.\"] # [doc = \"\"] # [doc = \" The closure is called after this element is prepainted, and only if it\"] # [doc = \" contributed a node to the accessibility tree (i.e. it has an id and a\"] # [doc = \" [`role`][StatefulInteractiveElement::role]).\"] # [doc = \"\"] # [doc = \" See [`Element::a11y_synthetic_children`] for details.\"] fn a11y_synthetic_children (mut self, f : impl FnOnce (& mut crate::A11ySubtreeBuilder) + 'static,) -> Self { self . interactivity () . a11y_synthetic_children = Some (Box::new (f)); self } # [doc = \" Set the selected state for this element.\"] fn aria_selected (mut self, selected : bool) -> Self { self . interactivity () . aria . selected = Some (selected); self } # [doc = \" Set the expanded state for this element.\"] fn aria_expanded (mut self, expanded : bool) -> Self { self . interactivity () . aria . expanded = Some (expanded); self } # [doc = \" Set whether this element is unavailable for interaction.\"] fn aria_disabled (mut self, disabled : bool) -> Self { self . interactivity () . aria . disabled = disabled; self } # [doc = \" Set whether this element exposes text that cannot be edited.\"] fn aria_read_only (mut self, read_only : bool) -> Self { self . interactivity () . aria . read_only = read_only; self } # [doc = \" Set whether this element is a modal surface.\"] fn aria_modal (mut self, modal : bool) -> Self { self . interactivity () . aria . modal = modal; self } # [doc = \" Set whether this element's value is invalid.\"] fn aria_invalid (mut self, invalid : bool) -> Self { self . interactivity () . aria . invalid = invalid; self } # [doc = \" Set whether this element requires a value.\"] fn aria_required (mut self, required : bool) -> Self { self . interactivity () . aria . required = required; self } # [doc = \" Set whether this element is currently being updated.\"] fn aria_busy (mut self, busy : bool) -> Self { self . interactivity () . aria . busy = busy; self } # [doc = \" Set how updates to this element should be announced.\"] fn aria_live (mut self, politeness : accesskit::Live) -> Self { self . interactivity () . aria . live = Some (politeness); self } # [doc = \" Set whether a live-region update should announce the whole region.\"] fn aria_live_atomic (mut self, atomic : bool) -> Self { self . interactivity () . aria . live_atomic = atomic; self } # [doc = \" Set the toggled state for this element.\"] fn aria_toggled (mut self, toggled : accesskit::Toggled) -> Self { self . interactivity () . aria . toggled = Some (toggled); self } # [doc = \" Set the numeric value for this element.\"] fn aria_numeric_value (mut self, value : f64) -> Self { self . interactivity () . aria . numeric_value = Some (value); self } # [doc = \" Set the step by which assistive technology should expect the numeric\"] # [doc = \" value of this element to change (e.g. when incrementing a spin button).\"] fn aria_numeric_value_step (mut self, step : f64) -> Self { self . interactivity () . aria . numeric_value_step = Some (step); self } # [doc = \" Set the string value of this element, e.g. the text content of a simple\"] # [doc = \" text input.\"] fn aria_value (mut self, value : impl Into) -> Self { self . interactivity () . aria . value = Some (value . into ()); self } # [doc = \" Set the placeholder text reported to assistive technology for this\"] # [doc = \" element, shown when a text input is empty.\"] fn aria_placeholder (mut self, placeholder : impl Into) -> Self { self . interactivity () . aria . placeholder = Some (placeholder . into ()); self } # [doc = \" Set the minimum numeric value for this element.\"] fn aria_min_numeric_value (mut self, value : f64) -> Self { self . interactivity () . aria . min_numeric_value = Some (value); self } # [doc = \" Set the maximum numeric value for this element.\"] fn aria_max_numeric_value (mut self, value : f64) -> Self { self . interactivity () . aria . max_numeric_value = Some (value); self } # [doc = \" Set the orientation of this element.\"] fn aria_orientation (mut self, orientation : accesskit::Orientation) -> Self { self . interactivity () . aria . orientation = Some (orientation); self } # [doc = \" Set the heading level of this element.\"] fn aria_level (mut self, level : usize) -> Self { self . interactivity () . aria . level = Some (level); self } # [doc = \" Set the position in set of this element.\"] fn aria_position_in_set (mut self, position : usize) -> Self { self . interactivity () . aria . position_in_set = Some (position); self } # [doc = \" Set the size of set for this element.\"] fn aria_size_of_set (mut self, size : usize) -> Self { self . interactivity () . aria . size_of_set = Some (size); self } # [doc = \" Set the row index for this element.\"] fn aria_row_index (mut self, index : usize) -> Self { self . interactivity () . aria . row_index = Some (index); self } # [doc = \" Set the column index for this element.\"] fn aria_column_index (mut self, index : usize) -> Self { self . interactivity () . aria . column_index = Some (index); self } # [doc = \" Set the row count for this element.\"] fn aria_row_count (mut self, count : usize) -> Self { self . interactivity () . aria . row_count = Some (count); self } # [doc = \" Set the column count for this element.\"] fn aria_column_count (mut self, count : usize) -> Self { self . interactivity () . aria . column_count = Some (count); self } # [doc = \" Register a handler for an accessibility action on this element.\"] # [doc = \" The handler is called when a screen reader requests the given action.\"] # [doc = \"\"] # [doc = \" See the [accessibility guide](crate::_accessibility) for an overview.\"] fn on_a11y_action (mut self, action : accesskit::Action, listener : impl FnMut (Option<& accesskit::ActionData>, & mut crate::Window, & mut crate::App) + 'static,) -> Self { self . interactivity () . a11y_action_listeners . push ((action, Box::new (listener))); self } # [doc = \" Set this element to focusable.\"] fn focusable (mut self) -> Self { self . interactivity () . focusable = true; self } # [doc = \" Set the overflow x and y to scroll.\"] fn overflow_scroll (mut self) -> Self { self . interactivity () . base_style . overflow . x = Some (Overflow::Scroll); self . interactivity () . base_style . overflow . y = Some (Overflow::Scroll); self } # [doc = \" Set the overflow x to scroll.\"] fn overflow_x_scroll (mut self) -> Self { self . interactivity () . base_style . overflow . x = Some (Overflow::Scroll); self } # [doc = \" Set the overflow y to scroll.\"] fn overflow_y_scroll (mut self) -> Self { self . interactivity () . base_style . overflow . y = Some (Overflow::Scroll); self } # [doc = \" Restrict scrolling of this element to the axis of the input gesture.\"] # [doc = \"\"] # [doc = \" See [`Style::restrict_scroll_to_axis`](crate::Style::restrict_scroll_to_axis) for details.\"] fn restrict_scroll_to_axis (mut self) -> Self { self . interactivity () . base_style . restrict_scroll_to_axis = Some (true); self } # [doc = \" Track the scroll state of this element with the given handle.\"] fn track_scroll (mut self, scroll_handle : & ScrollHandle) -> Self { self . interactivity () . tracked_scroll_handle = Some (scroll_handle . clone ()); self } # [doc = \" Track the scroll state of this element with the given handle.\"] fn anchor_scroll (mut self, scroll_anchor : Option) -> Self { self . interactivity () . scroll_anchor = scroll_anchor; self } # [doc = \" Set the given styles to be applied when this element is active.\"] fn active (mut self, f : impl FnOnce (StyleRefinement) -> StyleRefinement) -> Self where Self : Sized, { self . interactivity () . active_style = Some (Box::new (f (StyleRefinement::default ()))); self } # [doc = \" Set the given styles to be applied when this element's group is active.\"] fn group_active (mut self, group_name : impl Into, f : impl FnOnce (StyleRefinement) -> StyleRefinement,) -> Self where Self : Sized, { self . interactivity () . group_active_style = Some (GroupStyle { group : group_name . into (), style : Box::new (f (StyleRefinement::default ())), }); self } # [doc = \" Bind the given callback to click events of this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_click`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_click (mut self, listener : impl Fn (& ClickEvent, & mut Window, & mut App) + 'static) -> Self where Self : Sized, { self . interactivity () . on_click (listener); self } # [doc = \" Bind the given callback to non-primary click events of this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_aux_click`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_aux_click (mut self, listener : impl Fn (& ClickEvent, & mut Window, & mut App) + 'static,) -> Self where Self : Sized, { self . interactivity () . on_aux_click (listener); self } # [doc = \" On drag initiation, this callback will be used to create a new view to render the dragged value for a\"] # [doc = \" drag and drop operation. This API should also be used as the equivalent of 'on drag start' with\"] # [doc = \" the [`InteractiveElement::on_drag_move`] API.\"] # [doc = \" The callback also has access to the offset of triggering click from the origin of parent element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_drag`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_drag (mut self, value : T, constructor : impl Fn (& T, Point, & mut Window, & mut App) -> Entity + 'static,) -> Self where Self : Sized, T : 'static, W : 'static + Render, { self . interactivity () . on_drag (value, constructor); self } # [doc = \" Registers a callback resolving a payload to offer the platform if a drag started by this\"] # [doc = \" element leaves the window. It is invoked at most once per drag gesture, when the pointer\"] # [doc = \" exits the viewport. Must be called after [`Self::on_drag`], with the same dragged value\"] # [doc = \" type `T`.\"] # [doc = \" The fluent API equivalent to [`Interactivity::external_drag_payload`].\"] fn external_drag_payload (mut self, resolver : impl Fn (& T, & mut Window, & mut App) -> Option + 'static,) -> Self where Self : Sized, T : 'static, { self . interactivity () . external_drag_payload (resolver); self } # [doc = \" Bind the given callback on the hover start and end events of this element. Note that the boolean\"] # [doc = \" passed to the callback is true when the hover starts and false when it ends.\"] # [doc = \" The fluent API equivalent to [`Interactivity::on_hover`].\"] # [doc = \"\"] # [doc = \" See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.\"] fn on_hover (mut self, listener : impl Fn (& bool, & mut Window, & mut App) + 'static) -> Self where Self : Sized, { self . interactivity () . on_hover (listener); self } # [doc = \" Use the given callback to construct a new tooltip view when the mouse hovers over this element.\"] # [doc = \" The fluent API equivalent to [`Interactivity::tooltip`].\"] fn tooltip (mut self, build_tooltip : impl Fn (& mut Window, & mut App) -> AnyView + 'static) -> Self where Self : Sized, { self . interactivity () . tooltip (build_tooltip); self } # [doc = \" Use the given callback to construct a new tooltip view when the mouse hovers over this element.\"] # [doc = \" The tooltip itself is also hoverable and won't disappear when the user moves the mouse into\"] # [doc = \" the tooltip. The fluent API equivalent to [`Interactivity::hoverable_tooltip`].\"] fn hoverable_tooltip (mut self, build_tooltip : impl Fn (& mut Window, & mut App) -> AnyView + 'static,) -> Self where Self : Sized, { self . interactivity () . hoverable_tooltip (build_tooltip); self } # [doc = \" Set the delay before this element's tooltip is shown.\"] # [doc = \" The fluent API equivalent to [`Interactivity::tooltip_show_delay`].\"] fn tooltip_show_delay (mut self, delay : Duration) -> Self where Self : Sized, { self . interactivity () . tooltip_show_delay (delay); self } }", "cfg": [] }, { "id": "gpui::elements::div::div", "name": "div", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::div", "path": "gpui::elements::div", "source": "crates/gpui/src/elements/div.rs", "summary": "Construct a new [`Div`] element", "documentation": "Construct a new [`Div`] element", "signature": "pub fn div () -> Div", "cfg": [] }, { "id": "gpui::elements::document_selection::DocumentSelectionState", "name": "DocumentSelectionState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The document selection of one window.", "documentation": "The document selection of one window.\n\nThis lives on [`Window`](crate::Window) rather than in a global, so it\nfollows the window's own lifetime and a closed window leaves nothing\nbehind.", "signature": "# [doc = \" The document selection of one window.\"] # [doc = \"\"] # [doc = \" This lives on [`Window`](crate::Window) rather than in a global, so it\"] # [doc = \" follows the window's own lifetime and a closed window leaves nothing\"] # [doc = \" behind.\"] # [derive (Clone, Debug, Default)] pub struct DocumentSelectionState { scope : SelectionScopeId, anchor : Option, focus : Option, dragging : bool, drag_origin : Option, drag_unit : Option<(SelectionContentKey, u64, Range)>, drag_kind : SelectionUnit, autoscroll : Point, }", "cfg": [] }, { "id": "gpui::elements::document_selection::DocumentSelectionState::anchor", "name": "anchor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The end the selection was started from.", "documentation": "The end the selection was started from.", "signature": "pub fn anchor (& self) -> Option<& SelectionEndpoint>", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::autoscroll_delta", "name": "autoscroll_delta", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "How far a host should scroll to keep a drag that left the mounted content moving, in logical pixels per frame.", "documentation": "How far a host should scroll to keep a drag that left the mounted\ncontent moving, in logical pixels per frame.\n\nZero whenever no drag is in progress. GPUI reports the overflow and\nscrolls nothing itself, because it does not own the container.", "signature": "pub fn autoscroll_delta (& self) -> Point", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Forgets the selection entirely.", "documentation": "Forgets the selection entirely.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::focus", "name": "focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The end the selection currently reaches.", "documentation": "The end the selection currently reaches.", "signature": "pub fn focus (& self) -> Option<& SelectionEndpoint>", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::is_dragging", "name": "is_dragging", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Whether a pointer drag is extending the selection right now.", "documentation": "Whether a pointer drag is extending the selection right now.", "signature": "pub fn is_dragging (& self) -> bool", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Whether anything at all is selected.", "documentation": "Whether anything at all is selected.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::ordered", "name": "ordered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The two ends in reading order, low first.", "documentation": "The two ends in reading order, low first.", "signature": "pub fn ordered (& self) -> Option<(& SelectionEndpoint, & SelectionEndpoint)>", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::owns_drag", "name": "owns_drag", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Whether `key` is the participant that owns the drag in progress.", "documentation": "Whether `key` is the participant that owns the drag in progress.\n\nExactly one participant answers a pointer move, so a drag that has left\nthe text it started in still has one owner rather than as many opinions\nas there are mounted paragraphs.", "signature": "pub fn owns_drag (& self, key : & SelectionContentKey) -> bool", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::range_for", "name": "range_for", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The byte range of one participant that this selection covers.", "documentation": "The byte range of one participant that this selection covers.\n\nReturns `None` when the participant lies outside the selection or in\nanother scope. A participant strictly between the two ends is covered\nin full without needing to have been registered when the ends were\nplaced.", "signature": "pub fn range_for (& self, key : & SelectionContentKey, scope : SelectionScopeId, order : u64, text_len : usize,) -> Option>", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::DocumentSelectionState::scope", "name": "scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The scope the current selection belongs to.", "documentation": "The scope the current selection belongs to.", "signature": "pub fn scope (& self) -> SelectionScopeId", "cfg": [], "target": "DocumentSelectionState" }, { "id": "gpui::elements::document_selection::SelectionContentKey", "name": "SelectionContentKey", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The stable identity of one participant in a document selection.", "documentation": "The stable identity of one participant in a document selection.\n\nA key states what the content *is*. Deriving one from a row index makes a\nselection follow the viewport instead of the text, which is the failure this\ntype exists to prevent.", "signature": "# [doc = \" The stable identity of one participant in a document selection.\"] # [doc = \"\"] # [doc = \" A key states what the content *is*. Deriving one from a row index makes a\"] # [doc = \" selection follow the viewport instead of the text, which is the failure this\"] # [doc = \" type exists to prevent.\"] # [derive (Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)] pub struct SelectionContentKey (SharedString);", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionContentKey::as_str", "name": "as_str", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The identity as it was declared.", "documentation": "The identity as it was declared.", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "SelectionContentKey" }, { "id": "gpui::elements::document_selection::SelectionContentKey::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Names one participant by its business identity.", "documentation": "Names one participant by its business identity.", "signature": "pub fn new (id : impl Into) -> Self", "cfg": [], "target": "SelectionContentKey" }, { "id": "gpui::elements::document_selection::SelectionCopy", "name": "SelectionCopy", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The result of copying a document selection.", "documentation": "The result of copying a document selection.", "signature": "# [doc = \" The result of copying a document selection.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct SelectionCopy { # [doc = \" The selected text of every participant the copy could see, joined in\"] # [doc = \" reading order.\"] pub text : String, # [doc = \" How many participants contributed.\"] pub participants : usize, # [doc = \" Whether the copy could prove it saw the whole span.\"] # [doc = \"\"] # [doc = \" `false` means content was selected that GPUI could not read: an\"] # [doc = \" endpoint is no longer mounted, or the span crosses a participant that\"] # [doc = \" declared itself [`SelectionCoverage::Virtualized`]. The text is still\"] # [doc = \" what was actually read, never a guess.\"] pub complete : bool, }", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionCoverage", "name": "SelectionCoverage", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "How much of its content a participant can vouch for.", "documentation": "How much of its content a participant can vouch for.", "signature": "# [doc = \" How much of its content a participant can vouch for.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub enum SelectionCoverage { # [doc = \" Every participant of this content is mounted whenever any of it is, so\"] # [doc = \" a span that crosses it has been seen in full.\"] # [default] Complete, # [doc = \" This participant is one mounted window onto a longer run. It can report\"] # [doc = \" its own text and nothing about its neighbours.\"] Virtualized, }", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionEndpoint", "name": "SelectionEndpoint", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "One end of a document selection.", "documentation": "One end of a document selection.\n\nThe endpoint retains the reading order it was placed at, so resolving a\nrange never requires the participant at the other end to still be mounted.", "signature": "# [doc = \" One end of a document selection.\"] # [doc = \"\"] # [doc = \" The endpoint retains the reading order it was placed at, so resolving a\"] # [doc = \" range never requires the participant at the other end to still be mounted.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct SelectionEndpoint { # [doc = \" Which participant the end sits in.\"] pub key : SelectionContentKey, # [doc = \" That participant's reading order when the end was placed.\"] pub order : u64, # [doc = \" The byte offset within that participant's text.\"] pub offset : usize, }", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionParticipant", "name": "SelectionParticipant", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "What one participant reports about itself for one frame.", "documentation": "What one participant reports about itself for one frame.", "signature": "# [doc = \" What one participant reports about itself for one frame.\"] # [derive (Clone)] pub struct SelectionParticipant { key : SelectionContentKey, scope : SelectionScopeId, order : u64, bounds : Bounds, text : SharedString, rows : Vec>, coverage : SelectionCoverage, sensitive : bool, resolve : Option, }", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionParticipant::is_sensitive", "name": "is_sensitive", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Whether this participant declined to take part.", "documentation": "Whether this participant declined to take part.", "signature": "pub fn is_sensitive (& self) -> bool", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::key", "name": "key", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The identity this participant declared.", "documentation": "The identity this participant declared.", "signature": "pub fn key (& self) -> & SelectionContentKey", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Declares a participant at a position in reading order.", "documentation": "Declares a participant at a position in reading order.", "signature": "pub fn new (key : impl Into, order : u64, bounds : Bounds) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::resolver", "name": "resolver", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Supplies the mapping from a window position to a byte offset.", "documentation": "Supplies the mapping from a window position to a byte offset.\n\nWithout one, a drag reaching this participant lands at its start or its\nend rather than inside it.", "signature": "pub fn resolver (mut self, resolve : SelectionResolver) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::rows", "name": "rows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The visual rows a triple click selects by.", "documentation": "The visual rows a triple click selects by.", "signature": "pub fn rows (mut self, rows : Vec>) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::scope", "name": "scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Places the participant in an isolated scope.", "documentation": "Places the participant in an isolated scope.", "signature": "pub fn scope (mut self, scope : SelectionScopeId) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::sensitive", "name": "sensitive", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Refuses registration entirely.", "documentation": "Refuses registration entirely.\n\nA sensitive participant takes no part in a document selection and its\nbytes never reach the aggregate copy path.", "signature": "pub fn sensitive (mut self, sensitive : bool) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "The text this participant projects selection offsets onto.", "documentation": "The text this participant projects selection offsets onto.", "signature": "pub fn text (mut self, text : impl Into) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionParticipant::virtualized", "name": "virtualized", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "States that this participant is one mounted window onto a longer run, so a span crossing it cannot be reported as a complete copy.", "documentation": "States that this participant is one mounted window onto a longer run,\nso a span crossing it cannot be reported as a complete copy.", "signature": "pub fn virtualized (mut self) -> Self", "cfg": [], "target": "SelectionParticipant" }, { "id": "gpui::elements::document_selection::SelectionResolver", "name": "SelectionResolver", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Maps a window position to a byte offset in one participant's text.", "documentation": "Maps a window position to a byte offset in one participant's text.\n\nThe participant that owns a drag needs this to place the far end of a\nselection inside a participant it has no layout for.", "signature": "# [doc = \" Maps a window position to a byte offset in one participant's text.\"] # [doc = \"\"] # [doc = \" The participant that owns a drag needs this to place the far end of a\"] # [doc = \" selection inside a participant it has no layout for.\"] pub type SelectionResolver = Rc) -> usize>;", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionScope", "name": "SelectionScope", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Draws its child inside an isolated text-selection scope.", "documentation": "Draws its child inside an isolated text-selection scope.\n\nA drag started inside the scope never reaches text outside it, and text\noutside never joins a selection started within, which is what keeps a\ndialog mounted over a document from being selected together with it.", "signature": "# [doc = \" Draws its child inside an isolated text-selection scope.\"] # [doc = \"\"] # [doc = \" A drag started inside the scope never reaches text outside it, and text\"] # [doc = \" outside never joins a selection started within, which is what keeps a\"] # [doc = \" dialog mounted over a document from being selected together with it.\"] pub struct SelectionScope { scope : SelectionScopeId, child : Option, }", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionScopeId", "name": "SelectionScopeId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "An opaque isolation boundary within one window.", "documentation": "An opaque isolation boundary within one window.\n\nTwo participants in different scopes are never part of the same selection,\nwhatever their reading order says.", "signature": "# [doc = \" An opaque isolation boundary within one window.\"] # [doc = \"\"] # [doc = \" Two participants in different scopes are never part of the same selection,\"] # [doc = \" whatever their reading order says.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, Hash, PartialOrd, Ord)] pub struct SelectionScopeId (u64);", "cfg": [] }, { "id": "gpui::elements::document_selection::SelectionScopeId::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Derives a stable scope from anything a caller already identifies an isolated surface by, such as a dialog's element id.", "documentation": "Derives a stable scope from anything a caller already identifies an\nisolated surface by, such as a dialog's element id.", "signature": "pub fn new (seed : impl Hash) -> Self", "cfg": [], "target": "SelectionScopeId" }, { "id": "gpui::elements::document_selection::SelectionUnit", "name": "SelectionUnit", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Which selection gesture a pointer press opened.", "documentation": "Which selection gesture a pointer press opened.", "signature": "# [doc = \" Which selection gesture a pointer press opened.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub enum SelectionUnit { # [doc = \" One insertion point, extended by graphemes.\"] # [default] Caret, # [doc = \" A word, extended a word at a time.\"] Word, # [doc = \" A visual row, extended a row at a time.\"] Row, }", "cfg": [] }, { "id": "gpui::elements::document_selection::selection_scope", "name": "selection_scope", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::document_selection", "path": "gpui::elements::document_selection", "source": "crates/gpui/src/elements/document_selection.rs", "summary": "Isolates `child` in its own text-selection scope, seeded by `seed`.", "documentation": "Isolates `child` in its own text-selection scope, seeded by `seed`.", "signature": "pub fn selection_scope (seed : impl Hash, child : impl crate::IntoElement) -> SelectionScope", "cfg": [] }, { "id": "gpui::elements::image_cache::AnyImageCache", "name": "AnyImageCache", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "A dynamically typed image cache, which can be used to store any image cache", "documentation": "A dynamically typed image cache, which can be used to store any image cache", "signature": "# [doc = \" A dynamically typed image cache, which can be used to store any image cache\"] # [derive (Clone)] pub struct AnyImageCache { image_cache : AnyEntity, load_fn : fn (image_cache : & AnyEntity, resource : & Resource, window : & mut Window, cx : & mut App,) -> Option, ImageCacheError>>, }", "cfg": [] }, { "id": "gpui::elements::image_cache::AnyImageCache::load", "name": "load", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Load an image given a resource returns the result of loading the image if it has finished loading, or None if it is still loading", "documentation": "Load an image given a resource\nreturns the result of loading the image if it has finished loading, or None if it is still loading", "signature": "pub fn load (& self, resource : & Resource, window : & mut Window, cx : & mut App,) -> Option, ImageCacheError>>", "cfg": [], "target": "AnyImageCache" }, { "id": "gpui::elements::image_cache::ImageCache", "name": "ImageCache", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An object that can handle the caching and unloading of images. Implementations of this trait should ensure that images are removed from all windows when they are no longer needed.", "documentation": "An object that can handle the caching and unloading of images.\nImplementations of this trait should ensure that images are removed from all windows when they are no longer needed.", "signature": "# [doc = \" An object that can handle the caching and unloading of images.\"] # [doc = \" Implementations of this trait should ensure that images are removed from all windows when they are no longer needed.\"] pub trait ImageCache : 'static { # [doc = \" Load an image given a resource\"] # [doc = \" returns the result of loading the image if it has finished loading, or None if it is still loading\"] fn load (& mut self, resource : & Resource, window : & mut Window, cx : & mut App,) -> Option, ImageCacheError>>; }", "cfg": [] }, { "id": "gpui::elements::image_cache::ImageCacheElement", "name": "ImageCacheElement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An image cache element.", "documentation": "An image cache element.", "signature": "# [doc = \" An image cache element.\"] pub struct ImageCacheElement { image_cache_provider : Box, style : StyleRefinement, children : SmallVec<[AnyElement; 2]>, }", "cfg": [] }, { "id": "gpui::elements::image_cache::ImageCacheItem", "name": "ImageCacheItem", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An image cache item", "documentation": "An image cache item", "signature": "# [doc = \" An image cache item\"] pub enum ImageCacheItem { # [doc = \" The associated image is currently loading\"] Loading (ImageLoadingTask), # [doc = \" This item has loaded an image.\"] Loaded (Result, ImageCacheError>), }", "cfg": [] }, { "id": "gpui::elements::image_cache::ImageCacheItem::get", "name": "get", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Attempt to get the image from the cache item.", "documentation": "Attempt to get the image from the cache item.", "signature": "pub fn get (& mut self) -> Option, ImageCacheError>>", "cfg": [], "target": "ImageCacheItem" }, { "id": "gpui::elements::image_cache::ImageCacheProvider", "name": "ImageCacheProvider", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An object that can create an ImageCache during the render phase. See the ImageCache trait for more information.", "documentation": "An object that can create an ImageCache during the render phase.\nSee the ImageCache trait for more information.", "signature": "# [doc = \" An object that can create an ImageCache during the render phase.\"] # [doc = \" See the ImageCache trait for more information.\"] pub trait ImageCacheProvider : 'static { # [doc = \" Called during the request_layout phase to create an ImageCache.\"] fn provide (& mut self, _window : & mut Window, _cx : & mut App) -> AnyImageCache; }", "cfg": [] }, { "id": "gpui::elements::image_cache::ImageLoadingTask", "name": "ImageLoadingTask", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An image loading task associated with an image cache.", "documentation": "An image loading task associated with an image cache.", "signature": "# [doc = \" An image loading task associated with an image cache.\"] pub type ImageLoadingTask = Shared, ImageCacheError>>>;", "cfg": [] }, { "id": "gpui::elements::image_cache::RetainAllImageCache", "name": "RetainAllImageCache", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An implementation of ImageCache, that uses an LRU caching strategy to unload images when the cache is full", "documentation": "An implementation of ImageCache, that uses an LRU caching strategy to unload images when the cache is full", "signature": "# [doc = \" An implementation of ImageCache, that uses an LRU caching strategy to unload images when the cache is full\"] pub struct RetainAllImageCache (HashMap);", "cfg": [] }, { "id": "gpui::elements::image_cache::RetainAllImageCache::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Clear the image cache.", "documentation": "Clear the image cache.", "signature": "pub fn clear (& mut self, window : & mut Window, cx : & mut App)", "cfg": [], "target": "RetainAllImageCache" }, { "id": "gpui::elements::image_cache::RetainAllImageCache::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Returns true if the cache is empty.", "documentation": "Returns true if the cache is empty.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "RetainAllImageCache" }, { "id": "gpui::elements::image_cache::RetainAllImageCache::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Returns the number of images in the cache.", "documentation": "Returns the number of images in the cache.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "RetainAllImageCache" }, { "id": "gpui::elements::image_cache::RetainAllImageCache::load", "name": "load", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Load an image from the given source.", "documentation": "Load an image from the given source.\n\nReturns `None` if the image is loading.", "signature": "pub fn load (& mut self, source : & Resource, window : & mut Window, cx : & mut App,) -> Option, ImageCacheError>>", "cfg": [], "target": "RetainAllImageCache" }, { "id": "gpui::elements::image_cache::RetainAllImageCache::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Create a new image cache.", "documentation": "Create a new image cache.", "signature": "pub fn new (cx : & mut App) -> Entity", "cfg": [], "target": "RetainAllImageCache" }, { "id": "gpui::elements::image_cache::RetainAllImageCache::remove", "name": "remove", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Remove the image from the cache by the given source.", "documentation": "Remove the image from the cache by the given source.", "signature": "pub fn remove (& mut self, source : & Resource, window : & mut Window, cx : & mut App)", "cfg": [], "target": "RetainAllImageCache" }, { "id": "gpui::elements::image_cache::RetainAllImageCacheProvider", "name": "RetainAllImageCacheProvider", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "A provider struct for creating a retain-all image cache inline", "documentation": "A provider struct for creating a retain-all image cache inline", "signature": "# [doc = \" A provider struct for creating a retain-all image cache inline\"] pub struct RetainAllImageCacheProvider { id : ElementId, }", "cfg": [] }, { "id": "gpui::elements::image_cache::image_cache", "name": "image_cache", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "An image cache element, all its child img elements will use the cache specified by this element. Note that this could as simple as passing an `Entity`", "documentation": "An image cache element, all its child img elements will use the cache specified by this element.\nNote that this could as simple as passing an `Entity`", "signature": "pub fn image_cache (image_cache_provider : impl ImageCacheProvider) -> ImageCacheElement", "cfg": [] }, { "id": "gpui::elements::image_cache::retain_all", "name": "retain_all", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::image_cache", "path": "gpui::elements::image_cache", "source": "crates/gpui/src/elements/image_cache.rs", "summary": "Constructs a retain-all image cache that uses the element state associated with the given ID.", "documentation": "Constructs a retain-all image cache that uses the element state associated with the given ID.", "signature": "pub fn retain_all (id : impl Into) -> RetainAllImageCacheProvider", "cfg": [] }, { "id": "gpui::elements::img::ImageAssetLoader", "name": "ImageAssetLoader", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "An image loader for the GPUI asset system", "documentation": "An image loader for the GPUI asset system", "signature": "# [doc = \" An image loader for the GPUI asset system\"] # [derive (Clone)] pub enum ImageAssetLoader { }", "cfg": [] }, { "id": "gpui::elements::img::ImageCacheError", "name": "ImageCacheError", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "An error that can occur when interacting with the image cache.", "documentation": "An error that can occur when interacting with the image cache.", "signature": "# [doc = \" An error that can occur when interacting with the image cache.\"] # [derive (Debug, Error, Clone)] pub enum ImageCacheError { # [doc = \" Some other kind of error occurred\"] # [error (\"error: {0}\")] Other (# [from] Arc), # [doc = \" An error that occurred while reading the image from disk.\"] # [error (\"IO error: {0}\")] Io (Arc), # [doc = \" An error that occurred while processing an image.\"] # [error (\"unexpected http status for {uri}: {status}, body: {body}\")] BadStatus { # [doc = \" The URI of the image.\"] uri : SharedUri, # [doc = \" The HTTP status code.\"] status : http_client::StatusCode, # [doc = \" The HTTP response body.\"] body : String, }, # [doc = \" An error that occurred while processing an asset.\"] # [error (\"asset error: {0}\")] Asset (SharedString), # [doc = \" An error that occurred while processing an image.\"] # [error (\"image error: {0}\")] Image (Arc), # [doc = \" An error that occurred while processing an SVG.\"] # [error (\"svg error: {0}\")] Usvg (Arc), }", "cfg": [] }, { "id": "gpui::elements::img::ImageSource", "name": "ImageSource", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "A source of image content.", "documentation": "A source of image content.", "signature": "# [doc = \" A source of image content.\"] # [derive (Clone)] pub enum ImageSource { # [doc = \" The image content will be loaded from some resource location\"] Resource (Resource), # [doc = \" Cached image data\"] Render (Arc), # [doc = \" Cached image data\"] Image (Arc), # [doc = \" A custom loading function to use\"] Custom (Arc Option, ImageCacheError>>>), }", "cfg": [] }, { "id": "gpui::elements::img::ImageSource::is_asset_cached", "name": "is_asset_cached", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "Check whether this image source is present in the asset system (loading or loaded), without fetching it.", "documentation": "Check whether this image source is present in the asset system (loading\nor loaded), without fetching it.", "signature": "pub fn is_asset_cached (& self, cx : & App) -> bool", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "ImageSource" }, { "id": "gpui::elements::img::ImageSource::remove_asset", "name": "remove_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "Remove this image source from the asset system", "documentation": "Remove this image source from the asset system", "signature": "pub fn remove_asset (& self, cx : & mut App)", "cfg": [], "target": "ImageSource" }, { "id": "gpui::elements::img::ImageStyle", "name": "ImageStyle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "The style of an image element.", "documentation": "The style of an image element.", "signature": "# [doc = \" The style of an image element.\"] pub struct ImageStyle { grayscale : bool, object_fit : ObjectFit, loading : Option AnyElement>>, fallback : Option AnyElement>>, }", "cfg": [] }, { "id": "gpui::elements::img::Img", "name": "Img", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "An image element.", "documentation": "An image element.", "signature": "# [doc = \" An image element.\"] pub struct Img { interactivity : Interactivity, source : ImageSource, style : ImageStyle, image_cache : Option, }", "cfg": [] }, { "id": "gpui::elements::img::Img::extensions", "name": "extensions", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "A list of all format extensions currently supported by this img element", "documentation": "A list of all format extensions currently supported by this img element", "signature": "pub fn extensions () -> & 'static [& 'static str]", "cfg": [], "target": "Img" }, { "id": "gpui::elements::img::Img::image_cache", "name": "image_cache", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "Sets the image cache for the current node.", "documentation": "Sets the image cache for the current node.\n\nIf the `image_cache` is not explicitly provided, the function will determine the image cache by:\n\n1. Checking if any ancestor node of the current node contains an `ImageCacheElement`, If such a node exists, the image cache specified by that ancestor will be used.\n2. If no ancestor node contains an `ImageCacheElement`, the global image cache will be used as a fallback.\n\nThis mechanism provides a flexible way to manage image caching, allowing precise control when needed,\nwhile ensuring a default behavior when no cache is explicitly specified.", "signature": "pub fn image_cache (self, image_cache : & Entity) -> Self", "cfg": [], "target": "Img" }, { "id": "gpui::elements::img::ImgLayoutState", "name": "ImgLayoutState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "The image layout state between frames", "documentation": "The image layout state between frames", "signature": "# [doc = \" The image layout state between frames\"] pub struct ImgLayoutState { frame_index : usize, replacement : Option, }", "cfg": [] }, { "id": "gpui::elements::img::ImgResourceLoader", "name": "ImgResourceLoader", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "A type alias to the resource loader that the `img()` element uses.", "documentation": "A type alias to the resource loader that the `img()` element uses.\n\nNote: that this is only for Resources, like URLs or file paths.\nCustom loaders, or external images will not use this asset loader", "signature": "# [doc = \" A type alias to the resource loader that the `img()` element uses.\"] # [doc = \"\"] # [doc = \" Note: that this is only for Resources, like URLs or file paths.\"] # [doc = \" Custom loaders, or external images will not use this asset loader\"] pub type ImgResourceLoader = AssetLogger;", "cfg": [] }, { "id": "gpui::elements::img::LOADING_DELAY", "name": "LOADING_DELAY", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "The delay before showing the loading state.", "documentation": "The delay before showing the loading state.", "signature": "pub const LOADING_DELAY: Duration", "cfg": [] }, { "id": "gpui::elements::img::StyledImage", "name": "StyledImage", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "Style an image element.", "documentation": "Style an image element.", "signature": "# [doc = \" Style an image element.\"] pub trait StyledImage : Sized { # [doc = \" Get a mutable [ImageStyle] from the element.\"] fn image_style (& mut self) -> & mut ImageStyle; # [doc = \" Set the image to be displayed in grayscale.\"] fn grayscale (mut self, grayscale : bool) -> Self { self . image_style () . grayscale = grayscale; self } # [doc = \" Set the object fit for the image.\"] fn object_fit (mut self, object_fit : ObjectFit) -> Self { self . image_style () . object_fit = object_fit; self } # [doc = \" Set a fallback function that will be invoked to render an error view should\"] # [doc = \" the image fail to load.\"] fn with_fallback (mut self, fallback : impl Fn () -> AnyElement + 'static) -> Self { self . image_style () . fallback = Some (Box::new (fallback)); self } # [doc = \" Set a fallback function that will be invoked to render a view while the image\"] # [doc = \" is still being loaded.\"] fn with_loading (mut self, loading : impl Fn () -> AnyElement + 'static) -> Self { self . image_style () . loading = Some (Box::new (loading)); self } }", "cfg": [] }, { "id": "gpui::elements::img::img", "name": "img", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::img", "path": "gpui::elements::img", "source": "crates/gpui/src/elements/img.rs", "summary": "Create a new image element.", "documentation": "Create a new image element.", "signature": "pub fn img (source : impl Into) -> Img", "cfg": [] }, { "id": "gpui::elements::list::FollowMode", "name": "FollowMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Controls whether the list automatically follows new content at the end.", "documentation": "Controls whether the list automatically follows new content at the end.", "signature": "# [doc = \" Controls whether the list automatically follows new content at the end.\"] # [derive (Clone, Copy, Debug, Default, Eq, PartialEq)] pub enum FollowMode { # [doc = \" Normal scrolling — no automatic following.\"] # [default] Normal, # [doc = \" The list should auto-scroll along with the tail, when scrolled to bottom.\"] Tail, }", "cfg": [] }, { "id": "gpui::elements::list::List", "name": "List", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "A list element", "documentation": "A list element", "signature": "# [doc = \" A list element\"] pub struct List { state : ListState, render_item : Box, style : StyleRefinement, sizing_behavior : ListSizingBehavior, }", "cfg": [] }, { "id": "gpui::elements::list::List::with_sizing_behavior", "name": "with_sizing_behavior", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Set the sizing behavior for the list.", "documentation": "Set the sizing behavior for the list.", "signature": "pub fn with_sizing_behavior (mut self, behavior : ListSizingBehavior) -> Self", "cfg": [], "target": "List" }, { "id": "gpui::elements::list::ListAlignment", "name": "ListAlignment", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Whether the list is scrolling from top to bottom or bottom to top.", "documentation": "Whether the list is scrolling from top to bottom or bottom to top.", "signature": "# [doc = \" Whether the list is scrolling from top to bottom or bottom to top.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq)] pub enum ListAlignment { # [doc = \" The list is scrolling from top to bottom, like most lists.\"] Top, # [doc = \" The list is scrolling from bottom to top, like a chat log.\"] Bottom, }", "cfg": [] }, { "id": "gpui::elements::list::ListHorizontalSizingBehavior", "name": "ListHorizontalSizingBehavior", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "The horizontal sizing behavior to apply during layout.", "documentation": "The horizontal sizing behavior to apply during layout.", "signature": "# [doc = \" The horizontal sizing behavior to apply during layout.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum ListHorizontalSizingBehavior { # [doc = \" List items' width can never exceed the width of the list.\"] # [default] FitList, # [doc = \" List items' width may go over the width of the list, if any item is wider.\"] Unconstrained, }", "cfg": [] }, { "id": "gpui::elements::list::ListMeasuringBehavior", "name": "ListMeasuringBehavior", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "The measuring behavior to apply during layout.", "documentation": "The measuring behavior to apply during layout.", "signature": "# [doc = \" The measuring behavior to apply during layout.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum ListMeasuringBehavior { # [doc = \" Measure all items in the list.\"] # [doc = \" Note: This can be expensive for the first frame in a large list.\"] Measure (bool), # [doc = \" Only measure visible items\"] # [default] Visible, }", "cfg": [] }, { "id": "gpui::elements::list::ListOffset", "name": "ListOffset", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "An offset into the list's items, in terms of the item index and the number of pixels off the top left of the item.", "documentation": "An offset into the list's items, in terms of the item index and the number\nof pixels off the top left of the item.", "signature": "# [doc = \" An offset into the list's items, in terms of the item index and the number\"] # [doc = \" of pixels off the top left of the item.\"] # [derive (Debug, Clone, Copy, Default)] pub struct ListOffset { # [doc = \" The index of an item in the list\"] pub item_ix : usize, # [doc = \" The number of pixels to offset from the item index.\"] pub offset_in_item : Pixels, }", "cfg": [] }, { "id": "gpui::elements::list::ListOffset::remap", "name": "remap", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Maps an anchor through an identity edit shared by fixed- and variable- height lists. Entries name unique previous indices, or `None` for new rows. Preserves the pixel remainder of a survivor; removal chooses the nearest surviving old-order successor, then predecessor, at offset zero. An explicit end sentinel maps to the new end. No survivors map to zero. Runs in linear time in the old and new row counts, without rendering.", "documentation": "Maps an anchor through an identity edit shared by fixed- and variable-\nheight lists. Entries name unique previous indices, or `None` for new\nrows. Preserves the pixel remainder of a survivor; removal chooses the\nnearest surviving old-order successor, then predecessor, at offset zero.\nAn explicit end sentinel maps to the new end. No survivors map to zero.\nRuns in linear time in the old and new row counts, without rendering.", "signature": "pub fn remap (self, previous_indices : & [Option], previous_count : usize) -> Self", "cfg": [], "target": "ListOffset" }, { "id": "gpui::elements::list::ListPrepaintState", "name": "ListPrepaintState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Frame state used by the [List] element after layout.", "documentation": "Frame state used by the [List] element after layout.", "signature": "# [doc = \" Frame state used by the [List] element after layout.\"] pub struct ListPrepaintState { hitbox : Hitbox, layout : LayoutItemsResponse, }", "cfg": [] }, { "id": "gpui::elements::list::ListScrollEvent", "name": "ListScrollEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "A scroll event that has been converted to be in terms of the list's items.", "documentation": "A scroll event that has been converted to be in terms of the list's items.", "signature": "# [doc = \" A scroll event that has been converted to be in terms of the list's items.\"] pub struct ListScrollEvent { # [doc = \" Actual clamped wheel movement in pixels, positive toward the end.\"] # [doc = \" Layout changes and programmatic scrolling do not emit this event.\"] pub scroll_delta : Pixels, # [doc = \" The range of items currently visible in the list, after applying the scroll event.\"] pub visible_range : Range, # [doc = \" The number of items that are currently visible in the list, after applying the scroll event.\"] pub count : usize, # [doc = \" Whether the list has been scrolled.\"] pub is_scrolled : bool, # [doc = \" Whether the list is currently in follow-tail mode (auto-scrolling to end).\"] pub is_following_tail : bool, }", "cfg": [] }, { "id": "gpui::elements::list::ListSizingBehavior", "name": "ListSizingBehavior", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "The sizing behavior to apply during layout.", "documentation": "The sizing behavior to apply during layout.", "signature": "# [doc = \" The sizing behavior to apply during layout.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum ListSizingBehavior { # [doc = \" The list should calculate its size based on the size of its items.\"] Infer, # [doc = \" The list should not calculate a fixed size.\"] # [default] Auto, }", "cfg": [] }, { "id": "gpui::elements::list::ListState", "name": "ListState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "The list state that views must hold on behalf of the list element.", "documentation": "The list state that views must hold on behalf of the list element.", "signature": "# [doc = \" The list state that views must hold on behalf of the list element.\"] # [derive (Clone)] pub struct ListState (Rc>);", "cfg": [] }, { "id": "gpui::elements::list::ListState::bounds_for_item", "name": "bounds_for_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Get the bounds for the given item in window coordinates, if it's been rendered.", "documentation": "Get the bounds for the given item in window coordinates, if it's\nbeen rendered.", "signature": "pub fn bounds_for_item (& self, ix : usize) -> Option>", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::is_following_tail", "name": "is_following_tail", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Returns whether the list is currently actively following the tail (snapping to the end on each layout).", "documentation": "Returns whether the list is currently actively following the\ntail (snapping to the end on each layout).", "signature": "pub fn is_following_tail (& self) -> bool", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::is_scrollbar_dragging", "name": "is_scrollbar_dragging", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Returns `true` if the scrollbar is currently being dragged.", "documentation": "Returns `true` if the scrollbar is currently being dragged.\n\nThis is set between [`scrollbar_drag_started`](Self::scrollbar_drag_started)\nand [`scrollbar_drag_ended`](Self::scrollbar_drag_ended) calls. Useful for\nconsumers that need to distinguish scrollbar drags from wheel/trackpad scrolls,\ne.g. to suppress auto-scroll behavior during manual positioning.", "signature": "pub fn is_scrollbar_dragging (& self) -> bool", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::is_scrolled_to_end", "name": "is_scrolled_to_end", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Whether the list is scrolled to the end, or `None` if the list is not scrollable or the total content height is not yet known.", "documentation": "Whether the list is scrolled to the end, or `None` if the list is\nnot scrollable or the total content height is not yet known.", "signature": "pub fn is_scrolled_to_end (& self) -> Option", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::item_count", "name": "item_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "The number of items in this list.", "documentation": "The number of items in this list.", "signature": "pub fn item_count (& self) -> usize", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::item_is_above_viewport", "name": "item_is_above_viewport", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Returns whether the item is entirely above the viewport, or `None` if the list has not measured enough layout to know.", "documentation": "Returns whether the item is entirely above the viewport, or `None` if\nthe list has not measured enough layout to know.\n\nA zero-height viewport still yields a definitive answer: callers may\nsize sibling UI based on this query (potentially squeezing the list\nitself to zero height), so returning `None` in that case would make\nthe answer oscillate from frame to frame.", "signature": "pub fn item_is_above_viewport (& self, ix : usize) -> Option", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::item_is_below_viewport", "name": "item_is_below_viewport", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Returns whether the item is entirely below the viewport, or `None` if the list has not measured enough layout to know.", "documentation": "Returns whether the item is entirely below the viewport, or `None` if\nthe list has not measured enough layout to know.\n\nSee [`Self::item_is_above_viewport`] for why a zero-height viewport\nstill yields a definitive answer.", "signature": "pub fn item_is_below_viewport (& self, ix : usize) -> Option", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::logical_scroll_top", "name": "logical_scroll_top", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Get the current scroll offset, in terms of the list's items.", "documentation": "Get the current scroll offset, in terms of the list's items.", "signature": "pub fn logical_scroll_top (& self) -> ListOffset", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::max_offset_for_scrollbar", "name": "max_offset_for_scrollbar", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Returns the maximum scroll offset according to the items we have measured. This value remains constant while dragging to prevent the scrollbar from moving away unexpectedly.", "documentation": "Returns the maximum scroll offset according to the items we have measured.\nThis value remains constant while dragging to prevent the scrollbar from moving away unexpectedly.", "signature": "pub fn max_offset_for_scrollbar (& self) -> Point", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::measure_all", "name": "measure_all", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Set the list to measure all items in the list in the first layout phase.", "documentation": "Set the list to measure all items in the list in the first layout phase.\n\nThis is useful for ensuring that the scrollbar size is correct instead of based on only rendered elements.", "signature": "pub fn measure_all (self) -> Self", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Construct a new list state, for storage on a view.", "documentation": "Construct a new list state, for storage on a view.\n\nThe overdraw parameter controls how much extra space is rendered\nabove and below the visible area. Elements within this area will\nbe measured even though they are not visible. This can help ensure\nthat the list doesn't flicker or pop in when scrolling.", "signature": "pub fn new (item_count : usize, alignment : ListAlignment, overdraw : Pixels) -> Self", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::remap_items", "name": "remap_items", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Reconciles row identity without discarding surviving measurements or focus handles. Each entry names that row's previous index; `None` creates an unmeasured row. Indices must be unique and in bounds.", "documentation": "Reconciles row identity without discarding surviving measurements or\nfocus handles. Each entry names that row's previous index; `None`\ncreates an unmeasured row. Indices must be unique and in bounds.\n\nThe anchored row retains its absolute within-row pixel offset, even\nacross arbitrary reorder. If removed, the nearest surviving successor\nin old order wins, then the nearest predecessor, with zero offset.\nNo survivor anchors the first new row. End-aligned following remains\nend-aligned. Callers own business IDs and revision invalidation.", "signature": "pub fn remap_items (& self, previous_indices : & [Option])", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::remeasure", "name": "remeasure", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Remeasure all items while preserving proportional scroll position.", "documentation": "Remeasure all items while preserving proportional scroll position.\n\nUse this when item heights may have changed (e.g., font size changes)\nbut the number and identity of items remains the same.", "signature": "pub fn remeasure (& self)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::remeasure_items", "name": "remeasure_items", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Mark items in `range` as needing remeasurement while preserving the current scroll position. Unlike [`Self::splice`], this does not change the number of items or blow away `logical_scroll_top`.", "documentation": "Mark items in `range` as needing remeasurement while preserving\nthe current scroll position. Unlike [`Self::splice`], this does\nnot change the number of items or blow away `logical_scroll_top`.\n\nUse this when an item's content has changed and its rendered\nheight may be different (e.g., streaming text, tool results\nloading), but the item itself still exists at the same index.", "signature": "pub fn remeasure_items (& self, range : Range)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::reset", "name": "reset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Reset this instantiation of the list state.", "documentation": "Reset this instantiation of the list state.\n\nNote that this will cause scroll events to be dropped until the next paint.", "signature": "pub fn reset (& self, element_count : usize)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::reset_with_uniform_height", "name": "reset_with_uniform_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Reset the list to `element_count` items, pre-populating every item with a uniform height hint so the scrollbar thumb is correctly sized from the first frame even for off-screen items.", "documentation": "Reset the list to `element_count` items, pre-populating every item with a\nuniform height hint so the scrollbar thumb is correctly sized from the first\nframe even for off-screen items.", "signature": "pub fn reset_with_uniform_height (& self, element_count : usize, height : Pixels)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scroll_by", "name": "scroll_by", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Scroll the list by the given offset", "documentation": "Scroll the list by the given offset", "signature": "pub fn scroll_by (& self, distance : Pixels)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scroll_px_offset_for_scrollbar", "name": "scroll_px_offset_for_scrollbar", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Returns the current scroll offset adjusted for the scrollbar.", "documentation": "Returns the current scroll offset adjusted for the scrollbar.\n\nThe returned offset has a negative `y` component representing\nhow far the content has scrolled.", "signature": "pub fn scroll_px_offset_for_scrollbar (& self) -> Point", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scroll_to", "name": "scroll_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Scroll the list to the given offset", "documentation": "Scroll the list to the given offset", "signature": "pub fn scroll_to (& self, mut scroll_top : ListOffset)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scroll_to_end", "name": "scroll_to_end", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Scroll the list to the very end (past the last item).", "documentation": "Scroll the list to the very end (past the last item).\n\nUnlike [`Self::scroll_to_reveal_item`], this uses the total item count as\nthe anchor, so the list's layout pass will walk backwards from the end\nand always show the bottom of the last item — even when that item is\nstill growing (e.g. during streaming).", "signature": "pub fn scroll_to_end (& self)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scroll_to_reveal_item", "name": "scroll_to_reveal_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Scroll the list to the given item, such that the item is fully visible.", "documentation": "Scroll the list to the given item, such that the item is fully visible.", "signature": "pub fn scroll_to_reveal_item (& self, ix : usize)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scrollbar_drag_ended", "name": "scrollbar_drag_ended", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Called when the user stops dragging the scrollbar.", "documentation": "Called when the user stops dragging the scrollbar.\n\nSee `scrollbar_drag_started`.", "signature": "pub fn scrollbar_drag_ended (& self)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::scrollbar_drag_started", "name": "scrollbar_drag_started", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Call this method when the user starts dragging the scrollbar.", "documentation": "Call this method when the user starts dragging the scrollbar.\n\nThis will prevent the height reported to the scrollbar from changing during the drag\nas items in the overdraw get measured, and help offset scroll position changes accordingly.", "signature": "pub fn scrollbar_drag_started (& self)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::set_follow_mode", "name": "set_follow_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Set the follow mode for the list. In `Tail` mode, the list will auto-scroll to the end and re-engage after the user scrolls back to the bottom. In `Normal` mode, no automatic following occurs.", "documentation": "Set the follow mode for the list. In `Tail` mode, the list\nwill auto-scroll to the end and re-engage after the user\nscrolls back to the bottom. In `Normal` mode, no automatic\nfollowing occurs.", "signature": "pub fn set_follow_mode (& self, mode : FollowMode)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::set_offset_from_scrollbar", "name": "set_offset_from_scrollbar", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Set the offset from the scrollbar", "documentation": "Set the offset from the scrollbar", "signature": "pub fn set_offset_from_scrollbar (& self, point : Point)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::set_scroll_handler", "name": "set_scroll_handler", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Set a handler that will be called when the list is scrolled.", "documentation": "Set a handler that will be called when the list is scrolled.", "signature": "pub fn set_scroll_handler (& self, handler : impl FnMut (& ListScrollEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::splice", "name": "splice", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Inform the list state that the items in `old_range` have been replaced by `count` new items that must be recalculated.", "documentation": "Inform the list state that the items in `old_range` have been replaced\nby `count` new items that must be recalculated.", "signature": "pub fn splice (& self, old_range : Range, count : usize)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::splice_focusable", "name": "splice_focusable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Register with the list state that the items in `old_range` have been replaced by new items. As opposed to [`Self::splice`], this method allows an iterator of optional focus handles to be supplied to properly integrate with items in the list that can be focused. If a focused item is scrolled out of view, the list will continue to render it to allow keyboard interaction.", "documentation": "Register with the list state that the items in `old_range` have been replaced\nby new items. As opposed to [`Self::splice`], this method allows an iterator of optional focus handles\nto be supplied to properly integrate with items in the list that can be focused. If a focused item\nis scrolled out of view, the list will continue to render it to allow keyboard interaction.", "signature": "pub fn splice_focusable (& self, old_range : Range, focus_handles : impl IntoIterator>,)", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::viewport_bounds", "name": "viewport_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Return the bounds of the viewport in pixels.", "documentation": "Return the bounds of the viewport in pixels.", "signature": "pub fn viewport_bounds (& self) -> Bounds", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::ListState::with_uniform_item_height", "name": "with_uniform_item_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Pre-populate every unmeasured item with a uniform height hint so the scrollbar thumb is correctly sized from the first frame, without measuring all items up front.", "documentation": "Pre-populate every unmeasured item with a uniform height hint so the scrollbar thumb\nis correctly sized from the first frame, without measuring all items up front.\n\nAs items are actually rendered their real heights replace the hint, so the scrollbar\nconverges to the exact size over time. This is a cheaper alternative to [`Self::measure_all`]\nfor lists where items have roughly uniform heights (e.g. table rows).", "signature": "pub fn with_uniform_item_height (self, height : Pixels) -> Self", "cfg": [], "target": "ListState" }, { "id": "gpui::elements::list::list", "name": "list", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::list", "path": "gpui::elements::list", "source": "crates/gpui/src/elements/list.rs", "summary": "Construct a new list element", "documentation": "Construct a new list element", "signature": "pub fn list (state : ListState, render_item : impl FnMut (usize, & mut Window, & mut App) -> AnyElement + 'static,) -> List", "cfg": [] }, { "id": "gpui::elements::platform_view::PlatformView", "name": "PlatformView", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::platform_view", "path": "gpui::elements::platform_view", "source": "crates/gpui/src/elements/platform_view.rs", "summary": "An element that gives a natively hosted view a place in GPUI's layout.", "documentation": "An element that gives a natively hosted view a place in GPUI's layout.\n\nSee [`platform_view`].", "signature": "# [doc = \" An element that gives a natively hosted view a place in GPUI's layout.\"] # [doc = \"\"] # [doc = \" See [`platform_view`].\"] pub struct PlatformView { handle : PlatformViewHandle, style : StyleRefinement, }", "cfg": [] }, { "id": "gpui::elements::platform_view::platform_view", "name": "platform_view", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::platform_view", "path": "gpui::elements::platform_view", "source": "crates/gpui/src/elements/platform_view.rs", "summary": "Hosts a native platform view — an `NSView` on macOS or a child `HWND` on Windows or an X11 child on Linux — at the bounds this element is laid out at.", "documentation": "Hosts a native platform view — an `NSView` on macOS or a child `HWND` on\nWindows or an X11 child on Linux — at the bounds this element is laid out at.\n\nThe element itself paints nothing. Size it the way you would size any other\nelement; GPUI owns the native view's frame from then on and repositions it\nafter every frame it is painted in. A frame that does not paint the element\nhides and detaches the view, so unmounting is just not rendering it.\n\n# Stacking\n\nThe hosted view is ordered above GPUI's root scene. Content drawn on that\nsame base surface does not composite over the native view. When the window's\nscene overlay is enabled, deferred and window-level overlay content is drawn\non a separate surface above hosted views on macOS and Windows. X11 has no\nscene overlay above native children; hide the child before showing a GPUI\noverlay in its area. Rotation, scale, rounded masks and opacity are not\nnative-child composition operations and must not be applied to this element.\n`Window::with_visual_scale` explicitly panics when a native child is painted\nwith a nonidentity inherited mapping. Resizing a native frame is not an\nequivalent raster transform; host it outside that scope or supply a snapshot.\n\n# Clipping\n\nGPUI keeps the native view at its full layout bounds and applies the current\nrectangular content mask separately. Scrolling therefore crops the native\ncontent instead of resizing and reflowing it. A fully clipped view is\ndetached for that frame.\n\n# Platforms\n\nmacOS, Windows and Linux X11 host native views. Native Wayland and headless\nbackends reserve layout space only. Hosts must reject unsupported backends\nbefore constructing a native child rather than present empty space as success.", "signature": "pub fn platform_view (handle : PlatformViewHandle) -> PlatformView", "cfg": [] }, { "id": "gpui::elements::reexport-1", "name": "anchored :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use anchored::*;", "cfg": [] }, { "id": "gpui::elements::reexport-10", "name": "list :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use list::*;", "cfg": [] }, { "id": "gpui::elements::reexport-11", "name": "platform_view :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use platform_view::*;", "cfg": [] }, { "id": "gpui::elements::reexport-12", "name": "reveal :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use reveal::*;", "cfg": [] }, { "id": "gpui::elements::reexport-13", "name": "scroll_target :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use scroll_target::*;", "cfg": [] }, { "id": "gpui::elements::reexport-14", "name": "selectable_text :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use selectable_text::*;", "cfg": [] }, { "id": "gpui::elements::reexport-15", "name": "sticky :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use sticky::*;", "cfg": [] }, { "id": "gpui::elements::reexport-16", "name": "surface :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use surface::*;", "cfg": [] }, { "id": "gpui::elements::reexport-17", "name": "svg :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use svg::*;", "cfg": [] }, { "id": "gpui::elements::reexport-18", "name": "text :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use text::*;", "cfg": [] }, { "id": "gpui::elements::reexport-19", "name": "uniform_list :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use uniform_list::*;", "cfg": [] }, { "id": "gpui::elements::reexport-2", "name": "animation :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use animation::*;", "cfg": [] }, { "id": "gpui::elements::reexport-3", "name": "canvas :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use canvas::*;", "cfg": [] }, { "id": "gpui::elements::reexport-4", "name": "container_query :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use container_query::*;", "cfg": [] }, { "id": "gpui::elements::reexport-5", "name": "deferred :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use deferred::*;", "cfg": [] }, { "id": "gpui::elements::reexport-6", "name": "div :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use div::*;", "cfg": [] }, { "id": "gpui::elements::reexport-7", "name": "document_selection :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use document_selection::*;", "cfg": [] }, { "id": "gpui::elements::reexport-8", "name": "image_cache :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use image_cache::*;", "cfg": [] }, { "id": "gpui::elements::reexport-9", "name": "img :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "elements", "path": "gpui::elements", "source": "crates/gpui/src/elements/mod.rs", "summary": "", "documentation": "", "signature": "pub use img::*;", "cfg": [] }, { "id": "gpui::elements::reveal::Reveal", "name": "Reveal", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::reveal", "path": "gpui::elements::reveal", "source": "crates/gpui/src/elements/reveal.rs", "summary": "A measured subtree revealed along one physical axis.", "documentation": "A measured subtree revealed along one physical axis.", "signature": "# [doc = \" A measured subtree revealed along one physical axis.\"] pub struct Reveal { id : ElementId, progress : f32, axis : Axis, from_end : bool, child : AnyElement, }", "cfg": [] }, { "id": "gpui::elements::reveal::Reveal::axis", "name": "axis", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::reveal", "path": "gpui::elements::reveal", "source": "crates/gpui/src/elements/reveal.rs", "summary": "Reveal along `axis`. The default is [`Axis::Vertical`].", "documentation": "Reveal along `axis`. The default is [`Axis::Vertical`].", "signature": "pub fn axis (mut self, axis : Axis) -> Self", "cfg": [], "target": "Reveal" }, { "id": "gpui::elements::reveal::Reveal::from_end", "name": "from_end", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::reveal", "path": "gpui::elements::reveal", "source": "crates/gpui/src/elements/reveal.rs", "summary": "Anchor the natural child to the physical bottom or right edge instead of the top or left edge while it is partially revealed.", "documentation": "Anchor the natural child to the physical bottom or right edge instead\nof the top or left edge while it is partially revealed.", "signature": "pub fn from_end (mut self) -> Self", "cfg": [], "target": "Reveal" }, { "id": "gpui::elements::reveal::reveal", "name": "reveal", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::reveal", "path": "gpui::elements::reveal", "source": "crates/gpui/src/elements/reveal.rs", "summary": "Measures `child` at its natural extent, contributes `progress` of that extent to layout, and clips the subtree to the contributed bounds.", "documentation": "Measures `child` at its natural extent, contributes `progress` of that\nextent to layout, and clips the subtree to the contributed bounds.\n\n`Reveal` owns geometry, clipping, hit testing, and accessibility bounds; it\nowns no clock or easing policy. The caller supplies a normalized progress\nvalue on each frame. Values outside `0..=1` are clamped, and a non-finite\nvalue is treated as zero.\n\nThe primary axis is measured without a maximum so the child does not chase\nthe shrinking frame around it. Cross-axis constraints still come from the\nparent. At zero progress the child is measured but is neither prepainted nor\naddressable. During a partial reveal the child keeps its natural size under\na content mask, so visible pixels, hitboxes, and accessibility bounds agree.\nA stable `id` retains the latest natural measurement across frames; when\nthat measurement changes, `Reveal` requests one ordinary refresh.", "signature": "pub fn reveal (id : impl Into, progress : f32, child : impl IntoElement) -> Reveal", "cfg": [] }, { "id": "gpui::elements::scroll_target::ScrollTarget", "name": "ScrollTarget", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::scroll_target", "path": "gpui::elements::scroll_target", "source": "crates/gpui/src/elements/scroll_target.rs", "summary": "Something that scrolls, and can say where it is and how much further it could go.", "documentation": "Something that scrolls, and can say where it is and how much further it\ncould go.", "signature": "# [doc = \" Something that scrolls, and can say where it is and how much further it\"] # [doc = \" could go.\"] pub trait ScrollTarget { # [doc = \" The distance from the viewport to the start of the content: zero at the\"] # [doc = \" start, negative once the reader has moved down or to the right.\"] fn scroll_offset (& self) -> Point; # [doc = \" How much further the content reaches beyond the viewport, in each axis.\"] # [doc = \" Zero on an axis means there is nothing more that way.\"] fn max_scroll_offset (& self) -> Point; # [doc = \" The region the content is seen through.\"] # [doc = \"\"] # [doc = \" A target that has not been laid out yet reports a zero-sized bounds,\"] # [doc = \" which is the honest answer: it does not know, and it is not scrolled.\"] fn scroll_viewport (& self) -> Bounds; # [doc = \" Puts the content at `offset`, in the sign [`Self::scroll_offset`]\"] # [doc = \" reports.\"] fn set_scroll_offset (& self, offset : Point); # [doc = \" Notes that a scrollbar drag has begun or ended.\"] # [doc = \"\"] # [doc = \" A target that measures lazily holds the height it reports still while\"] # [doc = \" this is true, so the thumb stays under the pointer that is dragging it.\"] fn set_scroll_dragging (& self, _dragging : bool) { } }", "cfg": [] }, { "id": "gpui::elements::scroll_target::scroll_progress", "name": "scroll_progress", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::scroll_target", "path": "gpui::elements::scroll_target", "source": "crates/gpui/src/elements/scroll_target.rs", "summary": "How far along a target is, from `0.0` at the start to `1.0` at the end.", "documentation": "How far along a target is, from `0.0` at the start to `1.0` at the end.\n\nA target with nothing to scroll is at the start, not at the end: there is\nno content below, but the reader has not gone anywhere either.", "signature": "pub fn scroll_progress (target : & dyn ScrollTarget) -> Point", "cfg": [] }, { "id": "gpui::elements::selectable_text::AccessibleTextCache", "name": "AccessibleTextCache", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Revision-keyed logical text publication. Offscreen unchanged leaves are retained in AccessKit; visible and previously visible leaves refresh their geometry. Own one cache per text surface, never share it between windows.", "documentation": "Revision-keyed logical text publication. Offscreen unchanged leaves are\nretained in AccessKit; visible and previously visible leaves refresh their\ngeometry. Own one cache per text surface, never share it between windows.", "signature": "# [doc = \" Revision-keyed logical text publication. Offscreen unchanged leaves are\"] # [doc = \" retained in AccessKit; visible and previously visible leaves refresh their\"] # [doc = \" geometry. Own one cache per text surface, never share it between windows.\"] # [derive (Default)] pub struct AccessibleTextCache { source : SharedString, revision : u64, parent : Option, direction : Option, rows : Vec>, runs : Arc<[AccessibleRun]>, ids : Arc<[accesskit::NodeId]>, published : Option, visible : Vec>, visible_nodes : collections::FxHashMap, clip : Option, transform : crate::TransformationMatrix, document : Option, representation : Option<(SharedString, bool)>, work : AccessibleTextWork, }", "cfg": [] }, { "id": "gpui::elements::selectable_text::AccessibleTextCache::is_representable", "name": "is_representable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Caches the complete grapheme representability check by immutable source storage. This does not suppress native Value for unrepresentable runs.", "documentation": "Caches the complete grapheme representability check by immutable source\nstorage. This does not suppress native Value for unrepresentable runs.", "signature": "pub fn is_representable (& mut self, text : & SharedString) -> bool", "cfg": [], "target": "AccessibleTextCache" }, { "id": "gpui::elements::selectable_text::AccessibleTextCache::publish", "name": "publish", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Publishes current selection and viewport geometry without rebuilding unchanged logical runs. `visible` must cover every byte whose geometry callback can return cells. Text/row/direction changes invalidate the logical cache; clipping and viewport changes refresh visible leaves.", "documentation": "Publishes current selection and viewport geometry without rebuilding\nunchanged logical runs. `visible` must cover every byte whose geometry\ncallback can return cells. Text/row/direction changes invalidate the\nlogical cache; clipping and viewport changes refresh visible leaves.", "signature": "pub fn publish (& mut self, builder : & mut A11ySubtreeBuilder, text : & str, anchor : usize, focus : usize, direction : accesskit::TextDirection, rows : & [Range], revision : u64, visible : Range, scale : f32, geometry : impl Fn (Range) -> Vec>,) -> Option", "cfg": [], "target": "AccessibleTextCache" }, { "id": "gpui::elements::selectable_text::AccessibleTextCache::publish_document", "name": "publish_document", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Publishes a persistent document, resegmenting only changed LF-delimited paragraphs when rows and direction outside the edit remain unchanged. LF is a Unicode bidi/word reset boundary; arbitrary visual rows are not. Source snapshots and run metadata remain complete, including offscreen paragraphs. Native actions are still checked against the exact revision.", "documentation": "Publishes a persistent document, resegmenting only changed LF-delimited\nparagraphs when rows and direction outside the edit remain unchanged.\nLF is a Unicode bidi/word reset boundary; arbitrary visual rows are not.\nSource snapshots and run metadata remain complete, including offscreen\nparagraphs. Native actions are still checked against the exact revision.", "signature": "pub fn publish_document (& mut self, builder : & mut A11ySubtreeBuilder, document : & EditSnapshot, anchor : usize, focus : usize, direction : accesskit::TextDirection, rows : & [Range], revision : u64, visible : Range, scale : f32, geometry : impl Fn (Range) -> Vec>,) -> Option", "cfg": [], "target": "AccessibleTextCache" }, { "id": "gpui::elements::selectable_text::AccessibleTextCache::publish_document_regions", "name": "publish_document_regions", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Publishes disjoint painted regions without treating omitted source gaps as visible. Logical text remains complete, including folded paragraphs.", "documentation": "Publishes disjoint painted regions without treating omitted source gaps\nas visible. Logical text remains complete, including folded paragraphs.", "signature": "pub fn publish_document_regions (& mut self, builder : & mut A11ySubtreeBuilder, document : & EditSnapshot, anchor : usize, focus : usize, direction : accesskit::TextDirection, rows : & [Range], revision : u64, visible : Vec>, scale : f32, geometry : impl Fn (Range) -> Vec>,) -> Option", "cfg": [], "target": "AccessibleTextCache" }, { "id": "gpui::elements::selectable_text::AccessibleTextCache::work", "name": "work", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Work performed in the last publication, not cumulative totals.", "documentation": "Work performed in the last publication, not cumulative totals.", "signature": "pub fn work (& self) -> AccessibleTextWork", "cfg": [], "target": "AccessibleTextCache" }, { "id": "gpui::elements::selectable_text::AccessibleTextWork", "name": "AccessibleTextWork", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Actual text work in the most recent accessible publication. Metadata and parent child-id lists are separate, still linear work; these counters do not claim an allocation bound for the entire AccessKit update.", "documentation": "Actual text work in the most recent accessible publication. Metadata and\nparent child-id lists are separate, still linear work; these counters do\nnot claim an allocation bound for the entire AccessKit update.", "signature": "# [doc = \" Actual text work in the most recent accessible publication. Metadata and\"] # [doc = \" parent child-id lists are separate, still linear work; these counters do\"] # [doc = \" not claim an allocation bound for the entire AccessKit update.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct AccessibleTextWork { # [doc = \" Bytes inspected by the last explicit representability check. Unchanged\"] # [doc = \" shared source storage requires zero; a new value is scanned once.\"] pub representability_bytes : usize, # [doc = \" UTF-8 bytes passed to Unicode segmentation and bidi resolution.\"] pub segmented_bytes : usize, # [doc = \" Actual persistent-snapshot byte comparisons used to locate the edit.\"] pub compared_bytes : usize, # [doc = \" TextRun payloads transmitted in this update.\"] pub published_runs : usize, # [doc = \" UTF-8 value bytes transmitted in TextRun payloads.\"] pub published_text_bytes : usize, # [doc = \" Existing TextRuns connected without retransmitting their payloads.\"] pub retained_runs : usize, }", "cfg": [] }, { "id": "gpui::elements::selectable_text::PublishedAccessibleText", "name": "PublishedAccessibleText", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "A snapshot of the text runs most recently published to AccessKit.", "documentation": "A snapshot of the text runs most recently published to AccessKit.\n\nKeep this beside the text revision that produced it. Accessibility actions\nmay arrive after a new frame, so positions from a stale tree must not be\ninterpreted against different text.", "signature": "# [doc = \" A snapshot of the text runs most recently published to AccessKit.\"] # [doc = \"\"] # [doc = \" Keep this beside the text revision that produced it. Accessibility actions\"] # [doc = \" may arrive after a new frame, so positions from a stale tree must not be\"] # [doc = \" interpreted against different text.\"] # [derive (Clone, Debug)] pub struct PublishedAccessibleText { source : SharedString, revision : u64, runs : Arc<[PublishedRun]>, }", "cfg": [] }, { "id": "gpui::elements::selectable_text::accessible_text_is_representable", "name": "accessible_text_is_representable", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Returns whether every selectable grapheme can be represented by AccessKit.", "documentation": "Returns whether every selectable grapheme can be represented by AccessKit.", "signature": "pub fn accessible_text_is_representable (text : & str) -> bool", "cfg": [] }, { "id": "gpui::elements::selectable_text::byte_offset_for_published_position", "name": "byte_offset_for_published_position", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Resolves an AccessKit text position only against the exact value and revision for which its synthetic run ids were published.", "documentation": "Resolves an AccessKit text position only against the exact value and\nrevision for which its synthetic run ids were published.", "signature": "pub fn byte_offset_for_published_position (current_text : & str, current_revision : u64, published : & PublishedAccessibleText, position : accesskit::TextPosition,) -> Option", "cfg": [] }, { "id": "gpui::elements::selectable_text::publish_accessible_text", "name": "publish_accessible_text", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Publishes logical text runs and the current selection below an accessible text element.", "documentation": "Publishes logical text runs and the current selection below an accessible\ntext element.\n\n`visual_rows` contains UTF-8 ranges in visual row order. Runs are split at\nbidirectional boundaries and AccessKit's 255-character run limit.", "signature": "pub fn publish_accessible_text (builder : & mut A11ySubtreeBuilder, text : & str, anchor_byte : usize, focus_byte : usize, fallback_direction : accesskit::TextDirection, visual_rows : & [Range], revision : u64,) -> Option", "cfg": [] }, { "id": "gpui::elements::selectable_text::publish_accessible_text_with_geometry", "name": "publish_accessible_text_with_geometry", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::selectable_text", "path": "gpui::elements::selectable_text", "source": "crates/gpui/src/elements/selectable_text.rs", "summary": "Publishes selectable text with per-grapheme geometry.", "documentation": "Publishes selectable text with per-grapheme geometry.\n\nBounds returned by `bounds_for_range` are in GPUI logical pixels. They are\nscaled here to the physical coordinates used by the parent AccessKit node.", "signature": "pub fn publish_accessible_text_with_geometry (builder : & mut A11ySubtreeBuilder, text : & str, anchor_byte : usize, focus_byte : usize, fallback_direction : accesskit::TextDirection, visual_rows : & [Range], revision : u64, scale_factor : f32, bounds_for_range : impl Fn (Range) -> Vec>,) -> Option", "cfg": [] }, { "id": "gpui::elements::sticky::Sticky", "name": "Sticky", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::sticky", "path": "gpui::elements::sticky", "source": "crates/gpui/src/elements/sticky.rs", "summary": "An element held against one horizontal physical edge of the current clipped viewport.", "documentation": "An element held against one horizontal physical edge of the current clipped\nviewport.", "signature": "# [doc = \" An element held against one horizontal physical edge of the current clipped\"] # [doc = \" viewport.\"] pub struct Sticky { edge : StickyEdge, child : Option, }", "cfg": [] }, { "id": "gpui::elements::sticky::StickyEdge", "name": "StickyEdge", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::sticky", "path": "gpui::elements::sticky", "source": "crates/gpui/src/elements/sticky.rs", "summary": "A horizontal physical viewport edge that can hold a [`Sticky`] element in place.", "documentation": "A horizontal physical viewport edge that can hold a [`Sticky`] element in\nplace.", "signature": "# [doc = \" A horizontal physical viewport edge that can hold a [`Sticky`] element in\"] # [doc = \" place.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum StickyEdge { # [doc = \" The left edge of the current content mask.\"] Left, # [doc = \" The right edge of the current content mask.\"] Right, }", "cfg": [] }, { "id": "gpui::elements::sticky::sticky", "name": "sticky", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::sticky", "path": "gpui::elements::sticky", "source": "crates/gpui/src/elements/sticky.rs", "summary": "Keeps `child` against `edge` while its normal layout position crosses the current clipped viewport.", "documentation": "Keeps `child` against `edge` while its normal layout position crosses the\ncurrent clipped viewport.\n\nThe child still participates in ordinary layout. During prepaint its whole\nsubtree is translated to the held position and deferred above scrolling\nsiblings, while retaining the content mask that established the viewport.\nPaint, hit testing, and accessibility bounds therefore use the same\ntranslated geometry. The edge is physical; callers implementing reading\ndirection choose left or right explicitly.", "signature": "pub fn sticky (edge : StickyEdge, child : impl IntoElement) -> Sticky", "cfg": [] }, { "id": "gpui::elements::surface::Surface", "name": "Surface", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::surface", "path": "gpui::elements::surface", "source": "crates/gpui/src/elements/surface.rs", "summary": "A surface element.", "documentation": "A surface element.", "signature": "# [doc = \" A surface element.\"] pub struct Surface { source : SurfaceSource, object_fit : ObjectFit, style : StyleRefinement, }", "cfg": [] }, { "id": "gpui::elements::surface::Surface::object_fit", "name": "object_fit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::surface", "path": "gpui::elements::surface", "source": "crates/gpui/src/elements/surface.rs", "summary": "Set the object fit for the image.", "documentation": "Set the object fit for the image.", "signature": "pub fn object_fit (mut self, object_fit : ObjectFit) -> Self", "cfg": [], "target": "Surface" }, { "id": "gpui::elements::surface::SurfaceSource", "name": "SurfaceSource", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::surface", "path": "gpui::elements::surface", "source": "crates/gpui/src/elements/surface.rs", "summary": "A source of a surface's content.", "documentation": "A source of a surface's content.", "signature": "# [doc = \" A source of a surface's content.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub enum SurfaceSource { # [doc = \" A macOS image buffer from CoreVideo\"] # [cfg (target_os = \"macos\")] Surface (CVPixelBuffer), }", "cfg": [] }, { "id": "gpui::elements::surface::surface", "name": "surface", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::surface", "path": "gpui::elements::surface", "source": "crates/gpui/src/elements/surface.rs", "summary": "Create a new surface element.", "documentation": "Create a new surface element.", "signature": "pub fn surface (source : impl Into) -> Surface", "cfg": [ "cfg (target_os = \"macos\")" ] }, { "id": "gpui::elements::svg::Svg", "name": "Svg", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "An SVG element.", "documentation": "An SVG element.", "signature": "# [doc = \" An SVG element.\"] pub struct Svg { interactivity : Interactivity, transformation : Option, path : Option, external_path : Option, }", "cfg": [] }, { "id": "gpui::elements::svg::Svg::external_path", "name": "external_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Set the path to the SVG file for this element.", "documentation": "Set the path to the SVG file for this element.", "signature": "pub fn external_path (mut self, path : impl Into) -> Self", "cfg": [], "target": "Svg" }, { "id": "gpui::elements::svg::Svg::path", "name": "path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Set the path to the SVG file for this element.", "documentation": "Set the path to the SVG file for this element.", "signature": "pub fn path (mut self, path : impl Into) -> Self", "cfg": [], "target": "Svg" }, { "id": "gpui::elements::svg::Svg::with_transformation", "name": "with_transformation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Transform the SVG element with the given transformation. Note that this won't effect the hitbox or layout of the element, only the rendering.", "documentation": "Transform the SVG element with the given transformation.\nNote that this won't effect the hitbox or layout of the element, only the rendering.", "signature": "pub fn with_transformation (mut self, transformation : Transformation) -> Self", "cfg": [], "target": "Svg" }, { "id": "gpui::elements::svg::Transformation", "name": "Transformation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "A transformation to apply to an SVG element.", "documentation": "A transformation to apply to an SVG element.", "signature": "# [doc = \" A transformation to apply to an SVG element.\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct Transformation { scale : Size, translate : Point, rotate : Radians, }", "cfg": [] }, { "id": "gpui::elements::svg::Transformation::rotate", "name": "rotate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Create a new Transformation with the specified rotation in radians.", "documentation": "Create a new Transformation with the specified rotation in radians.", "signature": "pub fn rotate (rotate : impl Into) -> Self", "cfg": [], "target": "Transformation" }, { "id": "gpui::elements::svg::Transformation::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Create a new Transformation with the specified scale along each axis.", "documentation": "Create a new Transformation with the specified scale along each axis.", "signature": "pub fn scale (scale : Size) -> Self", "cfg": [], "target": "Transformation" }, { "id": "gpui::elements::svg::Transformation::translate", "name": "translate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Create a new Transformation with the specified translation.", "documentation": "Create a new Transformation with the specified translation.", "signature": "pub fn translate (translate : Point) -> Self", "cfg": [], "target": "Transformation" }, { "id": "gpui::elements::svg::Transformation::with_rotation", "name": "with_rotation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Update the rotation angle of this transformation.", "documentation": "Update the rotation angle of this transformation.", "signature": "pub fn with_rotation (mut self, rotate : impl Into) -> Self", "cfg": [], "target": "Transformation" }, { "id": "gpui::elements::svg::Transformation::with_scaling", "name": "with_scaling", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Update the scaling factor of this transformation.", "documentation": "Update the scaling factor of this transformation.", "signature": "pub fn with_scaling (mut self, scale : Size) -> Self", "cfg": [], "target": "Transformation" }, { "id": "gpui::elements::svg::Transformation::with_translation", "name": "with_translation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Update the translation value of this transformation.", "documentation": "Update the translation value of this transformation.", "signature": "pub fn with_translation (mut self, translate : Point) -> Self", "cfg": [], "target": "Transformation" }, { "id": "gpui::elements::svg::svg", "name": "svg", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::svg", "path": "gpui::elements::svg", "source": "crates/gpui/src/elements/svg.rs", "summary": "Create a new SVG element.", "documentation": "Create a new SVG element.", "signature": "pub fn svg () -> Svg", "cfg": [] }, { "id": "gpui::elements::text::InteractiveText", "name": "InteractiveText", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "A text element that can be interacted with.", "documentation": "A text element that can be interacted with.", "signature": "# [doc = \" A text element that can be interacted with.\"] pub struct InteractiveText { element_id : ElementId, text : StyledText, click_listener : Option], InteractiveTextClickEvent, & mut Window, & mut App)>>, hover_listener : Option, MouseMoveEvent, & mut Window, & mut App)>>, tooltip_builder : Option Option>>, tooltip_id : Option, clickable_ranges : Vec>, selectable : bool, document : Option, }", "cfg": [] }, { "id": "gpui::elements::text::InteractiveText::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Creates a new InteractiveText from the given text.", "documentation": "Creates a new InteractiveText from the given text.", "signature": "pub fn new (id : impl Into, text : StyledText) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::on_click", "name": "on_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "on_click is called when the user clicks on one of the given ranges, passing the index of the clicked range.", "documentation": "on_click is called when the user clicks on one of the given ranges, passing the index of\nthe clicked range.", "signature": "pub fn on_click (mut self, ranges : Vec>, listener : impl Fn (usize, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::on_hover", "name": "on_hover", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "on_hover is called when the mouse moves over a character within the text, passing the index of the hovered character, or None if the mouse leaves the text.", "documentation": "on_hover is called when the mouse moves over a character within the text, passing the\nindex of the hovered character, or None if the mouse leaves the text.", "signature": "pub fn on_hover (mut self, listener : impl Fn (Option, MouseMoveEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::selectable", "name": "selectable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Enable native read-only text selection.", "documentation": "Enable native read-only text selection.\n\nSelection is grapheme-safe, continues beyond the element while the\npointer is captured, supports Copy and Select All, and is exposed as\nAccessKit text runs. Existing clickable ranges still activate on a\nclick, but not when the same gesture selected text.", "signature": "pub fn selectable (mut self) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::selectable_in_document", "name": "selectable_in_document", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Joins this element to its window's document selection.", "documentation": "Joins this element to its window's document selection.\n\nOne drag then spans every participating element between its two ends,\nin the reading order they declare, rather than stopping at whichever\nvalue happened to be mounted first. `key` is business identity and\n`order` is reading order; neither may be a list position, because a\nselection that follows the viewport instead of the text is the bug this\nreplaces.\n\nA document participant does not also keep a private selection: the two\nwould disagree about the same drag.", "signature": "pub fn selectable_in_document (mut self, key : impl Into, order : u64,) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::sensitive_participant", "name": "sensitive_participant", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Refuses to take part in the document selection at all.", "documentation": "Refuses to take part in the document selection at all.\n\nA sensitive value is never registered, so it cannot reach the aggregate\ncopy path by being mounted beside content that can.", "signature": "pub fn sensitive_participant (mut self, sensitive : bool) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::tooltip", "name": "tooltip", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "tooltip lets you specify a tooltip for a given character index in the string.", "documentation": "tooltip lets you specify a tooltip for a given character index in the string.", "signature": "pub fn tooltip (mut self, builder : impl Fn (usize, & mut Window, & mut App) -> Option + 'static,) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveText::virtualized_participant", "name": "virtualized_participant", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "States that this participant is one mounted window onto a longer run, such as a virtualized log or diff.", "documentation": "States that this participant is one mounted window onto a longer run,\nsuch as a virtualized log or diff.\n\nA copy whose span crosses it reports itself incomplete, because the\nrows in between were never rendered and GPUI will not invent them.", "signature": "pub fn virtualized_participant (mut self, virtualized : bool) -> Self", "cfg": [], "target": "InteractiveText" }, { "id": "gpui::elements::text::InteractiveTextPrepaintState", "name": "InteractiveTextPrepaintState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct InteractiveTextPrepaintState { hitbox : Hitbox, selection_quads : Vec, selection : Rc>, fallback_direction : accesskit::TextDirection, text_align : TextAlign, scale_factor : f32, }", "cfg": [] }, { "id": "gpui::elements::text::InteractiveTextState", "name": "InteractiveTextState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Default)] pub struct InteractiveTextState { mouse_down_index : Rc>>, hovered_index : Rc>>, active_tooltip : Rc>>, selection : Rc>, focus_handle : Option, }", "cfg": [] }, { "id": "gpui::elements::text::StyledText", "name": "StyledText", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Renders text with runs of different styles.", "documentation": "Renders text with runs of different styles.\n\nCallers are responsible for setting the correct style for each run.\nFor text with a uniform style, you can usually avoid calling this constructor\nand just pass text directly.", "signature": "# [doc = \" Renders text with runs of different styles.\"] # [doc = \"\"] # [doc = \" Callers are responsible for setting the correct style for each run.\"] # [doc = \" For text with a uniform style, you can usually avoid calling this constructor\"] # [doc = \" and just pass text directly.\"] pub struct StyledText { text : SharedString, runs : Option>, delayed_highlights : Option, HighlightStyle)>>, delayed_font_family_overrides : Option, SharedString)>>, layout : TextLayout, }", "cfg": [] }, { "id": "gpui::elements::text::StyledText::layout", "name": "layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Get the layout for this element. This can be used to map indices to pixels and vice versa.", "documentation": "Get the layout for this element. This can be used to map indices to pixels and vice versa.", "signature": "pub fn layout (& self) -> & TextLayout", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Construct a new styled text element from the given string.", "documentation": "Construct a new styled text element from the given string.", "signature": "pub fn new (text : impl Into) -> Self", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::selectable", "name": "selectable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Make this styled text selectable with standard pointer, keyboard, clipboard, and accessibility behavior.", "documentation": "Make this styled text selectable with standard pointer, keyboard,\nclipboard, and accessibility behavior.\n\nThe id retains the transient selection and focus state across frames.", "signature": "pub fn selectable (self, id : impl Into) -> InteractiveText", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::selectable_in_document", "name": "selectable_in_document", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Make this styled text part of its window's document selection, so one drag reaches every participating element between its two ends.", "documentation": "Make this styled text part of its window's document selection, so one\ndrag reaches every participating element between its two ends.\n\n`key` is business identity and `order` is reading order. See\n[`InteractiveText::selectable_in_document`].", "signature": "pub fn selectable_in_document (self, id : impl Into, key : impl Into, order : u64,) -> InteractiveText", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::with_default_highlights", "name": "with_default_highlights", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Set the styling attributes for the given text, as well as as any ranges of text that have had their style customized.", "documentation": "Set the styling attributes for the given text, as well as\nas any ranges of text that have had their style customized.", "signature": "pub fn with_default_highlights (mut self, default_style : & TextStyle, highlights : impl IntoIterator, HighlightStyle)>,) -> Self", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::with_font_family_overrides", "name": "with_font_family_overrides", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Override the font family for specific byte ranges of the text.", "documentation": "Override the font family for specific byte ranges of the text.\n\nThis is resolved lazily at layout time, so the overrides are applied\non top of the inherited text style from the parent element.\nCan be combined with [`with_highlights`](Self::with_highlights).\n\nThe overrides must be sorted by range start and non-overlapping.\nEach override range must fall on character boundaries.", "signature": "pub fn with_font_family_overrides (mut self, overrides : impl IntoIterator, SharedString)>,) -> Self", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::with_highlights", "name": "with_highlights", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Set the styling attributes for the given text, as well as as any ranges of text that have had their style customized.", "documentation": "Set the styling attributes for the given text, as well as\nas any ranges of text that have had their style customized.", "signature": "pub fn with_highlights (mut self, highlights : impl IntoIterator, HighlightStyle)>,) -> Self", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::StyledText::with_runs", "name": "with_runs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Set the text runs for this piece of text.", "documentation": "Set the text runs for this piece of text.", "signature": "pub fn with_runs (mut self, runs : Vec) -> Self", "cfg": [], "target": "StyledText" }, { "id": "gpui::elements::text::Text", "name": "Text", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "An [`Element`] that renders text.", "documentation": "An [`Element`] that renders text.\n\nIn general, [`Text`] objects should be created via the\n[`text!`](crate::text!) macro:\n```rust\n# use gpui::*;\n# fn render() -> impl IntoElement {\ndiv().child(text!(\"hello\"))\n# }\n```\n## IDs and Accessibility\n\n[`Text`] elements have an ID. This ID is primarily used to produce nodes in\nthe accessibility tree, which allows the text to be visible to screen\nreaders and other assistive technologies.\n\nThis ID is stable across frames. If the same text, with the same ID, is\npresent in two consecutive frames, no updates are reported to the screen\nreader. If the text changes, but the ID stays the same, then the screen\nreader will be notified that a text node's content has changed. **However**,\nif the ID changes, then the screen reader will be notified that a node has\nbeen removed, and a new node has been added.\n\nWhen using the [`text!`](crate::text!) macro, each invocation of the macro will get a\nunique ID, derived from its position in the source code (filename, line, and\ncolumn). For example:\n```rust\n# use gpui::*;\nlet x = text!(\"hello\");\nlet y = text!(\"hello\");\n// not equal, because different `text!` invocations produced them\nassert_ne!(x.id(), y.id());\n\nfn make_text(s: &str) -> Text { text!(s) }\nlet x = make_text(\"hello\");\nlet y = make_text(\"hello\");\n// equal, because the same `text!` invocation produced them\nassert_eq!(x.id(), y.id());\n```\nWhen the contents of an invocation of [`text!`](crate::text!) do not change, this\ndistinction is less relevant (with the caveat that you still need to take\ncare to ensure that duplicate IDs do not appear).\n\nHowever, when a [`text!`](crate::text!) invocation's argument *does* change, you should\nconsider whether this change should be reported as a node \"updating its\ncontents\", or an old node being destroyed and a new node being created.", "signature": "# [doc = \" An [`Element`] that renders text.\"] # [doc = \"\"] # [doc = \" In general, [`Text`] objects should be created via the\"] # [doc = \" [`text!`](crate::text!) macro:\"] # [doc = \" ```rust\"] # [doc = \" # use gpui::*;\"] # [doc = \" # fn render() -> impl IntoElement {\"] # [doc = \" div().child(text!(\\\"hello\\\"))\"] # [doc = \" # }\"] # [doc = \" ```\"] # [doc = \" ## IDs and Accessibility\"] # [doc = \"\"] # [doc = \" [`Text`] elements have an ID. This ID is primarily used to produce nodes in\"] # [doc = \" the accessibility tree, which allows the text to be visible to screen\"] # [doc = \" readers and other assistive technologies.\"] # [doc = \"\"] # [doc = \" This ID is stable across frames. If the same text, with the same ID, is\"] # [doc = \" present in two consecutive frames, no updates are reported to the screen\"] # [doc = \" reader. If the text changes, but the ID stays the same, then the screen\"] # [doc = \" reader will be notified that a text node's content has changed. **However**,\"] # [doc = \" if the ID changes, then the screen reader will be notified that a node has\"] # [doc = \" been removed, and a new node has been added.\"] # [doc = \"\"] # [doc = \" When using the [`text!`](crate::text!) macro, each invocation of the macro will get a\"] # [doc = \" unique ID, derived from its position in the source code (filename, line, and\"] # [doc = \" column). For example:\"] # [doc = \" ```rust\"] # [doc = \" # use gpui::*;\"] # [doc = \" let x = text!(\\\"hello\\\");\"] # [doc = \" let y = text!(\\\"hello\\\");\"] # [doc = \" // not equal, because different `text!` invocations produced them\"] # [doc = \" assert_ne!(x.id(), y.id());\"] # [doc = \"\"] # [doc = \" fn make_text(s: &str) -> Text { text!(s) }\"] # [doc = \" let x = make_text(\\\"hello\\\");\"] # [doc = \" let y = make_text(\\\"hello\\\");\"] # [doc = \" // equal, because the same `text!` invocation produced them\"] # [doc = \" assert_eq!(x.id(), y.id());\"] # [doc = \" ```\"] # [doc = \" When the contents of an invocation of [`text!`](crate::text!) do not change, this\"] # [doc = \" distinction is less relevant (with the caveat that you still need to take\"] # [doc = \" care to ensure that duplicate IDs do not appear).\"] # [doc = \"\"] # [doc = \" However, when a [`text!`](crate::text!) invocation's argument *does* change, you should\"] # [doc = \" consider whether this change should be reported as a node \\\"updating its\"] # [doc = \" contents\\\", or an old node being destroyed and a new node being created.\"] # [derive (Debug, Clone)] pub struct Text { id : Option, text : SharedString, }", "cfg": [] }, { "id": "gpui::elements::text::Text::id", "name": "id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The ID of this [`Text`] element.", "documentation": "The ID of this [`Text`] element.", "signature": "pub const fn id (& self) -> Option<& ElementId>", "cfg": [], "target": "Text" }, { "id": "gpui::elements::text::Text::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Create a new [`Text`] element with a specific ID.", "documentation": "Create a new [`Text`] element with a specific ID.\n\nIf you want a unique ID to be assigned automatically, use the\n[`text!`](crate::text!) macro. The docs for [`Text`] have more detail\nabout choosing IDs.", "signature": "pub const fn new (id : ElementId, text : SharedString) -> Self", "cfg": [], "target": "Text" }, { "id": "gpui::elements::text::Text::new_inaccessible", "name": "new_inaccessible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Create a new [`Text`] element that is inaccessible to screen readers.", "documentation": "Create a new [`Text`] element that is inaccessible to screen readers.\n\nIn order for text to be accessible to screen readers, it must have an ID\nprovided. If you want text to be accessible, either use\n[`text!`](crate::text!) to have an ID automatically assigned, or use\n[`Text::new`] to manually assign an ID.\n\nThis function is intended for use inside custom UI components, where\naccessible properties may be set on parent containers.", "signature": "pub const fn new_inaccessible (text : SharedString) -> Self", "cfg": [], "target": "Text" }, { "id": "gpui::elements::text::Text::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The text that this [`Text`] element will display.", "documentation": "The text that this [`Text`] element will display.", "signature": "pub const fn text (& self) -> & SharedString", "cfg": [], "target": "Text" }, { "id": "gpui::elements::text::Text::with_id", "name": "with_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Produce a new [`Text`] with the given `id`.", "documentation": "Produce a new [`Text`] with the given `id`.", "signature": "pub fn with_id (mut self, id : impl Into) -> Self", "cfg": [], "target": "Text" }, { "id": "gpui::elements::text::TextLayout", "name": "TextLayout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The Layout for TextElement. This can be used to map indices to pixels and vice versa.", "documentation": "The Layout for TextElement. This can be used to map indices to pixels and vice versa.", "signature": "# [doc = \" The Layout for TextElement. This can be used to map indices to pixels and vice versa.\"] # [derive (Default, Clone)] pub struct TextLayout (Rc>>);", "cfg": [] }, { "id": "gpui::elements::text::TextLayout::bounds", "name": "bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The bounds of this layout.", "documentation": "The bounds of this layout.", "signature": "pub fn bounds (& self) -> Bounds", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::bounds_for_range", "name": "bounds_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Returns layout-space rectangles occupied by a source byte range, suitable for painting overlays in the same scope. Unlike `position_for_index`, these are not mapped to displayed coordinates.", "documentation": "Returns layout-space rectangles occupied by a source byte range, suitable\nfor painting overlays in the same scope. Unlike `position_for_index`,\nthese are not mapped to displayed coordinates.\n\nThe result may contain multiple rectangles for wrapped or\nbidirectional text. The caller supplies the same alignment used to\npaint the text.", "signature": "pub fn bounds_for_range (& self, range : Range, align : TextAlign) -> Vec>", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::closest_index_for_position", "name": "closest_index_for_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Returns the selectable byte boundary closest to a window position.", "documentation": "Returns the selectable byte boundary closest to a window position.\n\nPositions above or below the element clamp to the start or end. A\nposition outside a visual row clamps to that row's nearest edge, which\nkeeps pointer selection stable while dragging beyond the text bounds.", "signature": "pub fn closest_index_for_position (& self, position : Point) -> usize", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::index_for_position", "name": "index_for_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Get the byte index at a displayed window-global pixel position.", "documentation": "Get the byte index at a displayed window-global pixel position.", "signature": "pub fn index_for_position (& self, mut position : Point) -> Result", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Returns whether the underlying text is empty.", "documentation": "Returns whether the underlying text is empty.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The UTF-8 length of the underlying text.", "documentation": "The UTF-8 length of the underlying text.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::line_height", "name": "line_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The line height for this layout.", "documentation": "The line height for this layout.", "signature": "pub fn line_height (& self) -> Pixels", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::line_layout_for_index", "name": "line_layout_for_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Retrieve the layout for the line containing the given byte index.", "documentation": "Retrieve the layout for the line containing the given byte index.", "signature": "pub fn line_layout_for_index (& self, index : usize) -> Option>", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::line_layouts", "name": "line_layouts", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Retrieve all line layouts in source order.", "documentation": "Retrieve all line layouts in source order.", "signature": "pub fn line_layouts (& self) -> SmallVec<[Arc; 1]>", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::position_for_index", "name": "position_for_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Get the displayed window pixel position for the given byte index.", "documentation": "Get the displayed window pixel position for the given byte index.", "signature": "pub fn position_for_index (& self, index : usize) -> Option>", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The text for this layout.", "documentation": "The text for this layout.", "signature": "pub fn text (& self) -> String", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::visual_rows", "name": "visual_rows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Returns source byte ranges for all shaped visual rows.", "documentation": "Returns source byte ranges for all shaped visual rows.\n\nA hard line break belongs to the visual row before it. Soft wrapping\nintroduces a new row without introducing a source byte.", "signature": "pub fn visual_rows (& self) -> Vec>", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::TextLayout::wrapped_text", "name": "wrapped_text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "The text for this layout (with soft-wraps as newlines)", "documentation": "The text for this layout (with soft-wraps as newlines)", "signature": "pub fn wrapped_text (& self) -> String", "cfg": [], "target": "TextLayout" }, { "id": "gpui::elements::text::__hash_text_macro_location_unstable_do_not_use", "name": "__hash_text_macro_location_unstable_do_not_use", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Trivial hash function for the location information produced by the [`text`] macro. Not covered by semver guarantees. Performance is not particularly significant because it's only used on small strings in const contexts.", "documentation": "Trivial hash function for the location information produced by the [`text`]\nmacro. Not covered by semver guarantees. Performance is not particularly\nsignificant because it's only used on small strings in const contexts.", "signature": "pub const fn __hash_text_macro_location_unstable_do_not_use (s : & 'static str) -> u64", "cfg": [] }, { "id": "gpui::elements::text::text", "name": "text", "kind": "macro", "package": "gpui-box", "crate": "gpui", "module": "elements::text", "path": "gpui::elements::text", "source": "crates/gpui/src/elements/text.rs", "summary": "Create a new [`Text`] element.", "documentation": "Create a new [`Text`] element.\n\n```rust\n# use gpui::*;\nlet a = text!(\"hello\");\nlet b = text!(id = \"farewell-message\", \"hello\");\n\n```\n\nText created with this macro is *accessible*. The macro generates an ID\nbased on the source location. See the docs for [`Text`] for a more in-depth\nexplanation of the significance of the ID of a [`Text`] element.", "signature": "macro_rules! text", "cfg": [] }, { "id": "gpui::elements::uniform_list::DeferredScrollToItem", "name": "DeferredScrollToItem", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug)] # [allow (missing_docs)] pub struct DeferredScrollToItem { # [doc = \" The item index to scroll to\"] pub item_index : usize, # [doc = \" The scroll strategy to use\"] pub strategy : ScrollStrategy, # [doc = \" The offset in number of items\"] pub offset : usize, pub scroll_strict : bool, }", "cfg": [] }, { "id": "gpui::elements::uniform_list::ItemSize", "name": "ItemSize", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "The size of the item and its contents.", "documentation": "The size of the item and its contents.", "signature": "# [derive (Copy, Clone, Debug, Default)] # [doc = \" The size of the item and its contents.\"] pub struct ItemSize { # [doc = \" The size of the item.\"] pub item : Size, # [doc = \" The size of the item's contents, which may be larger than the item itself,\"] # [doc = \" if the item was bounded by a parent element.\"] pub contents : Size, }", "cfg": [] }, { "id": "gpui::elements::uniform_list::ScrollStrategy", "name": "ScrollStrategy", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Where to place the element scrolled to.", "documentation": "Where to place the element scrolled to.", "signature": "# [doc = \" Where to place the element scrolled to.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum ScrollStrategy { # [doc = \" Place the element at the top of the list's viewport.\"] Top, # [doc = \" Attempt to place the element in the middle of the list's viewport.\"] # [doc = \" May not be possible if there's not enough list items above the item scrolled to:\"] # [doc = \" in this case, the element will be placed at the closest possible position.\"] Center, # [doc = \" Attempt to place the element at the bottom of the list's viewport.\"] # [doc = \" May not be possible if there's not enough list items above the item scrolled to:\"] # [doc = \" in this case, the element will be placed at the closest possible position.\"] Bottom, # [doc = \" If the element is not visible attempt to place it at:\"] # [doc = \" - The top of the list's viewport if the target element is above currently visible elements.\"] # [doc = \" - The bottom of the list's viewport if the target element is above currently visible elements.\"] Nearest, }", "cfg": [] }, { "id": "gpui::elements::uniform_list::UniformList", "name": "UniformList", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "A list element for efficiently laying out and displaying a list of uniform-height elements.", "documentation": "A list element for efficiently laying out and displaying a list of uniform-height elements.", "signature": "# [doc = \" A list element for efficiently laying out and displaying a list of uniform-height elements.\"] pub struct UniformList { item_count : usize, item_to_measure_index : usize, render_items : Box Fn (Range, & 'a mut Window, & 'a mut App) -> SmallVec<[AnyElement; 64]>,>, decorations : Vec>, interactivity : Interactivity, scroll_handle : Option, sizing_behavior : ListSizingBehavior, horizontal_sizing_behavior : ListHorizontalSizingBehavior, }", "cfg": [] }, { "id": "gpui::elements::uniform_list::UniformList::track_scroll", "name": "track_scroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Track and render scroll state of this list with reference to the given scroll handle.", "documentation": "Track and render scroll state of this list with reference to the given scroll handle.", "signature": "pub fn track_scroll (mut self, handle : & UniformListScrollHandle) -> Self", "cfg": [], "target": "UniformList" }, { "id": "gpui::elements::uniform_list::UniformList::with_decoration", "name": "with_decoration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Adds a decoration element to the list.", "documentation": "Adds a decoration element to the list.", "signature": "pub fn with_decoration (mut self, decoration : impl UniformListDecoration + 'static) -> Self", "cfg": [], "target": "UniformList" }, { "id": "gpui::elements::uniform_list::UniformList::with_horizontal_sizing_behavior", "name": "with_horizontal_sizing_behavior", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Sets the horizontal sizing behavior, controlling the way list items laid out horizontally. With [`ListHorizontalSizingBehavior::Unconstrained`] behavior, every item and the list itself will have the size of the widest item and lay out pushing the `end_slot` to the right end.", "documentation": "Sets the horizontal sizing behavior, controlling the way list items laid out horizontally.\nWith [`ListHorizontalSizingBehavior::Unconstrained`] behavior, every item and the list itself will\nhave the size of the widest item and lay out pushing the `end_slot` to the right end.", "signature": "pub fn with_horizontal_sizing_behavior (mut self, behavior : ListHorizontalSizingBehavior,) -> Self", "cfg": [], "target": "UniformList" }, { "id": "gpui::elements::uniform_list::UniformList::with_sizing_behavior", "name": "with_sizing_behavior", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Sets the sizing behavior, similar to the `List` element.", "documentation": "Sets the sizing behavior, similar to the `List` element.", "signature": "pub fn with_sizing_behavior (mut self, behavior : ListSizingBehavior) -> Self", "cfg": [], "target": "UniformList" }, { "id": "gpui::elements::uniform_list::UniformList::with_width_from_item", "name": "with_width_from_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Selects a specific list item for measurement.", "documentation": "Selects a specific list item for measurement.", "signature": "pub fn with_width_from_item (mut self, item_index : Option) -> Self", "cfg": [], "target": "UniformList" }, { "id": "gpui::elements::uniform_list::UniformList::y_flipped", "name": "y_flipped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Sets whether the list is flipped vertically, such that item 0 appears at the bottom.", "documentation": "Sets whether the list is flipped vertically, such that item 0 appears at the bottom.", "signature": "pub fn y_flipped (mut self, y_flipped : bool) -> Self", "cfg": [], "target": "UniformList" }, { "id": "gpui::elements::uniform_list::UniformListDecoration", "name": "UniformListDecoration", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "A decoration for a [`UniformList`]. This can be used for various things, such as rendering indent guides, or other visual effects.", "documentation": "A decoration for a [`UniformList`]. This can be used for various things,\nsuch as rendering indent guides, or other visual effects.", "signature": "# [doc = \" A decoration for a [`UniformList`]. This can be used for various things,\"] # [doc = \" such as rendering indent guides, or other visual effects.\"] pub trait UniformListDecoration { # [doc = \" Compute the decoration element, given the visible range of list items,\"] # [doc = \" the bounds of the list, and the height of each item.\"] # [allow (clippy::too_many_arguments)] fn compute (& self, visible_range : Range, bounds : Bounds, scroll_offset : Point, item_height : Pixels, item_count : usize, window : & mut Window, cx : & mut App,) -> AnyElement; }", "cfg": [] }, { "id": "gpui::elements::uniform_list::UniformListFrameState", "name": "UniformListFrameState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Frame state used by the [UniformList].", "documentation": "Frame state used by the [UniformList].", "signature": "# [doc = \" Frame state used by the [UniformList].\"] pub struct UniformListFrameState { items : SmallVec<[AnyElement; 32]>, decorations : SmallVec<[AnyElement; 2]>, }", "cfg": [] }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle", "name": "UniformListScrollHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "A handle for controlling the scroll position of a uniform list. This should be stored in your view and passed to the uniform_list on each frame.", "documentation": "A handle for controlling the scroll position of a uniform list.\nThis should be stored in your view and passed to the uniform_list on each frame.", "signature": "# [doc = \" A handle for controlling the scroll position of a uniform list.\"] # [doc = \" This should be stored in your view and passed to the uniform_list on each frame.\"] # [derive (Clone, Debug, Default)] pub struct UniformListScrollHandle (pub Rc>);", "cfg": [] }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::is_scrollable", "name": "is_scrollable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Checks if the list can be scrolled vertically.", "documentation": "Checks if the list can be scrolled vertically.", "signature": "pub fn is_scrollable (& self) -> bool", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::is_scrolled_to_end", "name": "is_scrolled_to_end", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Whether the list is scrolled to the end, or `None` if the list is not scrollable.", "documentation": "Whether the list is scrolled to the end, or `None` if the list is\nnot scrollable.", "signature": "pub fn is_scrolled_to_end (& self) -> Option", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::logical_scroll_top_index", "name": "logical_scroll_top_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Get the index of the topmost visible child.", "documentation": "Get the index of the topmost visible child.", "signature": "pub fn logical_scroll_top_index (& self) -> usize", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Create a new scroll handle to bind to a uniform list.", "documentation": "Create a new scroll handle to bind to a uniform list.", "signature": "pub fn new () -> Self", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::scroll_to_bottom", "name": "scroll_to_bottom", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Scroll to the bottom of the list.", "documentation": "Scroll to the bottom of the list.", "signature": "pub fn scroll_to_bottom (& self)", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::scroll_to_item", "name": "scroll_to_item", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Scroll the list so that the given item index is visible.", "documentation": "Scroll the list so that the given item index is visible.\n\nThis uses non-strict scrolling: if the item is already fully visible, no scrolling occurs.\nIf the item is out of view, it scrolls the minimum amount to bring it into view according\nto the strategy.", "signature": "pub fn scroll_to_item (& self, ix : usize, strategy : ScrollStrategy)", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::scroll_to_item_strict", "name": "scroll_to_item_strict", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Scroll the list so that the given item index is at scroll strategy position.", "documentation": "Scroll the list so that the given item index is at scroll strategy position.\n\nThis uses strict scrolling: the item will always be scrolled to match the strategy position,\neven if it's already visible. Use this when you need precise positioning.", "signature": "pub fn scroll_to_item_strict (& self, ix : usize, strategy : ScrollStrategy)", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::scroll_to_item_strict_with_offset", "name": "scroll_to_item_strict_with_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Scroll the list so that the given item index is at the exact scroll strategy position with an offset.", "documentation": "Scroll the list so that the given item index is at the exact scroll strategy position with an offset.\n\nThis uses strict scrolling: the item will always be scrolled to match the strategy position,\neven if it's already visible.\n\nThe offset parameter shrinks the effective viewport by the specified number of items\nfrom the corresponding edge, then applies the scroll strategy within that reduced viewport:\n- `ScrollStrategy::Top`: Shrinks from top, positions item at the new top\n- `ScrollStrategy::Center`: Shrinks from top, centers item in the reduced viewport\n- `ScrollStrategy::Bottom`: Shrinks from bottom, positions item at the new bottom", "signature": "pub fn scroll_to_item_strict_with_offset (& self, ix : usize, strategy : ScrollStrategy, offset : usize,)", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::scroll_to_item_with_offset", "name": "scroll_to_item_with_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Scroll the list to the given item index with an offset in number of items.", "documentation": "Scroll the list to the given item index with an offset in number of items.\n\nThis uses non-strict scrolling: if the item is already visible within the offset region,\nno scrolling occurs.\n\nThe offset parameter shrinks the effective viewport by the specified number of items\nfrom the corresponding edge, then applies the scroll strategy within that reduced viewport:\n- `ScrollStrategy::Top`: Shrinks from top, positions item at the new top\n- `ScrollStrategy::Center`: Shrinks from top, centers item in the reduced viewport\n- `ScrollStrategy::Bottom`: Shrinks from bottom, positions item at the new bottom", "signature": "pub fn scroll_to_item_with_offset (& self, ix : usize, strategy : ScrollStrategy, offset : usize)", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollHandle::y_flipped", "name": "y_flipped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "Check if the list is flipped vertically.", "documentation": "Check if the list is flipped vertically.", "signature": "pub fn y_flipped (& self) -> bool", "cfg": [], "target": "UniformListScrollHandle" }, { "id": "gpui::elements::uniform_list::UniformListScrollState", "name": "UniformListScrollState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Debug, Default)] # [allow (missing_docs)] pub struct UniformListScrollState { pub base_handle : ScrollHandle, pub deferred_scroll_to_item : Option, # [doc = \" Size of the item, captured during last layout.\"] pub last_item_size : Option, # [doc = \" Whether the list was vertically flipped during last layout.\"] pub y_flipped : bool, }", "cfg": [] }, { "id": "gpui::elements::uniform_list::uniform_list", "name": "uniform_list", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "elements::uniform_list", "path": "gpui::elements::uniform_list", "source": "crates/gpui/src/elements/uniform_list.rs", "summary": "uniform_list provides lazy rendering for a set of items that are of uniform height. When rendered into a container with overflow-y: hidden and a fixed (or max) height, uniform_list will only render the visible subset of items.", "documentation": "uniform_list provides lazy rendering for a set of items that are of uniform height.\nWhen rendered into a container with overflow-y: hidden and a fixed (or max) height,\nuniform_list will only render the visible subset of items.", "signature": "pub fn uniform_list (id : impl Into, item_count : usize, f : impl 'static + Fn (Range, & mut Window, & mut App) -> Vec,) -> UniformList where R : IntoElement,", "cfg": [] }, { "id": "gpui::executor::BackgroundExecutor", "name": "BackgroundExecutor", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "A pointer to the executor that is currently running, for spawning background tasks.", "documentation": "A pointer to the executor that is currently running,\nfor spawning background tasks.", "signature": "# [doc = \" A pointer to the executor that is currently running,\"] # [doc = \" for spawning background tasks.\"] # [derive (Clone)] pub struct BackgroundExecutor { inner : scheduler::BackgroundExecutor, dispatcher : Arc, }", "cfg": [] }, { "id": "gpui::executor::BackgroundExecutor::advance_clock", "name": "advance_clock", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "In tests, move time forward. This does not run any tasks, but does make `timer`s ready.", "documentation": "In tests, move time forward. This does not run any tasks, but does make `timer`s ready.", "signature": "pub fn advance_clock (& self, duration : Duration)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::allow_parking", "name": "allow_parking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "In tests, prevents `run_until_parked` from panicking if there are outstanding tasks.", "documentation": "In tests, prevents `run_until_parked` from panicking if there are outstanding tasks.", "signature": "pub fn allow_parking (& self)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::dispatcher", "name": "dispatcher", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "", "documentation": "", "signature": "pub fn dispatcher (& self) -> & Arc", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::forbid_parking", "name": "forbid_parking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Undoes the effect of [`Self::allow_parking`].", "documentation": "Undoes the effect of [`Self::allow_parking`].", "signature": "pub fn forbid_parking (& self)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::is_main_thread", "name": "is_main_thread", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Whether we're on the main thread.", "documentation": "Whether we're on the main thread.", "signature": "pub fn is_main_thread (& self) -> bool", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Creates a new BackgroundExecutor from the given PlatformDispatcher.", "documentation": "Creates a new BackgroundExecutor from the given PlatformDispatcher.", "signature": "pub fn new (dispatcher : Arc) -> Self", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::now", "name": "now", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Get the current time.", "documentation": "Get the current time.\n\nCalling this instead of `std::time::Instant::now` allows the use\nof fake timers in tests.", "signature": "pub fn now (& self) -> Instant", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::num_cpus", "name": "num_cpus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "How many CPUs are available to the dispatcher.", "documentation": "How many CPUs are available to the dispatcher.", "signature": "pub fn num_cpus (& self) -> usize", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::rng", "name": "rng", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "In tests, returns the rng used by the dispatcher.", "documentation": "In tests, returns the rng used by the dispatcher.", "signature": "pub fn rng (& self) -> scheduler::SharedRng", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "In tests, run tasks until the scheduler would park.", "documentation": "In tests, run tasks until the scheduler would park.\n\nUnder the scheduler-backed test dispatcher, `tick()` will not advance the clock, so a pending\ntimer can keep `has_pending_tasks()` true even after all currently-runnable tasks have been\ndrained. To preserve the historical semantics that tests relied on (drain all work that can\nmake progress), we advance the clock to the next timer when no runnable tasks remain.", "signature": "pub fn run_until_parked (& self)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::scheduler_executor", "name": "scheduler_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Returns the underlying scheduler::BackgroundExecutor.", "documentation": "Returns the underlying scheduler::BackgroundExecutor.\n\nThis is used by Ex to pass the executor to thread/worktree code.", "signature": "pub fn scheduler_executor (& self) -> scheduler::BackgroundExecutor", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::scoped", "name": "scoped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Scoped lets you start a number of tasks and waits for all of them to complete before returning.", "documentation": "Scoped lets you start a number of tasks and waits\nfor all of them to complete before returning.", "signature": "pub async fn scoped<'scope, F> (& self, scheduler : F) where F : FnOnce (& mut Scope<'scope>),", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::scoped_priority", "name": "scoped_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Scoped lets you start a number of tasks and waits for all of them to complete before returning.", "documentation": "Scoped lets you start a number of tasks and waits\nfor all of them to complete before returning.", "signature": "pub async fn scoped_priority<'scope, F> (& self, priority : Priority, scheduler : F) where F : FnOnce (& mut Scope<'scope>),", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::set_block_on_ticks", "name": "set_block_on_ticks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Sets the range of ticks to run before timing out in block_on.", "documentation": "Sets the range of ticks to run before timing out in block_on.", "signature": "pub fn set_block_on_ticks (& self, range : std::ops::RangeInclusive)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::set_num_cpus", "name": "set_num_cpus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Override the number of CPUs reported by this executor in tests. Panics if not called on a test executor.", "documentation": "Override the number of CPUs reported by this executor in tests.\nPanics if not called on a test executor.", "signature": "pub fn set_num_cpus (& self, count : usize)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::simulate_random_delay", "name": "simulate_random_delay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "In tests, run an arbitrary number of tasks (determined by the SEED environment variable)", "documentation": "In tests, run an arbitrary number of tasks (determined by the SEED environment variable)", "signature": "pub fn simulate_random_delay (& self) -> impl Future + use<>", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Enqueues the given future to be run to completion on a background thread.", "documentation": "Enqueues the given future to be run to completion on a background thread.", "signature": "pub fn spawn (& self, future : impl Future + Send + 'static) -> Task where R : Send + 'static,", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::spawn_with_priority", "name": "spawn_with_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Enqueues the given future to be run to completion on a background thread with the given priority.", "documentation": "Enqueues the given future to be run to completion on a background thread with the given priority.\n\nWhen `Priority::RealtimeAudio` is used, the task runs on a dedicated thread with\nrealtime scheduling priority, suitable for audio processing.", "signature": "pub fn spawn_with_priority (& self, priority : Priority, future : impl Future + Send + 'static,) -> Task where R : Send + 'static,", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::tick", "name": "tick", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "In tests, run one task.", "documentation": "In tests, run one task.", "signature": "pub fn tick (& self) -> bool", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "BackgroundExecutor" }, { "id": "gpui::executor::BackgroundExecutor::timer", "name": "timer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Returns a task that will complete after the given duration. Depending on other concurrent tasks the elapsed duration may be longer than requested.", "documentation": "Returns a task that will complete after the given duration.\nDepending on other concurrent tasks the elapsed duration may be longer\nthan requested.", "signature": "pub fn timer (& self, duration : Duration) -> Task<()>", "cfg": [], "target": "BackgroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor", "name": "ForegroundExecutor", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "A pointer to the executor that is currently running, for spawning tasks on the main thread.", "documentation": "A pointer to the executor that is currently running,\nfor spawning tasks on the main thread.", "signature": "# [doc = \" A pointer to the executor that is currently running,\"] # [doc = \" for spawning tasks on the main thread.\"] # [derive (Clone)] pub struct ForegroundExecutor { inner : scheduler::LocalExecutor, dispatcher : Arc, not_send : PhantomData>, }", "cfg": [] }, { "id": "gpui::executor::ForegroundExecutor::block_on", "name": "block_on", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Block the current thread until the given future resolves. Consider using `block_with_timeout` instead.", "documentation": "Block the current thread until the given future resolves.\nConsider using `block_with_timeout` instead.", "signature": "pub fn block_on (& self, future : impl Future) -> R", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::block_test", "name": "block_test", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Used by the test harness to run an async test in a synchronous fashion.", "documentation": "Used by the test harness to run an async test in a synchronous fashion.", "signature": "pub fn block_test (& self, future : impl Future) -> R", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::block_with_timeout", "name": "block_with_timeout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Block the current thread until the given future resolves or the timeout elapses.", "documentation": "Block the current thread until the given future resolves or the timeout elapses.", "signature": "pub fn block_with_timeout> (& self, duration : Duration, future : Fut,) -> Result + use>", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::dispatcher", "name": "dispatcher", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "", "documentation": "", "signature": "pub fn dispatcher (& self) -> & Arc", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::idle_time_remaining", "name": "idle_time_remaining", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "The time remaining in the current idle slice, when called from a task spawned via [`Self::spawn_when_idle`] on a platform that meters idle time. `None` when idle time is unmetered (or the caller is not inside an idle slice); work that must bound itself should then fall back to a budget of its own.", "documentation": "The time remaining in the current idle slice, when called from a task\nspawned via [`Self::spawn_when_idle`] on a platform that meters idle\ntime. `None` when idle time is unmetered (or the caller is not inside\nan idle slice); work that must bound itself should then fall back to a\nbudget of its own.", "signature": "pub fn idle_time_remaining (& self) -> Option", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Creates a new ForegroundExecutor from the given PlatformDispatcher.", "documentation": "Creates a new ForegroundExecutor from the given PlatformDispatcher.", "signature": "pub fn new (dispatcher : Arc) -> Self", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::scheduler_executor", "name": "scheduler_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "", "documentation": "", "signature": "pub fn scheduler_executor (& self) -> SchedulerLocalExecutor", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Enqueues the given Task to run on the main thread.", "documentation": "Enqueues the given Task to run on the main thread.", "signature": "pub fn spawn (& self, future : impl Future + 'static) -> Task where R : 'static,", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::spawn_when_idle", "name": "spawn_when_idle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "On platforms with dedicated support, enqueues the given future to run on the main thread during platform idle time. Without a `timeout`, polls may be deferred indefinitely while the platform stays busy; with one, a poll still waiting after that long runs as ordinary main-thread work. Each poll occupies part of one idle slice, so long synchronous stretches should bound themselves against [`Self::idle_time_remaining`] and yield.", "documentation": "On platforms with dedicated support, enqueues the given future to run\non the main thread during platform idle time. Without a `timeout`,\npolls may be deferred indefinitely while the platform stays busy;\nwith one, a poll still waiting after that long runs as ordinary main-thread work.\nEach poll occupies part of one idle slice, so long synchronous stretches\nshould bound themselves against [`Self::idle_time_remaining`] and yield.\n\nOn platforms without dedicated support, schedules the given future to run\nwith a low priority, ignoring `timeout`.", "signature": "pub fn spawn_when_idle (& self, timeout : Option, future : impl Future + 'static,) -> Task where R : 'static,", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::ForegroundExecutor::spawn_with_priority", "name": "spawn_with_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Enqueues the given Task to run on the main thread with the given priority.", "documentation": "Enqueues the given Task to run on the main thread with the given priority.", "signature": "pub fn spawn_with_priority (& self, _priority : Priority, future : impl Future + 'static,) -> Task where R : 'static,", "cfg": [], "target": "ForegroundExecutor" }, { "id": "gpui::executor::Scope", "name": "Scope", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Scope manages a set of tasks that are enqueued and waited on together. See [`BackgroundExecutor::scoped`].", "documentation": "Scope manages a set of tasks that are enqueued and waited on together. See [`BackgroundExecutor::scoped`].", "signature": "# [doc = \" Scope manages a set of tasks that are enqueued and waited on together. See [`BackgroundExecutor::scoped`].\"] pub struct Scope<'a> { executor : BackgroundExecutor, priority : Priority, futures : Vec + Send + 'static>>>, tx : Option>, rx : mpsc::Receiver<()>, lifetime : PhantomData<& 'a ()>, }", "cfg": [] }, { "id": "gpui::executor::Scope::num_cpus", "name": "num_cpus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "How many CPUs are available to the dispatcher.", "documentation": "How many CPUs are available to the dispatcher.", "signature": "pub fn num_cpus (& self) -> usize", "cfg": [], "target": "Scope<'a>" }, { "id": "gpui::executor::Scope::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Spawn a future into this scope.", "documentation": "Spawn a future into this scope.", "signature": "pub fn spawn (& mut self, f : F) where F : Future + Send + 'a,", "cfg": [], "target": "Scope<'a>" }, { "id": "gpui::executor::TaskExt", "name": "TaskExt", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "Extension trait for `Task>` that adds `detach_and_log_err` with an `&App` context.", "documentation": "Extension trait for `Task>` that adds `detach_and_log_err` with an `&App` context.\n\nThis trait is automatically implemented for all `Task>` types.", "signature": "# [doc = \" Extension trait for `Task>` that adds `detach_and_log_err` with an `&App` context.\"] # [doc = \"\"] # [doc = \" This trait is automatically implemented for all `Task>` types.\"] pub trait TaskExt { # [doc = \" Run the task to completion in the background and log any errors that occur.\"] fn detach_and_log_err (self, cx : & App); # [doc = \" Like [`Self::detach_and_log_err`], but uses `{:?}` formatting on failure so `anyhow::Error`\"] # [doc = \" values emit their full backtrace. Prefer `detach_and_log_err` unless a backtrace is wanted.\"] fn detach_and_log_err_with_backtrace (self, cx : & App); }", "cfg": [] }, { "id": "gpui::executor::reexport-1", "name": "scheduler :: { FallibleTask , LocalExecutor as SchedulerLocalExecutor , Priority , Task }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "executor", "path": "gpui::executor", "source": "crates/gpui/src/executor.rs", "summary": "", "documentation": "", "signature": "pub use scheduler::{ FallibleTask, LocalExecutor as SchedulerLocalExecutor, Priority, Task };", "cfg": [] }, { "id": "gpui::geometry::AbsoluteLength", "name": "AbsoluteLength", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents an absolute length in pixels or rems.", "documentation": "Represents an absolute length in pixels or rems.\n\n`AbsoluteLength` can be either a fixed number of pixels, which is an absolute measurement not\naffected by the current font size, or a number of rems, which is relative to the font size of\nthe root element. It is used for specifying dimensions that are either independent of or\nrelated to the typographic scale.", "signature": "# [doc = \" Represents an absolute length in pixels or rems.\"] # [doc = \"\"] # [doc = \" `AbsoluteLength` can be either a fixed number of pixels, which is an absolute measurement not\"] # [doc = \" affected by the current font size, or a number of rems, which is relative to the font size of\"] # [doc = \" the root element. It is used for specifying dimensions that are either independent of or\"] # [doc = \" related to the typographic scale.\"] # [derive (Clone, Copy, Neg, PartialEq)] pub enum AbsoluteLength { # [doc = \" A length in pixels.\"] Pixels (Pixels), # [doc = \" A length in rems.\"] Rems (Rems), }", "cfg": [] }, { "id": "gpui::geometry::AbsoluteLength::is_zero", "name": "is_zero", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Checks if the absolute length is zero.", "documentation": "Checks if the absolute length is zero.", "signature": "pub fn is_zero (& self) -> bool", "cfg": [], "target": "AbsoluteLength" }, { "id": "gpui::geometry::AbsoluteLength::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts an `AbsoluteLength` to `Pixels` based on a given `rem_size`.", "documentation": "Converts an `AbsoluteLength` to `Pixels` based on a given `rem_size`.\n\n# Arguments\n\n* `rem_size` - The size of one rem in pixels.\n\n# Returns\n\nReturns the `AbsoluteLength` as `Pixels`.\n\n# Examples\n\n```\n# use gpui::{AbsoluteLength, Pixels, Rems};\nlet length_in_pixels = AbsoluteLength::Pixels(Pixels::from(42.0));\nlet length_in_rems = AbsoluteLength::Rems(Rems(2.0));\nlet rem_size = Pixels::from(16.0);\n\nassert_eq!(length_in_pixels.to_pixels(rem_size), Pixels::from(42.0));\nassert_eq!(length_in_rems.to_pixels(rem_size), Pixels::from(32.0));\n```", "signature": "pub fn to_pixels (self, rem_size : Pixels) -> Pixels", "cfg": [], "target": "AbsoluteLength" }, { "id": "gpui::geometry::AbsoluteLength::to_rems", "name": "to_rems", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts an `AbsoluteLength` to `Rems` based on a given `rem_size`.", "documentation": "Converts an `AbsoluteLength` to `Rems` based on a given `rem_size`.\n\n# Arguments\n\n* `rem_size` - The size of one rem in pixels.\n\n# Returns\n\nReturns the `AbsoluteLength` as `Pixels`.", "signature": "pub fn to_rems (self, rem_size : Pixels) -> Rems", "cfg": [], "target": "AbsoluteLength" }, { "id": "gpui::geometry::Along", "name": "Along", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A trait for accessing the given unit along a certain axis.", "documentation": "A trait for accessing the given unit along a certain axis.", "signature": "# [doc = \" A trait for accessing the given unit along a certain axis.\"] pub trait Along { # [doc = \" The unit associated with this type\"] type Unit; # [doc = \" Returns the unit along the given axis.\"] fn along (& self, axis : Axis) -> Self::Unit; # [doc = \" Applies the given function to the unit along the given axis and returns a new value.\"] fn apply_along (& self, axis : Axis, f : impl FnOnce (Self::Unit) -> Self::Unit) -> Self; }", "cfg": [] }, { "id": "gpui::geometry::Anchor", "name": "Anchor", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Identifies a reference point on a 2D box, used to anchor positioned elements.", "documentation": "Identifies a reference point on a 2D box, used to anchor positioned elements.", "signature": "# [doc = \" Identifies a reference point on a 2D box, used to anchor positioned elements.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum Anchor { # [doc = \" The top left corner\"] TopLeft, # [doc = \" The top right corner\"] TopRight, # [doc = \" The bottom left corner\"] BottomLeft, # [doc = \" The bottom right corner\"] BottomRight, # [doc = \" The top center position\"] TopCenter, # [doc = \" The bottom center position\"] BottomCenter, # [doc = \" The left center position\"] LeftCenter, # [doc = \" The right center position\"] RightCenter, }", "cfg": [] }, { "id": "gpui::geometry::Anchor::is_center", "name": "is_center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns true if at the center.", "documentation": "Returns true if at the center.", "signature": "pub fn is_center (& self) -> bool", "cfg": [], "target": "Anchor" }, { "id": "gpui::geometry::Anchor::opposite", "name": "opposite", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the directly opposite corner.", "documentation": "Returns the directly opposite corner.\n\n# Examples\n\n```\n# use gpui::Anchor;\nassert_eq!(Anchor::TopLeft.opposite(), Anchor::BottomRight);\n```", "signature": "pub fn opposite (self) -> Self", "cfg": [], "target": "Anchor" }, { "id": "gpui::geometry::Anchor::other_side_along", "name": "other_side_along", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the corner across from this corner, moving along the specified axis.", "documentation": "Returns the corner across from this corner, moving along the specified axis.\n\n# Examples\n\n```\n# use gpui::{Axis, Anchor};\nlet result = Anchor::TopLeft.other_side_along(Axis::Horizontal);\nassert_eq!(result, Anchor::TopRight);\n```", "signature": "pub fn other_side_along (self, axis : Axis) -> Self", "cfg": [], "target": "Anchor" }, { "id": "gpui::geometry::Axis", "name": "Axis", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Axis in a 2D cartesian space.", "documentation": "Axis in a 2D cartesian space.", "signature": "# [doc = \" Axis in a 2D cartesian space.\"] # [derive (Copy, Clone, PartialEq, Eq, Serialize, Deserialize, Debug)] pub enum Axis { # [doc = \" The y axis, or up and down\"] Vertical, # [doc = \" The x axis, or left and right\"] Horizontal, }", "cfg": [] }, { "id": "gpui::geometry::Axis::invert", "name": "invert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Swap this axis to the opposite axis.", "documentation": "Swap this axis to the opposite axis.", "signature": "pub fn invert (self) -> Self", "cfg": [], "target": "Axis" }, { "id": "gpui::geometry::Bounds", "name": "Bounds", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents a rectangular area in a 2D space with an origin point and a size.", "documentation": "Represents a rectangular area in a 2D space with an origin point and a size.\n\nThe `Bounds` struct is generic over a type `T` which represents the type of the coordinate system.\nThe origin is represented as a `Point` which defines the top left corner of the rectangle,\nand the size is represented as a `Size` which defines the width and height of the rectangle.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet origin = Point { x: 0, y: 0 };\nlet size = Size { width: 10, height: 20 };\nlet bounds = Bounds::new(origin, size);\n\nassert_eq!(bounds.origin, origin);\nassert_eq!(bounds.size, size);\n```", "signature": "# [doc = \" Represents a rectangular area in a 2D space with an origin point and a size.\"] # [doc = \"\"] # [doc = \" The `Bounds` struct is generic over a type `T` which represents the type of the coordinate system.\"] # [doc = \" The origin is represented as a `Point` which defines the top left corner of the rectangle,\"] # [doc = \" and the size is represented as a `Size` which defines the width and height of the rectangle.\"] # [doc = \"\"] # [doc = \" # Examples\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" # use gpui::{Bounds, Point, Size};\"] # [doc = \" let origin = Point { x: 0, y: 0 };\"] # [doc = \" let size = Size { width: 10, height: 20 };\"] # [doc = \" let bounds = Bounds::new(origin, size);\"] # [doc = \"\"] # [doc = \" assert_eq!(bounds.origin, origin);\"] # [doc = \" assert_eq!(bounds.size, size);\"] # [doc = \" ```\"] # [derive (Refineable, Copy, Clone, Default, Debug, Eq, PartialEq, Serialize, Deserialize, Hash)] # [refineable (Debug)] # [repr (C)] pub struct Bounds { # [doc = \" The origin point of this area.\"] pub origin : Point, # [doc = \" The size of the rectangle.\"] pub size : Size, }", "cfg": [] }, { "id": "gpui::geometry::Bounds::bottom", "name": "bottom", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the bottom edge of the bounds.", "documentation": "Returns the bottom edge of the bounds.\n\n# Returns\n\nA value of type `T` representing the y-coordinate of the bottom edge of the bounds.", "signature": "pub fn bottom (& self) -> T", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::bottom_center", "name": "bottom_center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the bottom center point of the bounds.", "documentation": "Returns the bottom center point of the bounds.", "signature": "pub fn bottom_center (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::bottom_left", "name": "bottom_left", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the bottom left corner point of the bounds.", "documentation": "Returns the bottom left corner point of the bounds.\n\n# Returns\n\nA `Point` representing the bottom left corner of the bounds.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 20 },\n};\nlet bottom_left = bounds.bottom_left();\nassert_eq!(bottom_left, Point { x: 0, y: 20 });\n```", "signature": "pub fn bottom_left (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::bottom_right", "name": "bottom_right", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the bottom right corner point of the bounds.", "documentation": "Returns the bottom right corner point of the bounds.\n\n# Returns\n\nA `Point` representing the bottom right corner of the bounds.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 20 },\n};\nlet bottom_right = bounds.bottom_right();\nassert_eq!(bottom_right, Point { x: 10, y: 20 });\n```", "signature": "pub fn bottom_right (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::center", "name": "center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the center point of the bounds.", "documentation": "Returns the center point of the bounds.\n\nCalculates the center by taking the origin's x and y coordinates and adding half the width and height\nof the bounds, respectively. The center is represented as a `Point` where `T` is the type of the\ncoordinate system.\n\n# Returns\n\nA `Point` representing the center of the bounds.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 20 },\n};\nlet center = bounds.center();\nassert_eq!(center, Point { x: 5, y: 10 });\n```", "signature": "pub fn center (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::centered", "name": "centered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Generate a centered bounds for the given display or primary display if none is provided", "documentation": "Generate a centered bounds for the given display or primary display if none is provided", "signature": "pub fn centered (display_id : Option, size : Size, cx : & App) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::centered_at", "name": "centered_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Creates a new bounds centered at the given point.", "documentation": "Creates a new bounds centered at the given point.", "signature": "pub fn centered_at (center : Point, size : Size) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Checks if the given point is within the bounds.", "documentation": "Checks if the given point is within the bounds.\n\nThis method determines whether a point lies inside the rectangle defined by the bounds,\nincluding the edges. The point is considered inside if its x-coordinate is greater than\nor equal to the left edge and less than or equal to the right edge, and its y-coordinate\nis greater than or equal to the top edge and less than or equal to the bottom edge of the bounds.\n\n# Arguments\n\n* `point` - A reference to a `Point` that represents the point to check.\n\n# Returns\n\nReturns `true` if the point is within the bounds, `false` otherwise.\n\n# Examples\n\n```\n# use gpui::{Point, Bounds, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 10 },\n};\nlet inside_point = Point { x: 5, y: 5 };\nlet outside_point = Point { x: 15, y: 15 };\n\nassert!(bounds.contains(&inside_point));\nassert!(!bounds.contains(&outside_point));\n```", "signature": "pub fn contains (& self, point : & Point) -> bool", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::corner", "name": "corner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the requested corner point of the bounds.", "documentation": "Returns the requested corner point of the bounds.\n\n# Returns\n\nA `Point` representing the corner of the bounds requested by the parameter.\n\n# Examples\n\n```\nuse gpui::{Bounds, Anchor, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 20 },\n};\nlet bottom_left = bounds.corner(Anchor::BottomLeft);\nassert_eq!(bottom_left, Point { x: 0, y: 20 });\n```", "signature": "pub fn corner (& self, corner : Anchor) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::dilate", "name": "dilate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Dilates the bounds by a specified amount in all directions.", "documentation": "Dilates the bounds by a specified amount in all directions.\n\nThis method expands the bounds by the given `amount`, increasing the size\nand adjusting the origin so that the bounds grow outwards equally in all directions.\nThe resulting bounds will have its width and height increased by twice the `amount`\n(since it grows in both directions), and the origin will be moved by `-amount`\nin both the x and y directions.\n\n# Arguments\n\n* `amount` - The amount by which to dilate the bounds.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet mut bounds = Bounds {\norigin: Point { x: 10, y: 10 },\nsize: Size { width: 10, height: 10 },\n};\nlet expanded_bounds = bounds.dilate(5);\nassert_eq!(expanded_bounds, Bounds {\norigin: Point { x: 5, y: 5 },\nsize: Size { width: 20, height: 20 },\n});\n```", "signature": "pub fn dilate (& self, amount : T) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::extend", "name": "extend", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Extends the bounds different amounts in each direction.", "documentation": "Extends the bounds different amounts in each direction.", "signature": "pub fn extend (& self, amount : Edges) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::from_anchor_and_size", "name": "from_anchor_and_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a `Bounds` from a corner point and size. The specified corner will be placed at the specified origin.", "documentation": "Constructs a `Bounds` from a corner point and size. The specified corner will be placed at\nthe specified origin.", "signature": "pub fn from_anchor_and_size (corner : Anchor, origin : Point, size : Size) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::from_corners", "name": "from_corners", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a `Bounds` from two corner points: the top left and bottom right corners.", "documentation": "Constructs a `Bounds` from two corner points: the top left and bottom right corners.\n\nThis function calculates the origin and size of the `Bounds` based on the provided corner points.\nThe origin is set to the top left corner, and the size is determined by the difference between\nthe x and y coordinates of the bottom right and top left points.\n\n# Arguments\n\n* `top_left` - A `Point` representing the top left corner of the rectangle.\n* `bottom_right` - A `Point` representing the bottom right corner of the rectangle.\n\n# Returns\n\nReturns a `Bounds` that encompasses the area defined by the two corner points.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point};\nlet top_left = Point { x: 0, y: 0 };\nlet bottom_right = Point { x: 10, y: 10 };\nlet bounds = Bounds::from_corners(top_left, bottom_right);\n\nassert_eq!(bounds.origin, top_left);\nassert_eq!(bounds.size.width, 10);\nassert_eq!(bounds.size.height, 10);\n```", "signature": "pub fn from_corners (top_left : Point, bottom_right : Point) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::half_perimeter", "name": "half_perimeter", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Calculates the half perimeter of a rectangle defined by the bounds.", "documentation": "Calculates the half perimeter of a rectangle defined by the bounds.\n\nThe half perimeter is calculated as the sum of the width and the height of the rectangle.\nThis method is generic over the type `T` which must implement the `Sub` trait to allow\ncalculation of the width and height from the bounds' origin and size, as well as the `Add` trait\nto sum the width and height for the half perimeter.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 20 },\n};\nlet half_perimeter = bounds.half_perimeter();\nassert_eq!(half_perimeter, 30);\n```", "signature": "pub fn half_perimeter (& self) -> T", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::inset", "name": "inset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Inset the bounds by a specified amount. Equivalent to `dilate` with the amount negated.", "documentation": "Inset the bounds by a specified amount. Equivalent to `dilate` with the amount negated.\n\nNote that this may panic if T does not support negative values.", "signature": "pub fn inset (& self, amount : T) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::intersect", "name": "intersect", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Calculates the intersection of two `Bounds` objects.", "documentation": "Calculates the intersection of two `Bounds` objects.\n\nThis method computes the overlapping region of two `Bounds`. If the bounds do not intersect,\nthe resulting `Bounds` will have a size with width and height of zero.\n\n# Arguments\n\n* `other` - A reference to another `Bounds` to intersect with.\n\n# Returns\n\nReturns a `Bounds` representing the intersection area. If there is no intersection,\nthe returned `Bounds` will have a size with width and height of zero.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds1 = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 10 },\n};\nlet bounds2 = Bounds {\norigin: Point { x: 5, y: 5 },\nsize: Size { width: 10, height: 10 },\n};\nlet intersection = bounds1.intersect(&bounds2);\n\nassert_eq!(intersection, Bounds {\norigin: Point { x: 5, y: 5 },\nsize: Size { width: 5, height: 5 },\n});\n```", "signature": "pub fn intersect (& self, other : & Self) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::intersects", "name": "intersects", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Checks if this `Bounds` intersects with another `Bounds`.", "documentation": "Checks if this `Bounds` intersects with another `Bounds`.\n\nTwo `Bounds` instances intersect if they overlap in the 2D space they occupy.\nThis method checks if there is any overlapping area between the two bounds.\n\n# Arguments\n\n* `other` - A reference to another `Bounds` to check for intersection with.\n\n# Returns\n\nReturns `true` if there is any intersection between the two bounds, `false` otherwise.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds1 = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 10 },\n};\nlet bounds2 = Bounds {\norigin: Point { x: 5, y: 5 },\nsize: Size { width: 10, height: 10 },\n};\nlet bounds3 = Bounds {\norigin: Point { x: 20, y: 20 },\nsize: Size { width: 10, height: 10 },\n};\n\nassert_eq!(bounds1.intersects(&bounds2), true); // Overlapping bounds\nassert_eq!(bounds1.intersects(&bounds3), false); // Non-overlapping bounds\n```", "signature": "pub fn intersects (& self, other : & Bounds) -> bool", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::is_contained_within", "name": "is_contained_within", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Checks if this bounds is completely contained within another bounds.", "documentation": "Checks if this bounds is completely contained within another bounds.\n\nThis method determines whether the current bounds is entirely enclosed by the given bounds.\nA bounds is considered to be contained within another if its origin (top-left corner) and\nits bottom-right corner are both contained within the other bounds.\n\n# Arguments\n\n* `other` - A reference to another `Bounds` that might contain this bounds.\n\n# Returns\n\nReturns `true` if this bounds is completely inside the other bounds, `false` otherwise.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet outer_bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 20, height: 20 },\n};\nlet inner_bounds = Bounds {\norigin: Point { x: 5, y: 5 },\nsize: Size { width: 10, height: 10 },\n};\nlet overlapping_bounds = Bounds {\norigin: Point { x: 15, y: 15 },\nsize: Size { width: 10, height: 10 },\n};\n\nassert!(inner_bounds.is_contained_within(&outer_bounds));\nassert!(!overlapping_bounds.is_contained_within(&outer_bounds));\n```", "signature": "pub fn is_contained_within (& self, other : & Self) -> bool", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Checks if the bounds represent an empty area.", "documentation": "Checks if the bounds represent an empty area.\n\n# Returns\n\nReturns `true` if either the width or the height of the bounds is less than or equal to zero, indicating an empty area.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::left", "name": "left", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the left edge of the bounds.", "documentation": "Returns the left edge of the bounds.\n\n# Returns\n\nA value of type `T` representing the x-coordinate of the left edge of the bounds.", "signature": "pub fn left (& self) -> T", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::left_center", "name": "left_center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the left center point of the bounds.", "documentation": "Returns the left center point of the bounds.", "signature": "pub fn left_center (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::localize", "name": "localize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Convert a point to the coordinate space defined by this Bounds", "documentation": "Convert a point to the coordinate space defined by this Bounds", "signature": "pub fn localize (& self, point : & Point) -> Option>", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Applies a function to the origin and size of the bounds, producing a new `Bounds`.", "documentation": "Applies a function to the origin and size of the bounds, producing a new `Bounds`.\n\nThis method allows for converting a `Bounds` to a `Bounds` by specifying a closure\nthat defines how to convert between the two types. The closure is applied to the `origin` and\n`size` fields, resulting in new bounds of the desired type.\n\n# Arguments\n\n* `f` - A closure that takes a value of type `T` and returns a value of type `U`.\n\n# Returns\n\nReturns a new `Bounds` with the origin and size mapped by the provided function.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 10.0, y: 10.0 },\nsize: Size { width: 10.0, height: 20.0 },\n};\nlet new_bounds = bounds.map(|value| value as f64 * 1.5);\n\nassert_eq!(new_bounds, Bounds {\norigin: Point { x: 15.0, y: 15.0 },\nsize: Size { width: 15.0, height: 30.0 },\n});\n```", "signature": "pub fn map (& self, f : impl Fn (T) -> U) -> Bounds where U : Clone + Debug + Default + PartialEq,", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::map_origin", "name": "map_origin", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Applies a function to the origin of the bounds, producing a new `Bounds` with the new origin", "documentation": "Applies a function to the origin of the bounds, producing a new `Bounds` with the new origin\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 10.0, y: 10.0 },\nsize: Size { width: 10.0, height: 20.0 },\n};\nlet new_bounds = bounds.map_origin(|value| value * 1.5);\n\nassert_eq!(new_bounds, Bounds {\norigin: Point { x: 15.0, y: 15.0 },\nsize: Size { width: 10.0, height: 20.0 },\n});\n```", "signature": "pub fn map_origin (self, f : impl Fn (T) -> T) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::map_size", "name": "map_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Applies a function to the origin of the bounds, producing a new `Bounds` with the new origin", "documentation": "Applies a function to the origin of the bounds, producing a new `Bounds` with the new origin\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 10.0, y: 10.0 },\nsize: Size { width: 10.0, height: 20.0 },\n};\nlet new_bounds = bounds.map_size(|value| value * 1.5);\n\nassert_eq!(new_bounds, Bounds {\norigin: Point { x: 10.0, y: 10.0 },\nsize: Size { width: 15.0, height: 30.0 },\n});\n```", "signature": "pub fn map_size (self, f : impl Fn (T) -> T) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::maximized", "name": "maximized", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Generate maximized bounds for the given display or primary display if none is provided", "documentation": "Generate maximized bounds for the given display or primary display if none is provided", "signature": "pub fn maximized (display_id : Option, cx : & App) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Creates a new `Bounds` with the specified origin and size.", "documentation": "Creates a new `Bounds` with the specified origin and size.\n\n# Arguments\n\n* `origin` - A `Point` representing the origin of the bounds.\n* `size` - A `Size` representing the size of the bounds.\n\n# Returns\n\nReturns a `Bounds` that has the given origin and size.", "signature": "pub fn new (origin : Point, size : Size) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::right", "name": "right", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the right edge of the bounds.", "documentation": "Returns the right edge of the bounds.\n\n# Returns\n\nA value of type `T` representing the x-coordinate of the right edge of the bounds.", "signature": "pub fn right (& self) -> T", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::right_center", "name": "right_center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the right center point of the bounds.", "documentation": "Returns the right center point of the bounds.", "signature": "pub fn right_center (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Scales the bounds by a given factor, typically used to adjust for display scaling.", "documentation": "Scales the bounds by a given factor, typically used to adjust for display scaling.\n\nThis method multiplies the origin and size of the bounds by the provided scaling factor,\nresulting in a new `Bounds` that is proportionally larger or smaller\ndepending on the scaling factor. This can be used to ensure that the bounds are properly\nscaled for different display densities.\n\n# Arguments\n\n* `factor` - The scaling factor to apply to the origin and size, typically the display's scaling factor.\n\n# Returns\n\nReturns a new `Bounds` that represents the scaled bounds.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size, Pixels, ScaledPixels, DevicePixels};\nlet bounds = Bounds {\norigin: Point { x: Pixels::from(10.0), y: Pixels::from(20.0) },\nsize: Size { width: Pixels::from(30.0), height: Pixels::from(40.0) },\n};\nlet display_scale_factor = 2.0;\nlet scaled_bounds = bounds.scale(display_scale_factor);\nassert_eq!(scaled_bounds, Bounds {\norigin: Point {\nx: ScaledPixels::from(20.0),\ny: ScaledPixels::from(40.0),\n},\nsize: Size {\nwidth: ScaledPixels::from(60.0),\nheight: ScaledPixels::from(80.0)\n},\n});\n```", "signature": "pub fn scale (& self, factor : f32) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::space_within", "name": "space_within", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Computes the space available within outer bounds.", "documentation": "Computes the space available within outer bounds.", "signature": "pub fn space_within (& self, outer : & Self) -> Edges", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::to_device_pixels", "name": "to_device_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Convert the bounds from logical pixels to physical pixels", "documentation": "Convert the bounds from logical pixels to physical pixels", "signature": "pub fn to_device_pixels (self, factor : f32) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Convert the bounds from physical pixels to logical pixels", "documentation": "Convert the bounds from physical pixels to logical pixels", "signature": "pub fn to_pixels (self, scale_factor : f32) -> Bounds", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::top", "name": "top", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the top edge of the bounds.", "documentation": "Returns the top edge of the bounds.\n\n# Returns\n\nA value of type `T` representing the y-coordinate of the top edge of the bounds.", "signature": "pub fn top (& self) -> T", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::top_center", "name": "top_center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the top center point of the bounds.", "documentation": "Returns the top center point of the bounds.", "signature": "pub fn top_center (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::top_right", "name": "top_right", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the top right corner point of the bounds.", "documentation": "Returns the top right corner point of the bounds.\n\n# Returns\n\nA `Point` representing the top right corner of the bounds.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 20 },\n};\nlet top_right = bounds.top_right();\nassert_eq!(top_right, Point { x: 10, y: 0 });\n```", "signature": "pub fn top_right (& self) -> Point", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Bounds::union", "name": "union", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Computes the union of two `Bounds`.", "documentation": "Computes the union of two `Bounds`.\n\nThis method calculates the smallest `Bounds` that contains both the current `Bounds` and the `other` `Bounds`.\nThe resulting `Bounds` will have an origin that is the minimum of the origins of the two `Bounds`,\nand a size that encompasses the furthest extents of both `Bounds`.\n\n# Arguments\n\n* `other` - A reference to another `Bounds` to create a union with.\n\n# Returns\n\nReturns a `Bounds` representing the union of the two `Bounds`.\n\n# Examples\n\n```\n# use gpui::{Bounds, Point, Size};\nlet bounds1 = Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 10, height: 10 },\n};\nlet bounds2 = Bounds {\norigin: Point { x: 5, y: 5 },\nsize: Size { width: 15, height: 15 },\n};\nlet union_bounds = bounds1.union(&bounds2);\n\nassert_eq!(union_bounds, Bounds {\norigin: Point { x: 0, y: 0 },\nsize: Size { width: 20, height: 20 },\n});\n```", "signature": "pub fn union (& self, other : & Self) -> Self", "cfg": [], "target": "Bounds" }, { "id": "gpui::geometry::Corners", "name": "Corners", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents the corners of a box in a 2D space, such as border radius.", "documentation": "Represents the corners of a box in a 2D space, such as border radius.\n\nEach field represents the size of the corner on one side of the box: `top_left`, `top_right`, `bottom_right`, and `bottom_left`.", "signature": "# [doc = \" Represents the corners of a box in a 2D space, such as border radius.\"] # [doc = \"\"] # [doc = \" Each field represents the size of the corner on one side of the box: `top_left`, `top_right`, `bottom_right`, and `bottom_left`.\"] # [derive (Refineable, Clone, Default, Debug, Eq, PartialEq)] # [refineable (Debug, PartialEq, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub struct Corners { # [doc = \" The value associated with the top left corner.\"] pub top_left : T, # [doc = \" The value associated with the top right corner.\"] pub top_right : T, # [doc = \" The value associated with the bottom right corner.\"] pub bottom_right : T, # [doc = \" The value associated with the bottom left corner.\"] pub bottom_left : T, }", "cfg": [] }, { "id": "gpui::geometry::Corners::all", "name": "all", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs `Corners` where all sides are set to the same specified value.", "documentation": "Constructs `Corners` where all sides are set to the same specified value.\n\nThis function creates a `Corners` instance with the `top_left`, `top_right`, `bottom_right`, and `bottom_left` fields all initialized\nto the same value provided as an argument. This is useful when you want to have uniform corners around a box,\nsuch as a uniform border radius on a rectangle.\n\n# Arguments\n\n* `value` - The value to set for all four corners.\n\n# Returns\n\nAn `Corners` instance with all corners set to the given value.\n\n# Examples\n\n```\n# use gpui::Corners;\nlet uniform_corners = Corners::all(5.0);\nassert_eq!(uniform_corners.top_left, 5.0);\nassert_eq!(uniform_corners.top_right, 5.0);\nassert_eq!(uniform_corners.bottom_right, 5.0);\nassert_eq!(uniform_corners.bottom_left, 5.0);\n```", "signature": "pub fn all (value : T) -> Self", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::Corners::clamp_radii_for_quad_size", "name": "clamp_radii_for_quad_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Clamps corner radii to be less than or equal to half the shortest side of a quad.", "documentation": "Clamps corner radii to be less than or equal to half the shortest side of a quad.\n\n# Arguments\n\n* `size` - The size of the quad which limits the size of the corner radii.\n\n# Returns\n\nAnchor radii values clamped to fit.", "signature": "pub fn clamp_radii_for_quad_size (self, size : Size) -> Corners", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::Corners::corner", "name": "corner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the requested corner value, supporting all eight corner positions.", "documentation": "Returns the requested corner value, supporting all eight corner positions.\n\nFor the four basic corners (TopLeft, TopRight, BottomLeft, BottomRight),\nthis returns the corresponding field value directly.\n\nFor the center positions (TopCenter, BottomCenter, LeftCenter, RightCenter),\nthis calculates the average of the two adjacent corners.\n\n# Returns\n\nA value of type `T` representing the corner requested by the parameter.\n\n# Examples\n\nBasic corner positions:\n\n```\n# use gpui::{Anchor, Corners};\nlet corners = Corners {\ntop_left: 10,\ntop_right: 20,\nbottom_left: 30,\nbottom_right: 40\n};\nassert_eq!(corners.corner(Anchor::TopLeft), 10);\nassert_eq!(corners.corner(Anchor::BottomRight), 40);\n```\n\nCenter positions (calculated as average of adjacent corners):\n\n```\n# use gpui::{Anchor, Corners};\nlet corners = Corners {\ntop_left: 10,\ntop_right: 20,\nbottom_left: 30,\nbottom_right: 40\n};\nassert_eq!(corners.corner(Anchor::TopCenter), 15);\nassert_eq!(corners.corner(Anchor::BottomCenter), 35);\nassert_eq!(corners.corner(Anchor::LeftCenter), 20);\nassert_eq!(corners.corner(Anchor::RightCenter), 30);\n```", "signature": "pub fn corner (& self, corner : Anchor) -> T", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::Corners::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Applies a function to each field of the `Corners`, producing a new `Corners`.", "documentation": "Applies a function to each field of the `Corners`, producing a new `Corners`.\n\nThis method allows for converting a `Corners` to a `Corners` by specifying a closure\nthat defines how to convert between the two types. The closure is applied to each field\n(`top_left`, `top_right`, `bottom_right`, `bottom_left`), resulting in new corners of the desired type.\n\n# Arguments\n\n* `f` - A closure that takes a reference to a value of type `T` and returns a value of type `U`.\n\n# Returns\n\nReturns a new `Corners` with each field mapped by the provided function.\n\n# Examples\n\n```\n# use gpui::{Corners, Pixels, Rems};\nlet corners = Corners {\ntop_left: Pixels::from(10.0),\ntop_right: Pixels::from(20.0),\nbottom_right: Pixels::from(30.0),\nbottom_left: Pixels::from(40.0),\n};\nlet corners_in_rems = corners.map(|&px| Rems(f32::from(px) / 16.0));\nassert_eq!(corners_in_rems, Corners {\ntop_left: Rems(0.625),\ntop_right: Rems(1.25),\nbottom_right: Rems(1.875),\nbottom_left: Rems(2.5),\n});\n```", "signature": "pub fn map (& self, f : impl Fn (& T) -> U) -> Corners where U : Clone + Debug + Default + PartialEq,", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::Corners::max", "name": "max", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the maximum value of any corner.", "documentation": "Returns the maximum value of any corner.\n\n# Returns\n\nThe maximum `Pixels` value among all four corners.", "signature": "pub fn max (& self) -> Pixels", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::Corners::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Scales the `Corners` by a given factor, returning `Corners`.", "documentation": "Scales the `Corners` by a given factor, returning `Corners`.\n\nThis method is typically used for adjusting the corner sizes for different display densities or scaling factors.\n\n# Arguments\n\n* `factor` - The scaling factor to apply to each corner.\n\n# Returns\n\nReturns a new `Corners` where each corner is the result of scaling the original corner by the given factor.\n\n# Examples\n\n```\n# use gpui::{Corners, Pixels, ScaledPixels};\nlet corners = Corners {\ntop_left: Pixels::from(10.0),\ntop_right: Pixels::from(20.0),\nbottom_right: Pixels::from(30.0),\nbottom_left: Pixels::from(40.0),\n};\nlet scaled_corners = corners.scale(2.0);\nassert_eq!(scaled_corners.top_left, ScaledPixels::from(20.0));\nassert_eq!(scaled_corners.top_right, ScaledPixels::from(40.0));\nassert_eq!(scaled_corners.bottom_right, ScaledPixels::from(60.0));\nassert_eq!(scaled_corners.bottom_left, ScaledPixels::from(80.0));\n```", "signature": "pub fn scale (& self, factor : f32) -> Corners", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::Corners::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts the `AbsoluteLength` to `Pixels` based on the provided rem size.", "documentation": "Converts the `AbsoluteLength` to `Pixels` based on the provided rem size.\n\n# Arguments\n\n* `rem_size` - The size of one REM unit in pixels, used for conversion if the `AbsoluteLength` is in REMs.\n\n# Returns\n\nReturns a `Corners` instance with each corner's length converted to pixels.\n\n# Examples\n\n```\n# use gpui::{Corners, AbsoluteLength, Pixels, Rems, Size};\nlet corners = Corners {\ntop_left: AbsoluteLength::Pixels(Pixels::from(15.0)),\ntop_right: AbsoluteLength::Rems(Rems(1.0)),\nbottom_right: AbsoluteLength::Pixels(Pixels::from(30.0)),\nbottom_left: AbsoluteLength::Rems(Rems(2.0)),\n};\nlet rem_size = Pixels::from(16.0);\nlet corners_in_pixels = corners.to_pixels(rem_size);\n\nassert_eq!(corners_in_pixels.top_left, Pixels::from(15.0));\nassert_eq!(corners_in_pixels.top_right, Pixels::from(16.0)); // 1 rem converted to pixels\nassert_eq!(corners_in_pixels.bottom_right, Pixels::from(30.0));\nassert_eq!(corners_in_pixels.bottom_left, Pixels::from(32.0)); // 2 rems converted to pixels\n```", "signature": "pub fn to_pixels (self, rem_size : Pixels) -> Corners", "cfg": [], "target": "Corners" }, { "id": "gpui::geometry::DefiniteLength", "name": "DefiniteLength", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A non-auto length that can be defined in pixels, rems, or percent of parent.", "documentation": "A non-auto length that can be defined in pixels, rems, or percent of parent.\n\nThis enum represents lengths that have a specific value, as opposed to lengths that are automatically\ndetermined by the context. It includes absolute lengths in pixels or rems, and relative lengths as a\nfraction of the parent's size.", "signature": "# [doc = \" A non-auto length that can be defined in pixels, rems, or percent of parent.\"] # [doc = \"\"] # [doc = \" This enum represents lengths that have a specific value, as opposed to lengths that are automatically\"] # [doc = \" determined by the context. It includes absolute lengths in pixels or rems, and relative lengths as a\"] # [doc = \" fraction of the parent's size.\"] # [derive (Clone, Copy, Neg, PartialEq)] pub enum DefiniteLength { # [doc = \" An absolute length specified in pixels or rems.\"] Absolute (AbsoluteLength), # [doc = \" A relative length specified as a fraction of the parent's size, between 0 and 1.\"] Fraction (f32), }", "cfg": [] }, { "id": "gpui::geometry::DefiniteLength::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts the `DefiniteLength` to `Pixels` based on a given `base_size` and `rem_size`.", "documentation": "Converts the `DefiniteLength` to `Pixels` based on a given `base_size` and `rem_size`.\n\nIf the `DefiniteLength` is an absolute length, it will be directly converted to `Pixels`.\nIf it is a fraction, the fraction will be multiplied by the `base_size` to get the length in pixels.\n\n# Arguments\n\n* `base_size` - The base size in `AbsoluteLength` to which the fraction will be applied.\n* `rem_size` - The size of one rem in pixels, used to convert rems to pixels.\n\n# Returns\n\nReturns the `DefiniteLength` as `Pixels`.\n\n# Examples\n\n```\n# use gpui::{DefiniteLength, AbsoluteLength, Pixels, px, rems};\nlet length_in_pixels = DefiniteLength::Absolute(AbsoluteLength::Pixels(px(42.0)));\nlet length_in_rems = DefiniteLength::Absolute(AbsoluteLength::Rems(rems(2.0)));\nlet length_as_fraction = DefiniteLength::Fraction(0.5);\nlet base_size = AbsoluteLength::Pixels(px(100.0));\nlet rem_size = px(16.0);\n\nassert_eq!(length_in_pixels.to_pixels(base_size, rem_size), Pixels::from(42.0));\nassert_eq!(length_in_rems.to_pixels(base_size, rem_size), Pixels::from(32.0));\nassert_eq!(length_as_fraction.to_pixels(base_size, rem_size), Pixels::from(50.0));\n```", "signature": "pub fn to_pixels (self, base_size : AbsoluteLength, rem_size : Pixels) -> Pixels", "cfg": [], "target": "DefiniteLength" }, { "id": "gpui::geometry::DevicePixels", "name": "DevicePixels", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents physical pixels on the display.", "documentation": "Represents physical pixels on the display.\n\n`DevicePixels` is a unit of measurement that refers to the actual pixels on a device's screen.\nThis type is used when precise pixel manipulation is required, such as rendering graphics or\ninterfacing with hardware that operates on the pixel level. Unlike logical pixels that may be\naffected by the device's scale factor, `DevicePixels` always correspond to real pixels on the\ndisplay.", "signature": "# [doc = \" Represents physical pixels on the display.\"] # [doc = \"\"] # [doc = \" `DevicePixels` is a unit of measurement that refers to the actual pixels on a device's screen.\"] # [doc = \" This type is used when precise pixel manipulation is required, such as rendering graphics or\"] # [doc = \" interfacing with hardware that operates on the pixel level. Unlike logical pixels that may be\"] # [doc = \" affected by the device's scale factor, `DevicePixels` always correspond to real pixels on the\"] # [doc = \" display.\"] # [derive (Add, AddAssign, Clone, Copy, Default, Div, Eq, Hash, Ord, PartialEq, PartialOrd, Sub, SubAssign, Serialize, Deserialize,)] # [repr (transparent)] pub struct DevicePixels (pub i32);", "cfg": [] }, { "id": "gpui::geometry::DevicePixels::to_bytes", "name": "to_bytes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts the `DevicePixels` value to the number of bytes needed to represent it in memory.", "documentation": "Converts the `DevicePixels` value to the number of bytes needed to represent it in memory.\n\nThis function is useful when working with graphical data that needs to be stored in a buffer,\nsuch as images or framebuffers, where each pixel may be represented by a specific number of bytes.\n\n# Arguments\n\n* `bytes_per_pixel` - The number of bytes used to represent a single pixel.\n\n# Returns\n\nThe number of bytes required to represent the `DevicePixels` value in memory.\n\n# Examples\n\n```\n# use gpui::DevicePixels;\nlet pixels = DevicePixels(10); // 10 device pixels\nlet bytes_per_pixel = 4; // Assume each pixel is represented by 4 bytes (e.g., RGBA)\nlet total_bytes = pixels.to_bytes(bytes_per_pixel);\nassert_eq!(total_bytes, 40); // 10 pixels * 4 bytes/pixel = 40 bytes\n```", "signature": "pub fn to_bytes (self, bytes_per_pixel : u8) -> u32", "cfg": [], "target": "DevicePixels" }, { "id": "gpui::geometry::Edges", "name": "Edges", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents the edges of a box in a 2D space, such as padding or margin.", "documentation": "Represents the edges of a box in a 2D space, such as padding or margin.\n\nEach field represents the size of the edge on one side of the box: `top`, `right`, `bottom`, and `left`.\n\n# Examples\n\n```\n# use gpui::Edges;\nlet edges = Edges {\ntop: 10.0,\nright: 20.0,\nbottom: 30.0,\nleft: 40.0,\n};\n\nassert_eq!(edges.top, 10.0);\nassert_eq!(edges.right, 20.0);\nassert_eq!(edges.bottom, 30.0);\nassert_eq!(edges.left, 40.0);\n```", "signature": "# [doc = \" Represents the edges of a box in a 2D space, such as padding or margin.\"] # [doc = \"\"] # [doc = \" Each field represents the size of the edge on one side of the box: `top`, `right`, `bottom`, and `left`.\"] # [doc = \"\"] # [doc = \" # Examples\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" # use gpui::Edges;\"] # [doc = \" let edges = Edges {\"] # [doc = \" top: 10.0,\"] # [doc = \" right: 20.0,\"] # [doc = \" bottom: 30.0,\"] # [doc = \" left: 40.0,\"] # [doc = \" };\"] # [doc = \"\"] # [doc = \" assert_eq!(edges.top, 10.0);\"] # [doc = \" assert_eq!(edges.right, 20.0);\"] # [doc = \" assert_eq!(edges.bottom, 30.0);\"] # [doc = \" assert_eq!(edges.left, 40.0);\"] # [doc = \" ```\"] # [derive (Refineable, Clone, Default, Debug, Eq, PartialEq)] # [refineable (Debug, PartialEq, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub struct Edges { # [doc = \" The size of the top edge.\"] pub top : T, # [doc = \" The size of the right edge.\"] pub right : T, # [doc = \" The size of the bottom edge.\"] pub bottom : T, # [doc = \" The size of the left edge.\"] pub left : T, }", "cfg": [] }, { "id": "gpui::geometry::Edges::all", "name": "all", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs `Edges` where all sides are set to the same specified value.", "documentation": "Constructs `Edges` where all sides are set to the same specified value.\n\nThis function creates an `Edges` instance with the `top`, `right`, `bottom`, and `left` fields all initialized\nto the same value provided as an argument. This is useful when you want to have uniform edges around a box,\nsuch as padding or margin with the same size on all sides.\n\n# Arguments\n\n* `value` - The value to set for all four sides of the edges.\n\n# Returns\n\nAn `Edges` instance with all sides set to the given value.\n\n# Examples\n\n```\n# use gpui::Edges;\nlet uniform_edges = Edges::all(10.0);\nassert_eq!(uniform_edges.top, 10.0);\nassert_eq!(uniform_edges.right, 10.0);\nassert_eq!(uniform_edges.bottom, 10.0);\nassert_eq!(uniform_edges.left, 10.0);\n```", "signature": "pub fn all (value : T) -> Self", "cfg": [], "target": "Edges" }, { "id": "gpui::geometry::Edges::any", "name": "any", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Checks if any of the edges satisfy a given predicate.", "documentation": "Checks if any of the edges satisfy a given predicate.\n\nThis method applies a predicate function to each field of the `Edges` and returns `true` if any field satisfies the predicate.\n\n# Arguments\n\n* `predicate` - A closure that takes a reference to a value of type `T` and returns a `bool`.\n\n# Returns\n\nReturns `true` if the predicate returns `true` for any of the edge values, `false` otherwise.\n\n# Examples\n\n```\n# use gpui::Edges;\nlet edges = Edges {\ntop: 10,\nright: 0,\nbottom: 5,\nleft: 0,\n};\n\nassert!(edges.any(|value| *value == 0));\nassert!(edges.any(|value| *value > 0));\nassert!(!edges.any(|value| *value > 10));\n```", "signature": "pub fn any bool> (& self, predicate : F) -> bool", "cfg": [], "target": "Edges" }, { "id": "gpui::geometry::Edges::auto", "name": "auto", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Sets the edges of the `Edges` struct to `auto`, which is a special value that allows the layout engine to automatically determine the size of the edges.", "documentation": "Sets the edges of the `Edges` struct to `auto`, which is a special value that allows the layout engine to automatically determine the size of the edges.\n\nThis is typically used in layout contexts where the exact size of the edges is not important, or when the size should be calculated based on the content or container.\n\n# Returns\n\nReturns an `Edges` with all edges set to `Length::Auto`.\n\n# Examples\n\n```\n# use gpui::{Edges, Length};\nlet auto_edges = Edges::auto();\nassert_eq!(auto_edges.top, Length::Auto);\nassert_eq!(auto_edges.right, Length::Auto);\nassert_eq!(auto_edges.bottom, Length::Auto);\nassert_eq!(auto_edges.left, Length::Auto);\n```", "signature": "pub fn auto () -> Self", "cfg": [], "target": "Edges" }, { "id": "gpui::geometry::Edges::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Applies a function to each field of the `Edges`, producing a new `Edges`.", "documentation": "Applies a function to each field of the `Edges`, producing a new `Edges`.\n\nThis method allows for converting an `Edges` to an `Edges` by specifying a closure\nthat defines how to convert between the two types. The closure is applied to each field\n(`top`, `right`, `bottom`, `left`), resulting in new edges of the desired type.\n\n# Arguments\n\n* `f` - A closure that takes a reference to a value of type `T` and returns a value of type `U`.\n\n# Returns\n\nReturns a new `Edges` with each field mapped by the provided function.\n\n# Examples\n\n```\n# use gpui::Edges;\nlet edges = Edges { top: 10, right: 20, bottom: 30, left: 40 };\nlet edges_float = edges.map(|&value| value as f32 * 1.1);\nassert_eq!(edges_float, Edges { top: 11.0, right: 22.0, bottom: 33.0, left: 44.0 });\n```", "signature": "pub fn map (& self, f : impl Fn (& T) -> U) -> Edges where U : Clone + Debug + Default + PartialEq,", "cfg": [], "target": "Edges" }, { "id": "gpui::geometry::Edges::max", "name": "max", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the maximum value of any edge.", "documentation": "Returns the maximum value of any edge.\n\n# Returns\n\nThe maximum `Pixels` value among all four edges.", "signature": "pub fn max (& self) -> Pixels", "cfg": [], "target": "Edges" }, { "id": "gpui::geometry::Edges::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Scales the `Edges` by a given factor, returning `Edges`.", "documentation": "Scales the `Edges` by a given factor, returning `Edges`.\n\nThis method is typically used for adjusting the edge sizes for different display densities or scaling factors.\n\n# Arguments\n\n* `factor` - The scaling factor to apply to each edge.\n\n# Returns\n\nReturns a new `Edges` where each edge is the result of scaling the original edge by the given factor.\n\n# Examples\n\n```\n# use gpui::{Edges, Pixels, ScaledPixels};\nlet edges = Edges {\ntop: Pixels::from(10.0),\nright: Pixels::from(20.0),\nbottom: Pixels::from(30.0),\nleft: Pixels::from(40.0),\n};\nlet scaled_edges = edges.scale(2.0);\nassert_eq!(scaled_edges.top, ScaledPixels::from(20.0));\nassert_eq!(scaled_edges.right, ScaledPixels::from(40.0));\nassert_eq!(scaled_edges.bottom, ScaledPixels::from(60.0));\nassert_eq!(scaled_edges.left, ScaledPixels::from(80.0));\n```", "signature": "pub fn scale (& self, factor : f32) -> Edges", "cfg": [], "target": "Edges" }, { "id": "gpui::geometry::Edges::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "summary": "Converts the `AbsoluteLength` to `Pixels` based on the `rem_size`.", "declarations": [ { "source": "crates/gpui/src/geometry.rs", "documentation": "Converts the `AbsoluteLength` to `Pixels` based on the `rem_size`.\n\nIf the `AbsoluteLength` is already in pixels, it simply returns the corresponding `Pixels` value.\nIf the `AbsoluteLength` is in rems, it multiplies the number of rems by the `rem_size` to convert it to pixels.\n\n# Arguments\n\n* `rem_size` - The size of one rem unit in pixels.\n\n# Returns\n\nReturns an `Edges` representing the edges with lengths converted to pixels.\n\n# Examples\n\n```\n# use gpui::{Edges, AbsoluteLength, Pixels, px, rems};\nlet edges = Edges {\ntop: AbsoluteLength::Pixels(px(10.0)),\nright: AbsoluteLength::Rems(rems(1.0)),\nbottom: AbsoluteLength::Pixels(px(20.0)),\nleft: AbsoluteLength::Rems(rems(2.0)),\n};\nlet rem_size = px(16.0);\nlet edges_in_pixels = edges.to_pixels(rem_size);\n\nassert_eq!(edges_in_pixels.top, px(10.0)); // Already in pixels\nassert_eq!(edges_in_pixels.right, px(16.0)); // 1 rem converted to pixels\nassert_eq!(edges_in_pixels.bottom, px(20.0)); // Already in pixels\nassert_eq!(edges_in_pixels.left, px(32.0)); // 2 rems converted to pixels\n```", "signature": "pub fn to_pixels (self, rem_size : Pixels) -> Edges", "cfg": [], "target": "Edges" }, { "source": "crates/gpui/src/geometry.rs", "documentation": "Converts the `DefiniteLength` to `Pixels` based on the parent size and the REM size.\n\nThis method allows for a `DefiniteLength` value to be converted into pixels, taking into account\nthe size of the parent element (for percentage-based lengths) and the size of a rem unit (for rem-based lengths).\n\n# Arguments\n\n* `parent_size` - `Size` representing the size of the parent element.\n* `rem_size` - `Pixels` representing the size of one REM unit.\n\n# Returns\n\nReturns an `Edges` representing the edges with lengths converted to pixels.\n\n# Examples\n\n```\n# use gpui::{Edges, DefiniteLength, px, AbsoluteLength, rems, Size};\nlet edges = Edges {\ntop: DefiniteLength::Absolute(AbsoluteLength::Pixels(px(10.0))),\nright: DefiniteLength::Fraction(0.5),\nbottom: DefiniteLength::Absolute(AbsoluteLength::Rems(rems(2.0))),\nleft: DefiniteLength::Fraction(0.25),\n};\nlet parent_size = Size {\nwidth: AbsoluteLength::Pixels(px(200.0)),\nheight: AbsoluteLength::Pixels(px(100.0)),\n};\nlet rem_size = px(16.0);\nlet edges_in_pixels = edges.to_pixels(parent_size, rem_size);\n\nassert_eq!(edges_in_pixels.top, px(10.0)); // Absolute length in pixels\nassert_eq!(edges_in_pixels.right, px(100.0)); // 50% of parent width\nassert_eq!(edges_in_pixels.bottom, px(32.0)); // 2 rems\nassert_eq!(edges_in_pixels.left, px(50.0)); // 25% of parent width\n```", "signature": "pub fn to_pixels (self, parent_size : Size, rem_size : Pixels) -> Edges", "cfg": [], "target": "Edges" } ] }, { "id": "gpui::geometry::Edges::zero", "name": "zero", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "summary": "Sets the edges of the `Edges` struct to zero, which means no size or thickness.", "declarations": [ { "source": "crates/gpui/src/geometry.rs", "documentation": "Sets the edges of the `Edges` struct to zero, which means no size or thickness.\n\nThis is typically used when you want to specify that a box (like a padding or margin area)\nshould have no edges, effectively making it non-existent or invisible in layout calculations.\n\n# Returns\n\nReturns an `Edges` with all edges set to zero length.\n\n# Examples\n\n```\n# use gpui::{AbsoluteLength, Edges, Pixels};\nlet no_edges = Edges::::zero();\nassert_eq!(no_edges.top, AbsoluteLength::Pixels(Pixels::ZERO));\nassert_eq!(no_edges.right, AbsoluteLength::Pixels(Pixels::ZERO));\nassert_eq!(no_edges.bottom, AbsoluteLength::Pixels(Pixels::ZERO));\nassert_eq!(no_edges.left, AbsoluteLength::Pixels(Pixels::ZERO));\n```", "signature": "pub fn zero () -> Self", "cfg": [], "target": "Edges" }, { "source": "crates/gpui/src/geometry.rs", "documentation": "Sets the edges of the `Edges` struct to zero, which means no size or thickness.\n\nThis is typically used when you want to specify that a box (like a padding or margin area)\nshould have no edges, effectively making it non-existent or invisible in layout calculations.\n\n# Returns\n\nReturns an `Edges` with all edges set to zero length.\n\n# Examples\n\n```\n# use gpui::{px, DefiniteLength, Edges};\nlet no_edges = Edges::::zero();\nassert_eq!(no_edges.top, DefiniteLength::from(px(0.)));\nassert_eq!(no_edges.right, DefiniteLength::from(px(0.)));\nassert_eq!(no_edges.bottom, DefiniteLength::from(px(0.)));\nassert_eq!(no_edges.left, DefiniteLength::from(px(0.)));\n```", "signature": "pub fn zero () -> Self", "cfg": [], "target": "Edges" }, { "source": "crates/gpui/src/geometry.rs", "documentation": "Sets the edges of the `Edges` struct to zero, which means no size or thickness.\n\nThis is typically used when you want to specify that a box (like a padding or margin area)\nshould have no edges, effectively making it non-existent or invisible in layout calculations.\n\n# Returns\n\nReturns an `Edges` with all edges set to zero length.\n\n# Examples\n\n```\n# use gpui::{DefiniteLength, Edges, Length, Pixels};\nlet no_edges = Edges::::zero();\nassert_eq!(no_edges.top, Length::Definite(DefiniteLength::from(Pixels::ZERO)));\nassert_eq!(no_edges.right, Length::Definite(DefiniteLength::from(Pixels::ZERO)));\nassert_eq!(no_edges.bottom, Length::Definite(DefiniteLength::from(Pixels::ZERO)));\nassert_eq!(no_edges.left, Length::Definite(DefiniteLength::from(Pixels::ZERO)));\n```", "signature": "pub fn zero () -> Self", "cfg": [], "target": "Edges" } ] }, { "id": "gpui::geometry::GridLocation", "name": "GridLocation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A location in a grid layout.", "documentation": "A location in a grid layout.", "signature": "# [doc = \" A location in a grid layout.\"] # [derive (Clone, PartialEq, Debug, Serialize, Deserialize, JsonSchema, Default)] pub struct GridLocation { # [doc = \" The rows this item uses within the grid.\"] pub row : Range, # [doc = \" The columns this item uses within the grid.\"] pub column : Range, }", "cfg": [] }, { "id": "gpui::geometry::GridPlacement", "name": "GridPlacement", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "The placement of an item within a grid layout's column or row.", "documentation": "The placement of an item within a grid layout's column or row.", "signature": "# [doc = \" The placement of an item within a grid layout's column or row.\"] # [derive (Clone, Copy, PartialEq, Debug, Serialize, Deserialize, JsonSchema, Default)] pub enum GridPlacement { # [doc = \" The grid line index to place this item.\"] Line (i16), # [doc = \" The number of grid lines to span.\"] Span (u16), # [doc = \" Automatically determine the placement, equivalent to Span(1)\"] # [default] Auto, }", "cfg": [] }, { "id": "gpui::geometry::Half", "name": "Half", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Provides a trait for types that can calculate half of their value.", "documentation": "Provides a trait for types that can calculate half of their value.\n\nThe `Half` trait is used for types that can be evenly divided, returning a new instance of the same type\nrepresenting half of the original value. This is commonly used for types that represent measurements or sizes,\nsuch as lengths or pixels, where halving is a frequent operation during layout calculations or animations.", "signature": "# [doc = \" Provides a trait for types that can calculate half of their value.\"] # [doc = \"\"] # [doc = \" The `Half` trait is used for types that can be evenly divided, returning a new instance of the same type\"] # [doc = \" representing half of the original value. This is commonly used for types that represent measurements or sizes,\"] # [doc = \" such as lengths or pixels, where halving is a frequent operation during layout calculations or animations.\"] pub trait Half { # [doc = \" Returns half of the current value.\"] # [doc = \"\"] # [doc = \" # Returns\"] # [doc = \"\"] # [doc = \" A new instance of the implementing type, representing half of the original value.\"] fn half (& self) -> Self; }", "cfg": [] }, { "id": "gpui::geometry::IsZero", "name": "IsZero", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A trait for checking if a value is zero.", "documentation": "A trait for checking if a value is zero.\n\nThis trait provides a method to determine if a value is considered to be zero.\nIt is implemented for various numeric and length-related types where the concept\nof zero is applicable. This can be useful for comparisons, optimizations, or\ndetermining if an operation has a neutral effect.", "signature": "# [doc = \" A trait for checking if a value is zero.\"] # [doc = \"\"] # [doc = \" This trait provides a method to determine if a value is considered to be zero.\"] # [doc = \" It is implemented for various numeric and length-related types where the concept\"] # [doc = \" of zero is applicable. This can be useful for comparisons, optimizations, or\"] # [doc = \" determining if an operation has a neutral effect.\"] pub trait IsZero { # [doc = \" Determines if the value is zero.\"] # [doc = \"\"] # [doc = \" # Returns\"] # [doc = \"\"] # [doc = \" Returns `true` if the value is zero, `false` otherwise.\"] fn is_zero (& self) -> bool; }", "cfg": [] }, { "id": "gpui::geometry::Length", "name": "Length", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A length that can be defined in pixels, rems, percent of parent, or auto.", "documentation": "A length that can be defined in pixels, rems, percent of parent, or auto.", "signature": "# [doc = \" A length that can be defined in pixels, rems, percent of parent, or auto.\"] # [derive (Clone, Copy, PartialEq)] pub enum Length { # [doc = \" A definite length specified either in pixels, rems, or as a fraction of the parent's size.\"] Definite (DefiniteLength), # [doc = \" An automatic length that is determined by the context in which it is used.\"] Auto, }", "cfg": [] }, { "id": "gpui::geometry::Percentage", "name": "Percentage", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A type representing a percentage value.", "documentation": "A type representing a percentage value.", "signature": "# [doc = \" A type representing a percentage value.\"] # [derive (Clone, Copy, Default, Add, AddAssign, Sub, SubAssign, Neg, Div, DivAssign, PartialEq, Serialize, Deserialize, Debug,)] # [repr (transparent)] pub struct Percentage (pub f32);", "cfg": [] }, { "id": "gpui::geometry::Pixels", "name": "Pixels", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents a length in pixels, the base unit of measurement in the UI framework.", "documentation": "Represents a length in pixels, the base unit of measurement in the UI framework.\n\n`Pixels` is a value type that represents an absolute length in pixels, which is used\nfor specifying sizes, positions, and distances in the UI. It is the fundamental unit\nof measurement for all visual elements and layout calculations.\n\nThe inner value is an `f32`, allowing for sub-pixel precision which can be useful for\nanti-aliasing and animations. However, when applied to actual pixel grids, the value\nis typically rounded to the nearest integer.\n\n# Examples\n\n```\nuse gpui::{Pixels, ScaledPixels};\n\n// Define a length of 10 pixels\nlet length = Pixels::from(10.0);\n\n// Define a length and scale it by a factor of 2\nlet scaled_length = length.scale(2.0);\nassert_eq!(scaled_length, ScaledPixels::from(20.0));\n```", "signature": "# [doc = \" Represents a length in pixels, the base unit of measurement in the UI framework.\"] # [doc = \"\"] # [doc = \" `Pixels` is a value type that represents an absolute length in pixels, which is used\"] # [doc = \" for specifying sizes, positions, and distances in the UI. It is the fundamental unit\"] # [doc = \" of measurement for all visual elements and layout calculations.\"] # [doc = \"\"] # [doc = \" The inner value is an `f32`, allowing for sub-pixel precision which can be useful for\"] # [doc = \" anti-aliasing and animations. However, when applied to actual pixel grids, the value\"] # [doc = \" is typically rounded to the nearest integer.\"] # [doc = \"\"] # [doc = \" # Examples\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" use gpui::{Pixels, ScaledPixels};\"] # [doc = \"\"] # [doc = \" // Define a length of 10 pixels\"] # [doc = \" let length = Pixels::from(10.0);\"] # [doc = \"\"] # [doc = \" // Define a length and scale it by a factor of 2\"] # [doc = \" let scaled_length = length.scale(2.0);\"] # [doc = \" assert_eq!(scaled_length, ScaledPixels::from(20.0));\"] # [doc = \" ```\"] # [derive (Clone, Copy, Default, Add, AddAssign, Sub, SubAssign, Neg, Div, DivAssign, PartialEq, Serialize, Deserialize, JsonSchema,)] # [repr (transparent)] pub struct Pixels (pub (crate) f32);", "cfg": [] }, { "id": "gpui::geometry::Pixels::abs", "name": "abs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the absolute value of the `Pixels`.", "documentation": "Returns the absolute value of the `Pixels`.\n\n# Returns\n\nA new `Pixels` instance with the absolute value of the original `Pixels`.", "signature": "pub fn abs (& self) -> Self", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::as_f32", "name": "as_f32", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the raw `f32` value of this `Pixels`.", "documentation": "Returns the raw `f32` value of this `Pixels`.", "signature": "pub fn as_f32 (self) -> f32", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::ceil", "name": "ceil", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the ceiling of the `Pixels` value to the nearest whole number.", "documentation": "Returns the ceiling of the `Pixels` value to the nearest whole number.\n\n# Returns\n\nReturns a new `Pixels` instance with the ceiling value.", "signature": "pub fn ceil (& self) -> Self", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::floor", "name": "floor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Floors the `Pixels` value to the nearest whole number.", "documentation": "Floors the `Pixels` value to the nearest whole number.\n\n# Returns\n\nReturns a new `Pixels` instance with the floored value.", "signature": "pub fn floor (& self) -> Self", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::pow", "name": "pow", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Raises the `Pixels` value to a given power.", "documentation": "Raises the `Pixels` value to a given power.\n\n# Arguments\n\n* `exponent` - The exponent to raise the `Pixels` value by.\n\n# Returns\n\nReturns a new `Pixels` instance with the value raised to the given exponent.", "signature": "pub fn pow (& self, exponent : f32) -> Self", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::round", "name": "round", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Rounds the `Pixels` value to the nearest whole number.", "documentation": "Rounds the `Pixels` value to the nearest whole number.\n\n# Returns\n\nReturns a new `Pixels` instance with the rounded value.", "signature": "pub fn round (& self) -> Self", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Scales the `Pixels` value by a given factor, producing `ScaledPixels`.", "documentation": "Scales the `Pixels` value by a given factor, producing `ScaledPixels`.\n\nThis method is used when adjusting pixel values for display scaling factors,\nsuch as high DPI (dots per inch) or Retina displays, where the pixel density is higher and\nthus requires scaling to maintain visual consistency and readability.\n\nThe resulting `ScaledPixels` represent the scaled value which can be used for rendering\ncalculations where display scaling is considered.", "signature": "pub fn scale (& self, factor : f32) -> ScaledPixels", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::signum", "name": "signum", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the sign of the `Pixels` value.", "documentation": "Returns the sign of the `Pixels` value.\n\n# Returns\n\nReturns:\n* `1.0` if the value is positive\n* `-1.0` if the value is negative", "signature": "pub fn signum (& self) -> f32", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Pixels::to_f64", "name": "to_f64", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the f64 value of `Pixels`.", "documentation": "Returns the f64 value of `Pixels`.\n\n# Returns\n\nA f64 value of the `Pixels`.", "signature": "pub fn to_f64 (self) -> f64", "cfg": [], "target": "Pixels" }, { "id": "gpui::geometry::Point", "name": "Point", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Describes a location in a 2D cartesian space.", "documentation": "Describes a location in a 2D cartesian space.\n\nIt holds two public fields, `x` and `y`, which represent the coordinates in the space.\nThe type `T` for the coordinates can be any type that implements `Default`, `Clone`, and `Debug`.\n\n# Examples\n\n```\n# use gpui::Point;\nlet point = Point { x: 10, y: 20 };\nprintln!(\"{:?}\", point); // Outputs: Point { x: 10, y: 20 }\n```", "signature": "# [doc = \" Describes a location in a 2D cartesian space.\"] # [doc = \"\"] # [doc = \" It holds two public fields, `x` and `y`, which represent the coordinates in the space.\"] # [doc = \" The type `T` for the coordinates can be any type that implements `Default`, `Clone`, and `Debug`.\"] # [doc = \"\"] # [doc = \" # Examples\"] # [doc = \"\"] # [doc = \" ```\"] # [doc = \" # use gpui::Point;\"] # [doc = \" let point = Point { x: 10, y: 20 };\"] # [doc = \" println!(\\\"{:?}\\\", point); // Outputs: Point { x: 10, y: 20 }\"] # [doc = \" ```\"] # [derive (Refineable, Default, Add, AddAssign, Sub, SubAssign, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Hash, Neg,)] # [refineable (Debug, PartialEq, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub struct Point { # [doc = \" The x coordinate of the point.\"] pub x : T, # [doc = \" The y coordinate of the point.\"] pub y : T, }", "cfg": [] }, { "id": "gpui::geometry::Point::clamp", "name": "clamp", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Clamps the point to a specified range.", "documentation": "Clamps the point to a specified range.\n\nGiven a minimum point and a maximum point, this method constrains the current point\nsuch that its coordinates do not exceed the range defined by the minimum and maximum points.\nIf the current point's coordinates are less than the minimum, they are set to the minimum.\nIf they are greater than the maximum, they are set to the maximum.\n\n# Arguments\n\n* `min` - A reference to a `Point` representing the minimum allowable coordinates.\n* `max` - A reference to a `Point` representing the maximum allowable coordinates.\n\n# Examples\n\n```\n# use gpui::Point;\nlet p = Point { x: 10, y: 20 };\nlet min = Point { x: 0, y: 5 };\nlet max = Point { x: 15, y: 25 };\nlet clamped_p = p.clamp(&min, &max);\nassert_eq!(clamped_p, Point { x: 10, y: 20 });\n\nlet p_out_of_bounds = Point { x: -5, y: 30 };\nlet clamped_p_out_of_bounds = p_out_of_bounds.clamp(&min, &max);\nassert_eq!(clamped_p_out_of_bounds, Point { x: 0, y: 25 });\n```", "signature": "pub fn clamp (& self, min : & Self, max : & Self) -> Self", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::magnitude", "name": "magnitude", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Calculates the Euclidean distance from the origin (0, 0) to this point.", "documentation": "Calculates the Euclidean distance from the origin (0, 0) to this point.\n\n# Examples\n\n```\n# use gpui::{Pixels, Point};\nlet p = Point { x: Pixels::from(3.0), y: Pixels::from(4.0) };\nassert_eq!(p.magnitude(), 5.0);\n```", "signature": "pub fn magnitude (& self) -> f64", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Transforms the point to a `Point` by applying the given function to both coordinates.", "documentation": "Transforms the point to a `Point` by applying the given function to both coordinates.\n\nThis method allows for converting a `Point` to a `Point` by specifying a closure\nthat defines how to convert between the two types. The closure is applied to both the `x`\nand `y` coordinates, resulting in a new point of the desired type.\n\n# Arguments\n\n* `f` - A closure that takes a value of type `T` and returns a value of type `U`.\n\n# Examples\n\n```\n# use gpui::Point;\nlet p = Point { x: 3, y: 4 };\nlet p_float = p.map(|coord| coord as f32);\nassert_eq!(p_float, Point { x: 3.0, y: 4.0 });\n```", "signature": "pub fn map (& self, f : impl Fn (T) -> U) -> Point", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::max", "name": "max", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a new point with the maximum values of each dimension from `self` and `other`.", "documentation": "Returns a new point with the maximum values of each dimension from `self` and `other`.\n\n# Arguments\n\n* `other` - A reference to another `Point` to compare with `self`.\n\n# Examples\n\n```\n# use gpui::Point;\nlet p1 = Point { x: 3, y: 7 };\nlet p2 = Point { x: 5, y: 2 };\nlet max_point = p1.max(&p2);\nassert_eq!(max_point, Point { x: 5, y: 7 });\n```", "signature": "pub fn max (& self, other : & Self) -> Self", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::min", "name": "min", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a new point with the minimum values of each dimension from `self` and `other`.", "documentation": "Returns a new point with the minimum values of each dimension from `self` and `other`.\n\n# Arguments\n\n* `other` - A reference to another `Point` to compare with `self`.\n\n# Examples\n\n```\n# use gpui::Point;\nlet p1 = Point { x: 3, y: 7 };\nlet p2 = Point { x: 5, y: 2 };\nlet min_point = p1.min(&p2);\nassert_eq!(min_point, Point { x: 3, y: 2 });\n```", "signature": "pub fn min (& self, other : & Self) -> Self", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Creates a new `Point` with the specified `x` and `y` coordinates.", "documentation": "Creates a new `Point` with the specified `x` and `y` coordinates.\n\n# Arguments\n\n* `x` - The horizontal coordinate of the point.\n* `y` - The vertical coordinate of the point.\n\n# Examples\n\n```\nuse gpui::Point;\nlet p = Point::new(10, 20);\nassert_eq!(p.x, 10);\nassert_eq!(p.y, 20);\n```", "signature": "pub const fn new (x : T, y : T) -> Self", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::relative_to", "name": "relative_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Get the position of this point, relative to the given origin", "documentation": "Get the position of this point, relative to the given origin", "signature": "pub fn relative_to (& self, origin : & Point) -> Point", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Point::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Scales the point by a given factor, which is typically derived from the resolution of a target display to ensure proper sizing of UI elements.", "documentation": "Scales the point by a given factor, which is typically derived from the resolution\nof a target display to ensure proper sizing of UI elements.\n\n# Arguments\n\n* `factor` - The scaling factor to apply to both the x and y coordinates.\n\n# Examples\n\n```\n# use gpui::{Point, Pixels, ScaledPixels};\nlet p = Point { x: Pixels::from(10.0), y: Pixels::from(20.0) };\nlet scaled_p = p.scale(1.5);\nassert_eq!(scaled_p, Point { x: ScaledPixels::from(15.0), y: ScaledPixels::from(30.0) });\n```", "signature": "pub fn scale (& self, factor : f32) -> Point", "cfg": [], "target": "Point" }, { "id": "gpui::geometry::Radians", "name": "Radians", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents an angle in Radians", "documentation": "Represents an angle in Radians", "signature": "# [doc = \" Represents an angle in Radians\"] # [derive (Clone, Copy, Default, Add, AddAssign, Sub, SubAssign, Neg, Div, DivAssign, PartialEq, Serialize, Deserialize, Debug,)] # [repr (transparent)] pub struct Radians (pub f32);", "cfg": [] }, { "id": "gpui::geometry::Rems", "name": "Rems", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents a length in rems, a unit based on the font-size of the window, which can be assigned with [`Window::set_rem_size`][set_rem_size].", "documentation": "Represents a length in rems, a unit based on the font-size of the window, which can be assigned with [`Window::set_rem_size`][set_rem_size].\n\nRems are used for defining lengths that are scalable and consistent across different UI elements.\nThe value of `1rem` is typically equal to the font-size of the root element (often the `` element in browsers),\nmaking it a flexible unit that adapts to the user's text size preferences. In this framework, `rems` serve a similar\npurpose, allowing for scalable and accessible design that can adjust to different display settings or user preferences.\n\nFor example, if the root element's font-size is `16px`, then `1rem` equals `16px`. A length of `2rems` would then be `32px`.\n\n[set_rem_size]: crate::Window::set_rem_size", "signature": "# [doc = \" Represents a length in rems, a unit based on the font-size of the window, which can be assigned with [`Window::set_rem_size`][set_rem_size].\"] # [doc = \"\"] # [doc = \" Rems are used for defining lengths that are scalable and consistent across different UI elements.\"] # [doc = \" The value of `1rem` is typically equal to the font-size of the root element (often the `` element in browsers),\"] # [doc = \" making it a flexible unit that adapts to the user's text size preferences. In this framework, `rems` serve a similar\"] # [doc = \" purpose, allowing for scalable and accessible design that can adjust to different display settings or user preferences.\"] # [doc = \"\"] # [doc = \" For example, if the root element's font-size is `16px`, then `1rem` equals `16px`. A length of `2rems` would then be `32px`.\"] # [doc = \"\"] # [doc = \" [set_rem_size]: crate::Window::set_rem_size\"] # [derive (Clone, Copy, Default, Add, Sub, Mul, Div, Neg, PartialEq)] pub struct Rems (pub f32);", "cfg": [] }, { "id": "gpui::geometry::Rems::from_pixels", "name": "from_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Convert from pixels to Rem", "documentation": "Convert from pixels to Rem", "signature": "pub fn from_pixels (length : Pixels, window : & gpui::Window) -> Self", "cfg": [], "target": "Rems" }, { "id": "gpui::geometry::Rems::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Convert this Rem value to pixels.", "documentation": "Convert this Rem value to pixels.", "signature": "pub fn to_pixels (self, rem_size : Pixels) -> Pixels", "cfg": [], "target": "Rems" }, { "id": "gpui::geometry::ScaledPixels", "name": "ScaledPixels", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Represents scaled pixels that take into account the device's scale factor.", "documentation": "Represents scaled pixels that take into account the device's scale factor.\n\n`ScaledPixels` are used to ensure that UI elements appear at the correct size on devices\nwith different pixel densities. When a device has a higher scale factor (such as Retina displays),\na single logical pixel may correspond to multiple physical pixels. By using `ScaledPixels`,\ndimensions and positions can be specified in a way that scales appropriately across different\ndisplay resolutions.", "signature": "# [doc = \" Represents scaled pixels that take into account the device's scale factor.\"] # [doc = \"\"] # [doc = \" `ScaledPixels` are used to ensure that UI elements appear at the correct size on devices\"] # [doc = \" with different pixel densities. When a device has a higher scale factor (such as Retina displays),\"] # [doc = \" a single logical pixel may correspond to multiple physical pixels. By using `ScaledPixels`,\"] # [doc = \" dimensions and positions can be specified in a way that scales appropriately across different\"] # [doc = \" display resolutions.\"] # [derive (Clone, Copy, Default, Add, AddAssign, Sub, SubAssign, Div, DivAssign, PartialEq)] # [repr (transparent)] pub struct ScaledPixels (pub f32);", "cfg": [] }, { "id": "gpui::geometry::ScaledPixels::as_f32", "name": "as_f32", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the raw `f32` value of this `ScaledPixels`.", "documentation": "Returns the raw `f32` value of this `ScaledPixels`.", "signature": "pub fn as_f32 (self) -> f32", "cfg": [], "target": "ScaledPixels" }, { "id": "gpui::geometry::ScaledPixels::ceil", "name": "ceil", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Ceils the `ScaledPixels` value to the nearest whole number.", "documentation": "Ceils the `ScaledPixels` value to the nearest whole number.\n\n# Returns\n\nReturns a new `ScaledPixels` instance with the ceiled value.", "signature": "pub fn ceil (& self) -> Self", "cfg": [], "target": "ScaledPixels" }, { "id": "gpui::geometry::ScaledPixels::floor", "name": "floor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Floors the `ScaledPixels` value to the nearest whole number.", "documentation": "Floors the `ScaledPixels` value to the nearest whole number.\n\n# Returns\n\nReturns a new `ScaledPixels` instance with the floored value.", "signature": "pub fn floor (& self) -> Self", "cfg": [], "target": "ScaledPixels" }, { "id": "gpui::geometry::ScaledPixels::round", "name": "round", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Rounds the `ScaledPixels` value to the nearest whole number.", "documentation": "Rounds the `ScaledPixels` value to the nearest whole number.\n\n# Returns\n\nReturns a new `ScaledPixels` instance with the rounded value.", "signature": "pub fn round (& self) -> Self", "cfg": [], "target": "ScaledPixels" }, { "id": "gpui::geometry::Size", "name": "Size", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "A structure representing a two-dimensional size with width and height in a given unit.", "documentation": "A structure representing a two-dimensional size with width and height in a given unit.\n\nThis struct is generic over the type `T`, which can be any type that implements `Clone`, `Default`, and `Debug`.\nIt is commonly used to specify dimensions for elements in a UI, such as a window or element.", "signature": "# [doc = \" A structure representing a two-dimensional size with width and height in a given unit.\"] # [doc = \"\"] # [doc = \" This struct is generic over the type `T`, which can be any type that implements `Clone`, `Default`, and `Debug`.\"] # [doc = \" It is commonly used to specify dimensions for elements in a UI, such as a window or element.\"] # [derive (Add, Clone, Copy, Default, Deserialize, Div, Hash, Neg, PartialEq, Refineable, Serialize, Sub,)] # [refineable (Debug, PartialEq, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub struct Size { # [doc = \" The width component of the size.\"] pub width : T, # [doc = \" The height component of the size.\"] pub height : T, }", "cfg": [] }, { "id": "gpui::geometry::Size::auto", "name": "auto", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a `Size` with both width and height set to `auto`, which allows the layout engine to determine the size.", "documentation": "Returns a `Size` with both width and height set to `auto`, which allows the layout engine to determine the size.\n\nThis function creates a `Size` instance where both the width and height are set to `Length::Auto`,\nindicating that their size should be computed based on the layout context, such as the content size or\navailable space.\n\n# Returns\n\nA `Size` with width and height set to `Length::Auto`.", "signature": "pub fn auto () -> Self", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::center", "name": "center", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Compute the center point of the size.g", "documentation": "Compute the center point of the size.g", "signature": "pub fn center (& self) -> Point", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::full", "name": "full", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a `Size` with both width and height set to fill the available space.", "documentation": "Returns a `Size` with both width and height set to fill the available space.\n\nThis function creates a `Size` instance where both the width and height are set to `Length::Definite(DefiniteLength::Fraction(1.0))`,\nwhich represents 100% of the available space in both dimensions.\n\n# Returns\n\nA `Size` that will fill the available space when used in a layout.", "signature": "pub fn full () -> Self", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::map", "name": "map", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Applies a function to the width and height of the size, producing a new `Size`.", "documentation": "Applies a function to the width and height of the size, producing a new `Size`.\n\nThis method allows for converting a `Size` to a `Size` by specifying a closure\nthat defines how to convert between the two types. The closure is applied to both the `width`\nand `height`, resulting in a new size of the desired type.\n\n# Arguments\n\n* `f` - A closure that takes a value of type `T` and returns a value of type `U`.\n\n# Examples\n\n```\n# use gpui::Size;\nlet my_size = Size { width: 10, height: 20 };\nlet my_new_size = my_size.map(|dimension| dimension as f32 * 1.5);\nassert_eq!(my_new_size, Size { width: 15.0, height: 30.0 });\n```", "signature": "pub fn map (& self, f : impl Fn (T) -> U) -> Size where U : Clone + Debug + Default + PartialEq,", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::max", "name": "max", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a new `Size` with the maximum width and height from `self` and `other`.", "documentation": "Returns a new `Size` with the maximum width and height from `self` and `other`.\n\n# Arguments\n\n* `other` - A reference to another `Size` to compare with `self`.\n\n# Examples\n\n```\n# use gpui::Size;\nlet size1 = Size { width: 30, height: 40 };\nlet size2 = Size { width: 50, height: 20 };\nlet max_size = size1.max(&size2);\nassert_eq!(max_size, Size { width: 50, height: 40 });\n```", "signature": "pub fn max (& self, other : & Self) -> Self", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::min", "name": "min", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a new `Size` with the minimum width and height from `self` and `other`.", "documentation": "Returns a new `Size` with the minimum width and height from `self` and `other`.\n\n# Arguments\n\n* `other` - A reference to another `Size` to compare with `self`.\n\n# Examples\n\n```\n# use gpui::Size;\nlet size1 = Size { width: 30, height: 40 };\nlet size2 = Size { width: 50, height: 20 };\nlet min_size = size1.min(&size2);\nassert_eq!(min_size, Size { width: 30, height: 20 });\n```", "signature": "pub fn min (& self, other : & Self) -> Self", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Create a new Size, a synonym for [`size`]", "documentation": "Create a new Size, a synonym for [`size`]", "signature": "pub fn new (width : T, height : T) -> Self", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Scales the size by a given factor.", "documentation": "Scales the size by a given factor.\n\nThis method multiplies both the width and height by the provided scaling factor,\nresulting in a new `Size` that is proportionally larger or smaller\ndepending on the factor.\n\n# Arguments\n\n* `factor` - The scaling factor to apply to the width and height.\n\n# Examples\n\n```\n# use gpui::{Size, Pixels, ScaledPixels};\nlet size = Size { width: Pixels::from(100.0), height: Pixels::from(50.0) };\nlet scaled_size = size.scale(2.0);\nassert_eq!(scaled_size, Size { width: ScaledPixels::from(200.0), height: ScaledPixels::from(100.0) });\n```", "signature": "pub fn scale (& self, factor : f32) -> Size", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::to_device_pixels", "name": "to_device_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts the size from logical to physical pixels.", "documentation": "Converts the size from logical to physical pixels.", "signature": "pub fn to_device_pixels (self, scale_factor : f32) -> Size", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::Size::to_pixels", "name": "to_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Converts the size from physical to logical pixels.", "documentation": "Converts the size from physical to logical pixels.", "signature": "pub fn to_pixels (self, scale_factor : f32) -> Size", "cfg": [], "target": "Size" }, { "id": "gpui::geometry::auto", "name": "auto", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns a `Length` representing an automatic length.", "documentation": "Returns a `Length` representing an automatic length.\n\nThe `auto` length is often used in layout calculations where the length should be determined\nby the layout context itself rather than being explicitly set. This is commonly used in CSS\nfor properties like `width`, `height`, `margin`, `padding`, etc., where `auto` can be used\nto instruct the layout engine to calculate the size based on other factors like the size of the\ncontainer or the intrinsic size of the content.\n\n# Returns\n\nA `Length` variant set to `Auto`.", "signature": "pub const fn auto () -> Length", "cfg": [] }, { "id": "gpui::geometry::bounds", "name": "bounds", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Create a bounds with the given origin and size", "documentation": "Create a bounds with the given origin and size", "signature": "pub fn bounds (origin : Point, size : Size,) -> Bounds", "cfg": [] }, { "id": "gpui::geometry::percentage", "name": "percentage", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Generate a `Radian` from a percentage of a full circle.", "documentation": "Generate a `Radian` from a percentage of a full circle.", "signature": "pub fn percentage (value : f32) -> Percentage", "cfg": [] }, { "id": "gpui::geometry::phi", "name": "phi", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Returns the Golden Ratio, i.e. `~(1.0 + sqrt(5.0)) / 2.0`.", "documentation": "Returns the Golden Ratio, i.e. `~(1.0 + sqrt(5.0)) / 2.0`.", "signature": "pub const fn phi () -> DefiniteLength", "cfg": [] }, { "id": "gpui::geometry::point", "name": "point", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a new `Point` with the given x and y coordinates.", "documentation": "Constructs a new `Point` with the given x and y coordinates.\n\n# Arguments\n\n* `x` - The x coordinate of the point.\n* `y` - The y coordinate of the point.\n\n# Returns\n\nReturns a `Point` with the specified coordinates.\n\n# Examples\n\n```\nuse gpui::point;\nlet p = point(10, 20);\nassert_eq!(p.x, 10);\nassert_eq!(p.y, 20);\n```", "signature": "pub const fn point (x : T, y : T) -> Point", "cfg": [] }, { "id": "gpui::geometry::px", "name": "px", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a `Pixels` value representing a length in pixels.", "documentation": "Constructs a `Pixels` value representing a length in pixels.\n\n# Arguments\n\n* `pixels` - The number of pixels for the length.\n\n# Returns\n\nA `Pixels` representing the specified number of pixels.", "signature": "pub const fn px (pixels : f32) -> Pixels", "cfg": [] }, { "id": "gpui::geometry::radians", "name": "radians", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Create a `Radian` from a raw value", "documentation": "Create a `Radian` from a raw value", "signature": "pub fn radians (value : f32) -> Radians", "cfg": [] }, { "id": "gpui::geometry::relative", "name": "relative", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a `DefiniteLength` representing a relative fraction of a parent size.", "documentation": "Constructs a `DefiniteLength` representing a relative fraction of a parent size.\n\nThis function creates a `DefiniteLength` that is a specified fraction of a parent's dimension.\nThe fraction should be a floating-point number between 0.0 and 1.0, where 1.0 represents 100% of the parent's size.\n\n# Arguments\n\n* `fraction` - The fraction of the parent's size, between 0.0 and 1.0.\n\n# Returns\n\nA `DefiniteLength` representing the relative length as a fraction of the parent's size.", "signature": "pub const fn relative (fraction : f32) -> DefiniteLength", "cfg": [] }, { "id": "gpui::geometry::rems", "name": "rems", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a `Rems` value representing a length in rems.", "documentation": "Constructs a `Rems` value representing a length in rems.\n\n# Arguments\n\n* `rems` - The number of rems for the length.\n\n# Returns\n\nA `Rems` representing the specified number of rems.", "signature": "pub const fn rems (rems : f32) -> Rems", "cfg": [] }, { "id": "gpui::geometry::size", "name": "size", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "geometry", "path": "gpui::geometry", "source": "crates/gpui/src/geometry.rs", "summary": "Constructs a new `Size` with the provided width and height.", "documentation": "Constructs a new `Size` with the provided width and height.\n\n# Arguments\n\n* `width` - The width component of the `Size`.\n* `height` - The height component of the `Size`.\n\n# Examples\n\n```\nuse gpui::size;\nlet my_size = size(10, 20);\nassert_eq!(my_size.width, 10);\nassert_eq!(my_size.height, 20);\n```", "signature": "pub const fn size (width : T, height : T) -> Size where T : Clone + Debug + Default + PartialEq,", "cfg": [] }, { "id": "gpui::gestures::GestureKinds", "name": "GestureKinds", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "The gesture capabilities a platform can declare as natively recognized.", "documentation": "The gesture capabilities a platform can declare as natively recognized.\n\nUsed by [`PlatformGestures::native_recognizers`] to declare which gestures\nthe platform handles instead of forwarding their raw contacts to GPUI's\nportable recognizer. A backend must not send both raw contacts and native\nsemantic events for the same gesture; this declaration does not filter input.", "signature": "# [doc = \" The gesture capabilities a platform can declare as natively recognized.\"] # [doc = \"\"] # [doc = \" Used by [`PlatformGestures::native_recognizers`] to declare which gestures\"] # [doc = \" the platform handles instead of forwarding their raw contacts to GPUI's\"] # [doc = \" portable recognizer. A backend must not send both raw contacts and native\"] # [doc = \" semantic events for the same gesture; this declaration does not filter input.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct GestureKinds { # [doc = \" Tap and multi-tap. GPUI's portable path synthesizes mouse presses so\"] # [doc = \" existing click behavior remains compatible.\"] pub tap : bool, # [doc = \" Long press, surfaced as [`LongPressEvent`].\"] pub long_press : bool, # [doc = \" Pan/scroll (including fling momentum), surfaced as\"] # [doc = \" [`ScrollWheelEvent`](crate::ScrollWheelEvent)s.\"] pub pan : bool, # [doc = \" Pinch to zoom, surfaced as [`PinchEvent`](crate::PinchEvent)s.\"] pub pinch : bool, }", "cfg": [] }, { "id": "gpui::gestures::GestureTuning", "name": "GestureTuning", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "Feel constants consumed by gesture recognizers. Provided on a best-effort basis, depending on each platform's support, defaulting to GPUI's own (iOS flavored) values", "documentation": "Feel constants consumed by gesture recognizers. Provided on a best-effort\nbasis, depending on each platform's support, defaulting to GPUI's own\n(iOS flavored) values", "signature": "# [doc = \" Feel constants consumed by gesture recognizers. Provided on a best-effort\"] # [doc = \" basis, depending on each platform's support, defaulting to GPUI's own\"] # [doc = \" (iOS flavored) values\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct GestureTuning { # [doc = \" Distance a touch may travel before it stops being a potential tap and\"] # [doc = \" becomes a pan/drag.\"] pub touch_slop : Pixels, # [doc = \" Maximum interval between taps for them to accumulate a tap count.\"] pub multi_tap_interval : Duration, # [doc = \" Maximum distance between taps for them to accumulate a tap count.\"] pub multi_tap_slop : Pixels, # [doc = \" How long a touch must remain within [`Self::touch_slop`] to be\"] # [doc = \" recognized as a long press.\"] pub long_press_duration : Duration, # [doc = \" Per-millisecond decay factor applied to exponential scroll momentum.\"] # [doc = \" (`UIScrollView` uses `0.998` per millisecond for its normal\"] # [doc = \" deceleration rate.)\"] # [doc = \"\"] # [doc = \" This field is retained for source compatibility. A platform that needs\"] # [doc = \" a different model can override [`PlatformGestures::scroll_physics`].\"] pub momentum_decay_per_ms : f32, # [doc = \" Minimum release velocity, in pixels per second, required to start\"] # [doc = \" scroll momentum.\"] pub min_fling_velocity : f32, }", "cfg": [] }, { "id": "gpui::gestures::LongPressEvent", "name": "LongPressEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "A phased long-press gesture recognized from a touch.", "documentation": "A phased long-press gesture recognized from a touch.", "signature": "# [doc = \" A phased long-press gesture recognized from a touch.\"] # [derive (Clone, Debug)] pub struct LongPressEvent { # [doc = \" The phase of the long press.\"] pub phase : TouchPhase, # [doc = \" The position where the touch started.\"] pub start_position : Point, # [doc = \" The touch's current position.\"] pub position : Point, }", "cfg": [] }, { "id": "gpui::gestures::NullPlatformGestures", "name": "NullPlatformGestures", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "A no-op [`PlatformGestures`] implementation: no native recognizers and default tuning. Suitable for desktop platforms and tests.", "documentation": "A no-op [`PlatformGestures`] implementation: no native recognizers and\ndefault tuning. Suitable for desktop platforms and tests.", "signature": "# [doc = \" A no-op [`PlatformGestures`] implementation: no native recognizers and\"] # [doc = \" default tuning. Suitable for desktop platforms and tests.\"] pub struct NullPlatformGestures;", "cfg": [] }, { "id": "gpui::gestures::OngoingScroll", "name": "OngoingScroll", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "Tracks the dominant axis across the events in a scroll gesture.", "documentation": "Tracks the dominant axis across the events in a scroll gesture.", "signature": "# [doc = \" Tracks the dominant axis across the events in a scroll gesture.\"] # [derive (Clone, Copy, Debug, Default)] pub struct OngoingScroll { last_event : Option, axis : Option, }", "cfg": [] }, { "id": "gpui::gestures::OngoingScroll::filter", "name": "filter", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "Filters the given delta to the dominant axis of the current scroll gesture.", "documentation": "Filters the given delta to the dominant axis of the current scroll gesture.\n\nGestures are delimited by their touch phase when available, with a timeout\nfallback for platforms that only emit [`TouchPhase::Moved`].", "signature": "pub fn filter (& mut self, delta : & mut Point, touch_phase : TouchPhase)", "cfg": [], "target": "OngoingScroll" }, { "id": "gpui::gestures::PlatformGestures", "name": "PlatformGestures", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "Platform gesture recognition services.", "documentation": "Platform gesture recognition services.\n\nIf your mobile platform supports native gesture recognition, use this\nto share it with GPUI.", "signature": "# [doc = \" Platform gesture recognition services.\"] # [doc = \"\"] # [doc = \" If your mobile platform supports native gesture recognition, use this\"] # [doc = \" to share it with GPUI.\"] pub trait PlatformGestures { # [doc = \" Feel constants for the portable recognizers on this platform.\"] fn tuning (& self) -> GestureTuning { GestureTuning::default () } # [doc = \" The deceleration model used by portable touch-pan momentum.\"] # [doc = \"\"] # [doc = \" The default preserves the exponential model configured by\"] # [doc = \" [`GestureTuning::momentum_decay_per_ms`]. Platforms can opt into\"] # [doc = \" [`ScrollPhysics::FrictionSpline`] without changing the tuning struct.\"] fn scroll_physics (& self) -> ScrollPhysics { ScrollPhysics::Exponential { decay_per_ms : self . tuning () . momentum_decay_per_ms, } } # [doc = \" The gesture kinds this platform recognizes natively.\"] fn native_recognizers (& self) -> GestureKinds { GestureKinds::NONE } }", "cfg": [] }, { "id": "gpui::gestures::ScrollPhysics", "name": "ScrollPhysics", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "How free scrolling decelerates after a fling.", "documentation": "How free scrolling decelerates after a fling.\n\nThis models deceleration only. Boundary behavior — bouncing, edge glow,\nclamping — is the scroll container's policy: the container is the one that\nknows its extents.", "signature": "# [doc = \" How free scrolling decelerates after a fling.\"] # [doc = \"\"] # [doc = \" This models deceleration only. Boundary behavior — bouncing, edge glow,\"] # [doc = \" clamping — is the scroll container's policy: the container is the one that\"] # [doc = \" knows its extents.\"] # [derive (Clone, Copy, Debug, PartialEq)] pub enum ScrollPhysics { # [doc = \" Exponential velocity decay, the `UIScrollView` model:\"] # [doc = \" `velocity(t) = v₀ · decay_per_msᵐˢ`.\"] Exponential { # [doc = \" Per-millisecond velocity decay factor. `UIScrollView`'s normal\"] # [doc = \" deceleration rate is `0.998`.\"] decay_per_ms : f32, }, # [doc = \" The friction spline of Android's `OverScroller`: fling duration and\"] # [doc = \" distance follow a logarithmic deceleration law, and progress along\"] # [doc = \" the fling follows a cubic-Bezier ease-out curve. Transcribed from\"] # [doc = \" AOSP's `SplineOverScroller` (Apache-2.0).\"] FrictionSpline { # [doc = \" The scroll friction coefficient;\"] # [doc = \" `ViewConfiguration.getScrollFriction()` is `0.015` on Android.\"] friction : f32, # [doc = \" Pixels per physical inch of the display, in the coordinate space\"] # [doc = \" the fling runs in. Android folds display density into its\"] # [doc = \" deceleration coefficient, so the same finger speed flings\"] # [doc = \" further in pixels on a denser screen.\"] pixels_per_inch : f32, }, }", "cfg": [] }, { "id": "gpui::gestures::ScrollPhysics::android", "name": "android", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "Android scroll feel: `OverScroller` with stock friction, at Android's nominal density of 160 density-independent pixels per inch — the right pairing when fling distances are in logical pixels. Platforms that fling in physical pixels, or know the display's true density in their logical space, should construct [`ScrollPhysics::FrictionSpline`] directly.", "documentation": "Android scroll feel: `OverScroller` with stock friction, at Android's\nnominal density of 160 density-independent pixels per inch — the\nright pairing when fling distances are in logical pixels. Platforms\nthat fling in physical pixels, or know the display's true density in\ntheir logical space, should construct\n[`ScrollPhysics::FrictionSpline`] directly.", "signature": "pub fn android () -> Self", "cfg": [], "target": "ScrollPhysics" }, { "id": "gpui::gestures::ScrollPhysics::ios", "name": "ios", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "iOS scroll feel: `UIScrollView`'s normal deceleration rate.", "documentation": "iOS scroll feel: `UIScrollView`'s normal deceleration rate.", "signature": "pub fn ios () -> Self", "cfg": [], "target": "ScrollPhysics" }, { "id": "gpui::gestures::TouchDragEvent", "name": "TouchDragEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "A direct touch drag claimed by an element before touch input becomes a tap, long press, or scrolling gesture.", "documentation": "A direct touch drag claimed by an element before touch input becomes a tap,\nlong press, or scrolling gesture.\n\nA pending contact offers `Started` once at touch-down. Only a claimed offer\nreceives subsequent phases. For direction-aware acquisition after slop,\nuse the separate [`TouchPanEvent`] stream.", "signature": "# [doc = \" A direct touch drag claimed by an element before touch input becomes a tap,\"] # [doc = \" long press, or scrolling gesture.\"] # [doc = \"\"] # [doc = \" A pending contact offers `Started` once at touch-down. Only a claimed offer\"] # [doc = \" receives subsequent phases. For direction-aware acquisition after slop,\"] # [doc = \" use the separate [`TouchPanEvent`] stream.\"] # [derive (Clone, Debug)] pub struct TouchDragEvent { # [doc = \" The phase of the touch drag.\"] pub phase : TouchPhase, # [doc = \" The position where the touch started.\"] pub start_position : Point, # [doc = \" The touch's current position.\"] pub position : Point, }", "cfg": [] }, { "id": "gpui::gestures::TouchPanEvent", "name": "TouchPanEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gestures", "path": "gpui::gestures", "source": "crates/gpui/src/gestures.rs", "summary": "A direction-aware direct manipulation offered when a pending touch exceeds slop, or when live scrolling leaves an unconsumed delta at an edge. Listen during paint with [`crate::Window::on_touch_pan`]. Hit testing uses `touch_start_position`, including after a scroll handoff.", "documentation": "A direction-aware direct manipulation offered when a pending touch exceeds\nslop, or when live scrolling leaves an unconsumed delta at an edge. Listen\nduring paint with [`crate::Window::on_touch_pan`]. Hit testing uses\n`touch_start_position`, including after a scroll handoff.\n\nOn `Started`, inspect `axis` and signed `position - start_position` and\ncall [`crate::Window::prevent_default`] to acquire.\nBubble dispatch lets the innermost eligible listener acquire before its\nancestors; a pull-to-refresh owner should acquire only downward at scroll\ntop. Refusal leaves the full travel for default axis-locked scrolling.\nAt handoff the scroll has already consumed its portion; `start_position`\nis rebased so this offer contains only the residual. Acquisition cancels\nthe scroll stream, then owns the contact until its terminal phase, including\nreversals. Claimed direct manipulations never transfer to another owner.\n\nOnly acquisition produces `Moved` and exactly one `Ended` or `Cancelled`.\nCancellation must roll back, not commit. The axis is fixed at acquisition,\nbut positions remain raw and two-dimensional. There is no implicit fling.", "signature": "# [doc = \" A direction-aware direct manipulation offered when a pending touch exceeds\"] # [doc = \" slop, or when live scrolling leaves an unconsumed delta at an edge. Listen\"] # [doc = \" during paint with [`crate::Window::on_touch_pan`]. Hit testing uses\"] # [doc = \" `touch_start_position`, including after a scroll handoff.\"] # [doc = \"\"] # [doc = \" On `Started`, inspect `axis` and signed `position - start_position` and\"] # [doc = \" call [`crate::Window::prevent_default`] to acquire.\"] # [doc = \" Bubble dispatch lets the innermost eligible listener acquire before its\"] # [doc = \" ancestors; a pull-to-refresh owner should acquire only downward at scroll\"] # [doc = \" top. Refusal leaves the full travel for default axis-locked scrolling.\"] # [doc = \" At handoff the scroll has already consumed its portion; `start_position`\"] # [doc = \" is rebased so this offer contains only the residual. Acquisition cancels\"] # [doc = \" the scroll stream, then owns the contact until its terminal phase, including\"] # [doc = \" reversals. Claimed direct manipulations never transfer to another owner.\"] # [doc = \"\"] # [doc = \" Only acquisition produces `Moved` and exactly one `Ended` or `Cancelled`.\"] # [doc = \" Cancellation must roll back, not commit. The axis is fixed at acquisition,\"] # [doc = \" but positions remain raw and two-dimensional. There is no implicit fling.\"] # [derive (Clone, Debug)] pub struct TouchPanEvent { # [doc = \" Lifecycle phase; `Started` is an acquisition offer.\"] pub phase : TouchPhase, # [doc = \" Dominant axis at slop crossing; vertical wins an exact tie.\"] pub axis : Axis, # [doc = \" Original contact hit-test anchor in logical window pixels.\"] pub touch_start_position : Point, # [doc = \" Whether acquisition followed a partially or wholly unconsumed scroll.\"] pub is_scroll_handoff : bool, # [doc = \" Manipulation origin. On handoff this is current position minus residual\"] # [doc = \" scroll travel, not the original contact point.\"] pub start_position : Point, # [doc = \" Current raw position in logical window pixels.\"] pub position : Point, }", "cfg": [] }, { "id": "gpui::global::Global", "name": "Global", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "global", "path": "gpui::global", "source": "crates/gpui/src/global.rs", "summary": "A marker trait for types that can be stored in GPUI's global state.", "documentation": "A marker trait for types that can be stored in GPUI's global state.\n\nThis trait exists to provide type-safe access to globals by ensuring only\ntypes that implement [`Global`] can be used with the accessor methods. For\nexample, trying to access a global with a type that does not implement\n[`Global`] will result in a compile-time error.\n\nImplement this on types you want to store in the context as a global.\n\n## Restricting Access to Globals\n\nIn some situations you may need to store some global state, but want to\nrestrict access to reading it or writing to it.\n\nIn these cases, Rust's visibility system can be used to restrict access to\na global value. For example, you can create a private struct that implements\n[`Global`] and holds the global state. Then create a newtype struct that wraps\nthe global type and create custom accessor methods to expose the desired subset\nof operations.", "signature": "# [doc = \" A marker trait for types that can be stored in GPUI's global state.\"] # [doc = \"\"] # [doc = \" This trait exists to provide type-safe access to globals by ensuring only\"] # [doc = \" types that implement [`Global`] can be used with the accessor methods. For\"] # [doc = \" example, trying to access a global with a type that does not implement\"] # [doc = \" [`Global`] will result in a compile-time error.\"] # [doc = \"\"] # [doc = \" Implement this on types you want to store in the context as a global.\"] # [doc = \"\"] # [doc = \" ## Restricting Access to Globals\"] # [doc = \"\"] # [doc = \" In some situations you may need to store some global state, but want to\"] # [doc = \" restrict access to reading it or writing to it.\"] # [doc = \"\"] # [doc = \" In these cases, Rust's visibility system can be used to restrict access to\"] # [doc = \" a global value. For example, you can create a private struct that implements\"] # [doc = \" [`Global`] and holds the global state. Then create a newtype struct that wraps\"] # [doc = \" the global type and create custom accessor methods to expose the desired subset\"] # [doc = \" of operations.\"] pub trait Global : 'static { }", "cfg": [] }, { "id": "gpui::global::ReadGlobal", "name": "ReadGlobal", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "global", "path": "gpui::global", "source": "crates/gpui/src/global.rs", "summary": "A trait for reading a global value from the context.", "documentation": "A trait for reading a global value from the context.", "signature": "# [doc = \" A trait for reading a global value from the context.\"] pub trait ReadGlobal { # [doc = \" Returns the global instance of the implementing type.\"] # [doc = \"\"] # [doc = \" Panics if a global for that type has not been assigned.\"] fn global (cx : & App) -> & Self; }", "cfg": [] }, { "id": "gpui::global::UpdateGlobal", "name": "UpdateGlobal", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "global", "path": "gpui::global", "source": "crates/gpui/src/global.rs", "summary": "A trait for updating a global value in the context.", "documentation": "A trait for updating a global value in the context.", "signature": "# [doc = \" A trait for updating a global value in the context.\"] pub trait UpdateGlobal { # [doc = \" Updates the global instance of the implementing type using the provided closure.\"] # [doc = \"\"] # [doc = \" This method provides the closure with mutable access to the context and the global simultaneously.\"] fn update_global (cx : & mut C, update : F) -> R where C : BorrowAppContext, F : FnOnce (& mut Self, & mut C) -> R; # [doc = \" Set the global instance of the implementing type.\"] fn set_global (cx : & mut C, global : Self) where C : BorrowAppContext; }", "cfg": [] }, { "id": "gpui::gpui::AppContext", "name": "AppContext", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "The context trait, allows the different contexts in GPUI to be used interchangeably for certain operations.", "documentation": "The context trait, allows the different contexts in GPUI to be used\ninterchangeably for certain operations.", "signature": "# [doc = \" The context trait, allows the different contexts in GPUI to be used\"] # [doc = \" interchangeably for certain operations.\"] pub trait AppContext { # [doc = \" Create a new entity in the app context.\"] # [expect (clippy::wrong_self_convention, reason = \"`App::new` is an ubiquitous function for creating entities\")] # [allow (clippy::new_ret_no_self)] fn new (& mut self, build_entity : impl FnOnce (& mut Context) -> T) -> Entity; # [doc = \" Reserve a slot for a entity to be inserted later.\"] # [doc = \" The returned [Reservation] allows you to obtain the [EntityId] for the future entity.\"] fn reserve_entity (& mut self) -> Reservation; # [doc = \" Insert a new entity in the app context based on a [Reservation] previously obtained from [`reserve_entity`].\"] # [doc = \"\"] # [doc = \" [`reserve_entity`]: Self::reserve_entity\"] fn insert_entity (& mut self, reservation : Reservation, build_entity : impl FnOnce (& mut Context) -> T,) -> Entity; # [doc = \" Update a entity in the app context.\"] fn update_entity (& mut self, handle : & Entity, update : impl FnOnce (& mut T, & mut Context) -> R,) -> R where T : 'static; # [doc = \" Update a entity in the app context.\"] fn as_mut<'a, T> (& 'a mut self, handle : & Entity) -> GpuiBorrow<'a, T> where T : 'static; # [doc = \" Read a entity from the app context.\"] fn read_entity (& self, handle : & Entity, read : impl FnOnce (& T, & App) -> R) -> R where T : 'static; # [doc = \" Update a window for the given handle.\"] fn update_window (& mut self, window : AnyWindowHandle, f : F) -> Result where F : FnOnce (AnyView, & mut Window, & mut App) -> T; # [doc = \" Run `f` against the entity's *current* window — the most recently\"] # [doc = \" rendered window that referenced the entity. Returns `None` if the\"] # [doc = \" entity has no current window or that window is unavailable. See\"] # [doc = \" [`App::with_window`] for the underlying lookup.\"] fn with_window (& mut self, entity_id : EntityId, f : impl FnOnce (& mut Window, & mut App) -> R,) -> Option; # [doc = \" Read a window off of the application context.\"] fn read_window (& self, window : & WindowHandle, read : impl FnOnce (Entity, & App) -> R,) -> Result where T : 'static; # [doc = \" Spawn a future on a background thread\"] fn background_spawn (& self, future : impl Future + Send + 'static) -> Task where R : Send + 'static; # [doc = \" Read a global from this app context\"] fn read_global (& self, callback : impl FnOnce (& G, & App) -> R) -> R where G : Global; }", "cfg": [] }, { "id": "gpui::gpui::BorrowAppContext", "name": "BorrowAppContext", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "A helper trait for auto-implementing certain methods on contexts that can be used interchangeably.", "documentation": "A helper trait for auto-implementing certain methods on contexts that\ncan be used interchangeably.", "signature": "# [doc = \" A helper trait for auto-implementing certain methods on contexts that\"] # [doc = \" can be used interchangeably.\"] pub trait BorrowAppContext { # [doc = \" Set a global value on the context.\"] fn set_global (& mut self, global : T); # [doc = \" Updates the global state of the given type.\"] fn update_global (& mut self, f : impl FnOnce (& mut G, & mut Self) -> R) -> R where G : Global; # [doc = \" Updates the global state of the given type, creating a default if it didn't exist before.\"] fn update_default_global (& mut self, f : impl FnOnce (& mut G, & mut Self) -> R) -> R where G : Global + Default; }", "cfg": [] }, { "id": "gpui::gpui::EventEmitter", "name": "EventEmitter", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "A trait for tying together the types of a GPUI entity and the events it can emit.", "documentation": "A trait for tying together the types of a GPUI entity and the events it can\nemit.", "signature": "# [doc = \" A trait for tying together the types of a GPUI entity and the events it can\"] # [doc = \" emit.\"] pub trait EventEmitter : 'static { }", "cfg": [] }, { "id": "gpui::gpui::GPUI_MANIFEST_DIR", "name": "GPUI_MANIFEST_DIR", "kind": "static", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub static GPUI_MANIFEST_DIR: & str", "cfg": [] }, { "id": "gpui::gpui::GpuSpecs", "name": "GpuSpecs", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "Information about the GPU GPUI is running on.", "documentation": "Information about the GPU GPUI is running on.", "signature": "# [doc = \" Information about the GPU GPUI is running on.\"] # [derive (Default, Debug, serde::Serialize, serde::Deserialize, Clone)] pub struct GpuSpecs { # [doc = \" Whether the GPU is really a fake (like `llvmpipe`) running on the CPU.\"] pub is_software_emulated : bool, # [doc = \" The name of the device, as reported by Vulkan.\"] pub device_name : String, # [doc = \" The name of the driver, as reported by Vulkan.\"] pub driver_name : String, # [doc = \" Further information about the driver, as reported by Vulkan.\"] pub driver_info : String, }", "cfg": [] }, { "id": "gpui::gpui::Reservation", "name": "Reservation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "Returned by [Context::reserve_entity] to later be passed to [Context::insert_entity]. Allows you to obtain the [EntityId] for a entity before it is created.", "documentation": "Returned by [Context::reserve_entity] to later be passed to [Context::insert_entity].\nAllows you to obtain the [EntityId] for a entity before it is created.", "signature": "# [doc = \" Returned by [Context::reserve_entity] to later be passed to [Context::insert_entity].\"] # [doc = \" Allows you to obtain the [EntityId] for a entity before it is created.\"] pub struct Reservation (pub (crate) Slot);", "cfg": [] }, { "id": "gpui::gpui::Reservation::entity_id", "name": "entity_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "Returns the [EntityId] that will be associated with the entity once it is inserted.", "documentation": "Returns the [EntityId] that will be associated with the entity once it is inserted.", "signature": "pub fn entity_id (& self) -> EntityId", "cfg": [], "target": "Reservation" }, { "id": "gpui::gpui::VisualContext", "name": "VisualContext", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "This trait is used for the different visual contexts in GPUI that require a window to be present.", "documentation": "This trait is used for the different visual contexts in GPUI that\nrequire a window to be present.", "signature": "# [doc = \" This trait is used for the different visual contexts in GPUI that\"] # [doc = \" require a window to be present.\"] pub trait VisualContext : AppContext { # [doc = \" The result type for window operations.\"] type Result; # [doc = \" Returns the handle of the window associated with this context.\"] fn window_handle (& self) -> AnyWindowHandle; # [doc = \" Update a view with the given callback\"] fn update_window_entity (& mut self, entity : & Entity, update : impl FnOnce (& mut T, & mut Window, & mut Context) -> R,) -> Self::Result; # [doc = \" Create a new entity, with access to `Window`.\"] fn new_window_entity (& mut self, build_entity : impl FnOnce (& mut Window, & mut Context) -> T,) -> Self::Result>; # [doc = \" Replace the root view of a window with a new view.\"] fn replace_root_view (& mut self, build_view : impl FnOnce (& mut Window, & mut Context) -> V,) -> Self::Result> where V : 'static + Render; # [doc = \" Focus a entity in the window, if it implements the [`Focusable`] trait.\"] fn focus (& mut self, entity : & Entity) -> Self::Result<()> where V : Focusable; }", "cfg": [] }, { "id": "gpui::gpui::bench_group", "name": "bench_group", "kind": "macro", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "Defines a Criterion benchmark group for benchmarks annotated with [`gpui::bench`].", "documentation": "Defines a Criterion benchmark group for benchmarks annotated with [`gpui::bench`].\n\nThis mirrors `criterion::criterion_group!` so GPUI benchmark files can keep the\nsame shape as ordinary Criterion benchmarks.\n\n[`gpui::bench`]: crate::bench", "signature": "macro_rules! bench_group", "cfg": [] }, { "id": "gpui::gpui::bench_main", "name": "bench_main", "kind": "macro", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "Defines the entry point for GPUI Criterion benchmark groups.", "documentation": "Defines the entry point for GPUI Criterion benchmark groups.\n\nThis mirrors `criterion::criterion_main!` so GPUI benchmark files can keep the\nsame shape as ordinary Criterion benchmarks.", "signature": "macro_rules! bench_main", "cfg": [] }, { "id": "gpui::gpui::reexport-1", "name": "proptest", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use proptest;", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::gpui::reexport-10", "name": "color :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use color::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-11", "name": "ctor :: ctor", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use ctor::ctor;", "cfg": [] }, { "id": "gpui::gpui::reexport-12", "name": "editable_text :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use editable_text::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-13", "name": "effect_owner :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use effect_owner::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-14", "name": "element :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use element::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-15", "name": "elements :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use elements::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-16", "name": "executor :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use executor::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-17", "name": "geometry :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use geometry::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-18", "name": "gestures :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use gestures::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-19", "name": "global :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use global::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-2", "name": "accesskit", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use accesskit;", "cfg": [] }, { "id": "gpui::gpui::reexport-20", "name": "gpui_macros :: { AppContext , IntoElement , Render , VisualContext , bench , property_test , register_action , test , }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use gpui_macros::{ AppContext, IntoElement, Render, VisualContext, bench, property_test, register_action, test, };", "cfg": [] }, { "id": "gpui::gpui::reexport-21", "name": "atlas_lease :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use atlas_lease::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-22", "name": "gpui_shared_string :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use gpui_shared_string::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-23", "name": "gpui_util :: arc_cow :: ArcCow", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use gpui_util::arc_cow::ArcCow;", "cfg": [] }, { "id": "gpui::gpui::reexport-24", "name": "http_client", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use http_client;", "cfg": [] }, { "id": "gpui::gpui::reexport-25", "name": "input :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use input::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-26", "name": "inspector :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use inspector::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-27", "name": "interactive :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use interactive::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-28", "name": "keymap :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use keymap::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-29", "name": "luminance :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use luminance::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-3", "name": "accesskit :: Action as AccessibleAction", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use accesskit::Action as AccessibleAction;", "cfg": [] }, { "id": "gpui::gpui::reexport-30", "name": "paint_recording :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use paint_recording::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-31", "name": "particles :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use particles::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-32", "name": "path_builder :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use path_builder::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-33", "name": "platform :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use platform::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-34", "name": "profiler :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use profiler::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-35", "name": "queue :: { PriorityQueueReceiver , PriorityQueueSender }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use queue::{ PriorityQueueReceiver, PriorityQueueSender };", "cfg": [] }, { "id": "gpui::gpui::reexport-36", "name": "refineable :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use refineable::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-37", "name": "renderer_timing :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use renderer_timing::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-38", "name": "scene :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use scene::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-39", "name": "shared_uri :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use shared_uri::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-4", "name": "accesskit :: { Orientation , Role , Toggled }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use accesskit::{ Orientation, Role, Toggled };", "cfg": [] }, { "id": "gpui::gpui::reexport-40", "name": "spring :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use spring::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-41", "name": "style :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use style::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-42", "name": "styled :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use styled::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-43", "name": "subscription :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use subscription::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-44", "name": "subtree_clip :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use subtree_clip::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-45", "name": "svg_renderer :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use svg_renderer::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-46", "name": "taffy :: { AvailableSpace , LayoutId }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use taffy::{ AvailableSpace, LayoutId };", "cfg": [] }, { "id": "gpui::gpui::reexport-47", "name": "test :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use test::*;", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::gpui::reexport-48", "name": "text_system :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use text_system::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-49", "name": "util :: { FutureExt , Timeout }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use util::{ FutureExt, Timeout };", "cfg": [] }, { "id": "gpui::gpui::reexport-5", "name": "action :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use action::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-50", "name": "view :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use view::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-51", "name": "visual_transform :: VisualTransform", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use visual_transform::VisualTransform;", "cfg": [] }, { "id": "gpui::gpui::reexport-52", "name": "window :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use window::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-53", "name": "pollster :: block_on", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use pollster::block_on;", "cfg": [] }, { "id": "gpui::gpui::reexport-6", "name": "anyhow :: Result", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use anyhow::Result;", "cfg": [] }, { "id": "gpui::gpui::reexport-7", "name": "app :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use app::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-8", "name": "asset_cache :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use asset_cache::*;", "cfg": [] }, { "id": "gpui::gpui::reexport-9", "name": "assets :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "gpui", "path": "gpui::gpui", "source": "crates/gpui/src/gpui.rs", "summary": "", "documentation": "", "signature": "pub use assets::*;", "cfg": [] }, { "id": "gpui::input::ElementInputHandler", "name": "ElementInputHandler", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "input", "path": "gpui::input", "source": "crates/gpui/src/input.rs", "summary": "The canonical implementation of [`crate::PlatformInputHandler`]. Call [`Window::handle_input`] with an instance during your element's paint.", "documentation": "The canonical implementation of [`crate::PlatformInputHandler`]. Call [`Window::handle_input`]\nwith an instance during your element's paint.", "signature": "# [doc = \" The canonical implementation of [`crate::PlatformInputHandler`]. Call [`Window::handle_input`]\"] # [doc = \" with an instance during your element's paint.\"] pub struct ElementInputHandler { view : Entity, element_bounds : Bounds, visual_transform : crate::VisualTransform, }", "cfg": [] }, { "id": "gpui::input::ElementInputHandler::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "input", "path": "gpui::input", "source": "crates/gpui/src/input.rs", "summary": "Used in [`Element::paint`][element_paint] with the element's bounds, a `Window`, and a `App` context.", "documentation": "Used in [`Element::paint`][element_paint] with the element's bounds, a `Window`, and a `App` context.\n\n[element_paint]: crate::Element::paint", "signature": "pub fn new (element_bounds : Bounds, view : Entity) -> Self", "cfg": [], "target": "ElementInputHandler" }, { "id": "gpui::input::ElementInputHandler::with_visual_transform", "name": "with_visual_transform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "input", "path": "gpui::input", "source": "crates/gpui/src/input.rs", "summary": "Captures the mapping used by this frame's logical `element_bounds`. Only the handler's element-bounds metadata is mapped here. Entity callback points remain window-global, returned caret/range rectangles must already be displayed window coordinates, and `bounds_for_range` still receives logical element bounds. The entity must store the same prepaint mapping with its layout snapshot and inverse-map incoming points exactly once.", "documentation": "Captures the mapping used by this frame's logical `element_bounds`.\nOnly the handler's element-bounds metadata is mapped here. Entity callback\npoints remain window-global, returned caret/range rectangles must already\nbe displayed window coordinates, and `bounds_for_range` still receives\nlogical element bounds. The entity must store the same prepaint mapping\nwith its layout snapshot and inverse-map incoming points exactly once.", "signature": "pub fn with_visual_transform (mut self, transform : crate::VisualTransform) -> Self", "cfg": [], "target": "ElementInputHandler" }, { "id": "gpui::input::EntityInputHandler", "name": "EntityInputHandler", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "input", "path": "gpui::input", "source": "crates/gpui/src/input.rs", "summary": "Implement this trait to allow views to handle textual input when implementing an editor, field, etc.", "documentation": "Implement this trait to allow views to handle textual input when implementing an editor, field, etc.\n\nOnce your view implements this trait, you can use it to construct an [`ElementInputHandler`].\nThis input handler can then be assigned during paint by calling [`Window::handle_input`].\n\nSee [`InputHandler`] for details on how to implement each method.", "signature": "# [doc = \" Implement this trait to allow views to handle textual input when implementing an editor, field, etc.\"] # [doc = \"\"] # [doc = \" Once your view implements this trait, you can use it to construct an [`ElementInputHandler`].\"] # [doc = \" This input handler can then be assigned during paint by calling [`Window::handle_input`].\"] # [doc = \"\"] # [doc = \" See [`InputHandler`] for details on how to implement each method.\"] pub trait EntityInputHandler : 'static + Sized { # [doc = \" See [`InputHandler::native_selection`].\"] fn native_selection (& mut self, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::set_native_selection`].\"] fn set_native_selection (& mut self, _selection : crate::NativeTextSelection, _window : & mut Window, _cx : & mut Context,) -> bool { false } # [doc = \" See [`InputHandler::native_position_in_direction`].\"] fn native_position_in_direction (& mut self, _position : crate::NativeTextPosition, _direction : crate::TextNavigationDirection, _offset : usize, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::native_position_bounds`].\"] fn native_position_bounds (& mut self, _position : crate::NativeTextPosition, _window : & mut Window, _cx : & mut Context,) -> Option> { None } # [doc = \" See [`InputHandler::native_position_for_point`].\"] fn native_position_for_point (& mut self, _point : crate::Point, _within_range : Option>, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::farthest_native_position`].\"] fn farthest_native_position (& mut self, _range : Range, _direction : crate::TextNavigationDirection, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::selection_rects_for_range`].\"] fn selection_rects_for_range (& mut self, _range : Range, _window : & mut Window, _cx : & mut Context,) -> Vec { Vec::new () } # [doc = \" See [`InputHandler::text_position_in_direction`].\"] fn text_position_in_direction (& mut self, _position : usize, _direction : crate::TextNavigationDirection, _offset : usize, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::farthest_text_position`].\"] fn farthest_text_position (& mut self, _range : Range, _direction : crate::TextNavigationDirection, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::base_writing_direction`].\"] fn base_writing_direction (& mut self, _position : usize, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::set_base_writing_direction`].\"] fn set_base_writing_direction (& mut self, _direction : crate::TextWritingDirection, _range : Range, _window : & mut Window, _cx : & mut Context,) -> bool { false } # [doc = \" See [`InputHandler::grapheme_range_at`].\"] fn grapheme_range_at (& mut self, _position : usize, _window : & mut Window, _cx : & mut Context,) -> Option> { None } # [doc = \" See [`InputHandler::native_caret_bounds`].\"] fn native_caret_bounds (& mut self, _position : usize, _window : & mut Window, _cx : & mut Context,) -> Option> { None } # [doc = \" See [`InputHandler::text_input_options`].\"] fn text_input_options (& mut self, _window : & mut Window, _cx : & mut Context,) -> crate::TextInputOptions { crate::TextInputOptions::default () } # [doc = \" See [`InputHandler::perform_text_input_action`].\"] fn perform_text_input_action (& mut self, _action : crate::TextInputAction, _window : & mut Window, _cx : & mut Context,) -> bool { false } # [doc = \" See [`InputHandler::text_for_range`] for details\"] fn text_for_range (& mut self, range : Range, adjusted_range : & mut Option>, window : & mut Window, cx : & mut Context,) -> Option; # [doc = \" See [`InputHandler::selected_text_range`] for details\"] fn selected_text_range (& mut self, ignore_disabled_input : bool, window : & mut Window, cx : & mut Context,) -> Option; # [doc = \" See [`InputHandler::marked_text_range`] for details\"] fn marked_text_range (& self, window : & mut Window, cx : & mut Context,) -> Option>; # [doc = \" See [`InputHandler::unmark_text`] for details\"] fn unmark_text (& mut self, window : & mut Window, cx : & mut Context); # [doc = \" See [`InputHandler::replace_text_in_range`] for details\"] fn replace_text_in_range (& mut self, range : Option>, text : & str, window : & mut Window, cx : & mut Context,); # [doc = \" See [`InputHandler::replace_and_mark_text_in_range`] for details\"] fn replace_and_mark_text_in_range (& mut self, range : Option>, new_text : & str, new_selected_range : Option>, window : & mut Window, cx : & mut Context,); # [doc = \" See [`InputHandler::bounds_for_range`] for details\"] fn bounds_for_range (& mut self, range_utf16 : Range, element_bounds : Bounds, window : & mut Window, cx : & mut Context,) -> Option>; # [doc = \" See [`InputHandler::character_index_for_point`] for details\"] fn character_index_for_point (& mut self, point : crate::Point, window : & mut Window, cx : & mut Context,) -> Option; # [doc = \" See [`InputHandler::set_selected_text_range`] for details\"] fn set_selected_text_range (& mut self, _range_utf16 : Range, _window : & mut Window, _cx : & mut Context,) { } # [doc = \" See [`InputHandler::text_length_utf16`] for details\"] fn text_length_utf16 (& mut self, _window : & mut Window, _cx : & mut Context,) -> Option { None } # [doc = \" See [`InputHandler::accepts_text_input`] for details\"] fn accepts_text_input (& self, _window : & mut Window, _cx : & mut Context) -> bool { true } }", "cfg": [] }, { "id": "gpui::inspector::InspectorElementId", "name": "InspectorElementId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "inspector", "path": "gpui::inspector", "source": "crates/gpui/src/inspector.rs", "summary": "A unique identifier for an element that can be inspected.", "documentation": "A unique identifier for an element that can be inspected.", "signature": "# [doc = \" A unique identifier for an element that can be inspected.\"] # [derive (Debug, Eq, PartialEq, Hash, Clone)] pub struct InspectorElementId { # [doc = \" Stable part of the ID.\"] # [cfg (any (feature = \"inspector\", debug_assertions))] pub path : std::rc::Rc, # [doc = \" Disambiguates elements that have the same path.\"] # [cfg (any (feature = \"inspector\", debug_assertions))] pub instance_id : usize, }", "cfg": [] }, { "id": "gpui::inspector::reexport-1", "name": "conditional :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "inspector", "path": "gpui::inspector", "source": "crates/gpui/src/inspector.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (feature = \"inspector\", debug_assertions))] pub use conditional::*;", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ] }, { "id": "gpui::interactive::ClickEvent", "name": "ClickEvent", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A click event, generated when a mouse button or keyboard button is pressed and released, or when a tap gesture is recognized on a touch screen.", "documentation": "A click event, generated when a mouse button or keyboard button is pressed and released,\nor when a tap gesture is recognized on a touch screen.", "signature": "# [doc = \" A click event, generated when a mouse button or keyboard button is pressed and released,\"] # [doc = \" or when a tap gesture is recognized on a touch screen.\"] # [derive (Clone, Debug)] pub enum ClickEvent { # [doc = \" A click event trigger by a mouse button being pressed and released.\"] Mouse (MouseClickEvent), # [doc = \" A click event trigger by a keyboard button being pressed and released.\"] Keyboard (KeyboardClickEvent), # [doc = \" A click event triggered by a recognized tap gesture on a touch screen.\"] Touch (TouchClickEvent), }", "cfg": [] }, { "id": "gpui::interactive::ClickEvent::click_count", "name": "click_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the click count of the click event", "documentation": "Returns the click count of the click event\n\n`Keyboard`: Always 1\n`Mouse`: Count of clicks from MouseUpEvent\n`Touch`: Count of consecutive taps", "signature": "pub fn click_count (& self) -> usize", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::first_focus", "name": "first_focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns whether the click focused the element", "documentation": "Returns whether the click focused the element\n\n`Keyboard`: false, keyboard clicks only work if an element is already focused\n`Mouse`: Whether this was the first focusing click\n`Touch`: false, mobile windows are already active when tappable", "signature": "pub fn first_focus (& self) -> bool", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::is_keyboard", "name": "is_keyboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns whether the click event is generated by a keyboard event", "documentation": "Returns whether the click event is generated by a keyboard event", "signature": "pub fn is_keyboard (& self) -> bool", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::is_middle_click", "name": "is_middle_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns if this was a middle click", "documentation": "Returns if this was a middle click\n\n`Keyboard`: false\n`Mouse`: Whether the middle button was pressed and released", "signature": "pub fn is_middle_click (& self) -> bool", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::is_right_click", "name": "is_right_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns if this was a right click", "documentation": "Returns if this was a right click\n\n`Keyboard`: false\n`Mouse`: Whether the right button was pressed and released", "signature": "pub fn is_right_click (& self) -> bool", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::is_secondary", "name": "is_secondary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns whether the click is a secondary activation, i.e. a context menu trigger: a right click from a mouse (macOS ctrl-clicks arrive already converted to right clicks by the platform layer), or a long press on a touch screen.", "documentation": "Returns whether the click is a secondary activation, i.e. a context\nmenu trigger: a right click from a mouse (macOS ctrl-clicks arrive\nalready converted to right clicks by the platform layer), or a long\npress on a touch screen.", "signature": "pub fn is_secondary (& self) -> bool", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::modifiers", "name": "modifiers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the modifiers that were held during the click event", "documentation": "Returns the modifiers that were held during the click event\n\n`Keyboard`: The keyboard click events never have modifiers.\n`Mouse`: Modifiers that were held during the mouse key up event.", "signature": "pub fn modifiers (& self) -> Modifiers", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::mouse_position", "name": "mouse_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the mouse position of the click event", "documentation": "Returns the mouse position of the click event\n\n`Keyboard`: None\n`Mouse`: The position of the mouse when the button was released.\n`Touch`: None, touches are not mouse input and there is no cursor.", "signature": "pub fn mouse_position (& self) -> Option>", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::position", "name": "position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the position of the click event", "documentation": "Returns the position of the click event\n\n`Keyboard`: The bottom left corner of the clicked hitbox\n`Mouse`: The position of the mouse when the button was released.\n`Touch`: The position of the tap.", "signature": "pub fn position (& self) -> Point", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ClickEvent::standard_click", "name": "standard_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns whether the click was a standard click", "documentation": "Returns whether the click was a standard click\n\n`Keyboard`: Always true\n`Mouse`: Left button pressed and released\n`Touch`: A tap, but not a long press", "signature": "pub fn standard_click (& self) -> bool", "cfg": [], "target": "ClickEvent" }, { "id": "gpui::interactive::ExternalDragPayload", "name": "ExternalDragPayload", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Data offered to the platform when an internal drag leaves the window and is promoted to a native drag session.", "documentation": "Data offered to the platform when an internal drag leaves the window and is\npromoted to a native drag session.", "signature": "# [doc = \" Data offered to the platform when an internal drag leaves the window and is\"] # [doc = \" promoted to a native drag session.\"] # [derive (Debug, Clone, Eq, PartialEq)] pub enum ExternalDragPayload { # [doc = \" Real on-disk paths, handed to the platform as an outbound file drag.\"] Files (FileDragPaths), }", "cfg": [] }, { "id": "gpui::interactive::ExternalDrop", "name": "ExternalDrop", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Non-path data offered by a native drag source.", "documentation": "Non-path data offered by a native drag source.\n\nReal filesystem paths continue to use [`ExternalPaths`] so existing drop targets remain\nsource-compatible. When a source offers both paths and encoded representations, platforms\nprefer the paths and do not publish a duplicate `ExternalDrop` session.", "signature": "# [doc = \" Non-path data offered by a native drag source.\"] # [doc = \"\"] # [doc = \" Real filesystem paths continue to use [`ExternalPaths`] so existing drop targets remain\"] # [doc = \" source-compatible. When a source offers both paths and encoded representations, platforms\"] # [doc = \" prefer the paths and do not publish a duplicate `ExternalDrop` session.\"] # [derive (Clone, Debug, Default)] pub struct ExternalDrop (pub SmallVec<[ExternalDropItem; 2]>);", "cfg": [] }, { "id": "gpui::interactive::ExternalDrop::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns whether no supported items were offered.", "documentation": "Returns whether no supported items were offered.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "ExternalDrop" }, { "id": "gpui::interactive::ExternalDrop::items", "name": "items", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the offered items without reading their content.", "documentation": "Returns the offered items without reading their content.", "signature": "pub fn items (& self) -> & [ExternalDropItem]", "cfg": [], "target": "ExternalDrop" }, { "id": "gpui::interactive::ExternalDrop::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Creates a non-path external drop from its offered items.", "documentation": "Creates a non-path external drop from its offered items.", "signature": "pub fn new (items : impl IntoIterator) -> Self", "cfg": [], "target": "ExternalDrop" }, { "id": "gpui::interactive::ExternalDropData", "name": "ExternalDropData", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A bounded, asynchronously readable native drag payload.", "documentation": "A bounded, asynchronously readable native drag payload.\n\nPlatforms publish the available kind and metadata while the pointer is hovering, but defer\nreading the bytes until a drop target explicitly calls [`Self::read`]. This keeps images and\nvirtual files out of the window event path and lets the receiver apply its own byte limit.", "signature": "# [doc = \" A bounded, asynchronously readable native drag payload.\"] # [doc = \"\"] # [doc = \" Platforms publish the available kind and metadata while the pointer is hovering, but defer\"] # [doc = \" reading the bytes until a drop target explicitly calls [`Self::read`]. This keeps images and\"] # [doc = \" virtual files out of the window event path and lets the receiver apply its own byte limit.\"] # [derive (Clone)] pub struct ExternalDropData { len : Option, read : Arc LocalBoxFuture<'static, Result>>>, }", "cfg": [] }, { "id": "gpui::interactive::ExternalDropData::from_bytes", "name": "from_bytes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Creates a payload whose bytes are already in memory, primarily for application-created drags and tests.", "documentation": "Creates a payload whose bytes are already in memory, primarily for application-created\ndrags and tests.", "signature": "pub fn from_bytes (bytes : impl Into>) -> Self", "cfg": [], "target": "ExternalDropData" }, { "id": "gpui::interactive::ExternalDropData::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns whether the source declared this item empty.", "documentation": "Returns whether the source declared this item empty.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "ExternalDropData" }, { "id": "gpui::interactive::ExternalDropData::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the source's declared size, if it supplied one without reading the content.", "documentation": "Returns the source's declared size, if it supplied one without reading the content.", "signature": "pub fn len (& self) -> Option", "cfg": [], "target": "ExternalDropData" }, { "id": "gpui::interactive::ExternalDropData::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Creates a deferred payload. `len` is the source's declared size when available.", "documentation": "Creates a deferred payload. `len` is the source's declared size when available.", "signature": "pub fn new (len : Option, read : impl Fn (u64) -> LocalBoxFuture<'static, Result>> + 'static,) -> Self", "cfg": [], "target": "ExternalDropData" }, { "id": "gpui::interactive::ExternalDropData::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Reads at most `limit` bytes.", "documentation": "Reads at most `limit` bytes.\n\nA source that declares or returns more data than the limit is refused. Receivers should\nstill apply an aggregate limit when reading more than one item.", "signature": "pub fn read (& self, limit : u64) -> LocalBoxFuture<'static, Result>>", "cfg": [], "target": "ExternalDropData" }, { "id": "gpui::interactive::ExternalDropEvent", "name": "ExternalDropEvent", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A native drag event for encoded images, text, URLs, and virtual files.", "documentation": "A native drag event for encoded images, text, URLs, and virtual files.", "signature": "# [doc = \" A native drag event for encoded images, text, URLs, and virtual files.\"] # [derive (Debug, Clone)] pub enum ExternalDropEvent { # [doc = \" Supported kinds and metadata have entered the window. Item bytes remain deferred.\"] Entered { # [doc = \" The pointer position relative to the window.\"] position : Point, # [doc = \" The offered non-path items.\"] drop : ExternalDrop, }, # [doc = \" The drag is moving over the window.\"] Pending { # [doc = \" The pointer position relative to the window.\"] position : Point, }, # [doc = \" The user dropped the offered items.\"] Submit { # [doc = \" The pointer position relative to the window.\"] position : Point, }, # [doc = \" The drag left the window without a drop.\"] Exited, }", "cfg": [] }, { "id": "gpui::interactive::ExternalDropItem", "name": "ExternalDropItem", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "One item offered by a native drag source that has no real filesystem path.", "documentation": "One item offered by a native drag source that has no real filesystem path.", "signature": "# [doc = \" One item offered by a native drag source that has no real filesystem path.\"] # [derive (Clone, Debug)] pub enum ExternalDropItem { # [doc = \" An encoded image.\"] Image (ExternalImage), # [doc = \" Plain or rich text represented as bytes plus a MIME type.\"] Text (ExternalText), # [doc = \" A URL, delivered without downloading it.\"] Url (ExternalUrl), # [doc = \" A promised or virtual file.\"] File (ExternalFile), }", "cfg": [] }, { "id": "gpui::interactive::ExternalFile", "name": "ExternalFile", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A file whose content is supplied by the drag source instead of an on-disk path.", "documentation": "A file whose content is supplied by the drag source instead of an on-disk path.", "signature": "# [doc = \" A file whose content is supplied by the drag source instead of an on-disk path.\"] # [derive (Clone, Debug)] pub struct ExternalFile { name : SharedString, # [doc = \" The MIME type reported by the source, if any.\"] pub mime_type : Option, # [doc = \" The deferred file content.\"] pub data : ExternalDropData, }", "cfg": [] }, { "id": "gpui::interactive::ExternalFile::name", "name": "name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the sanitized display and destination file name.", "documentation": "Returns the sanitized display and destination file name.", "signature": "pub fn name (& self) -> & str", "cfg": [], "target": "ExternalFile" }, { "id": "gpui::interactive::ExternalFile::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Creates a virtual file after validating that `name` is one portable path component.", "documentation": "Creates a virtual file after validating that `name` is one portable path component.", "signature": "pub fn new (name : impl Into, mime_type : Option, data : ExternalDropData,) -> Result", "cfg": [], "target": "ExternalFile" }, { "id": "gpui::interactive::ExternalImage", "name": "ExternalImage", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "An encoded image offered by a native drag source.", "documentation": "An encoded image offered by a native drag source.", "signature": "# [doc = \" An encoded image offered by a native drag source.\"] # [derive (Clone, Debug)] pub struct ExternalImage { # [doc = \" The encoded image format.\"] pub format : ImageFormat, # [doc = \" The deferred encoded bytes.\"] pub data : ExternalDropData, }", "cfg": [] }, { "id": "gpui::interactive::ExternalPaths", "name": "ExternalPaths", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A collection of paths from the platform, such as from a file drop.", "documentation": "A collection of paths from the platform, such as from a file drop.", "signature": "# [doc = \" A collection of paths from the platform, such as from a file drop.\"] # [derive (Debug, Clone, Default, Eq, PartialEq)] pub struct ExternalPaths (pub SmallVec<[PathBuf; 2]>);", "cfg": [] }, { "id": "gpui::interactive::ExternalPaths::paths", "name": "paths", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Convert this collection of paths into a slice.", "documentation": "Convert this collection of paths into a slice.", "signature": "pub fn paths (& self) -> & [PathBuf]", "cfg": [], "target": "ExternalPaths" }, { "id": "gpui::interactive::ExternalText", "name": "ExternalText", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Text offered by a native drag source.", "documentation": "Text offered by a native drag source.", "signature": "# [doc = \" Text offered by a native drag source.\"] # [derive (Clone, Debug)] pub struct ExternalText { # [doc = \" The MIME type reported by the platform.\"] pub mime_type : SharedString, # [doc = \" The deferred UTF-8 bytes.\"] pub data : ExternalDropData, }", "cfg": [] }, { "id": "gpui::interactive::ExternalUrl", "name": "ExternalUrl", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A URL offered by a native drag source.", "documentation": "A URL offered by a native drag source.", "signature": "# [doc = \" A URL offered by a native drag source.\"] # [derive (Clone, Debug)] pub struct ExternalUrl { # [doc = \" The deferred UTF-8 URL bytes. GPUI never downloads the URL.\"] pub data : ExternalDropData, }", "cfg": [] }, { "id": "gpui::interactive::FileDragPaths", "name": "FileDragPaths", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Paths handed to the platform for a native file drag. Directory metadata is provided by the caller to avoid querying it when the platform drag starts.", "documentation": "Paths handed to the platform for a native file drag. Directory metadata is\nprovided by the caller to avoid querying it when the platform drag starts.", "signature": "# [doc = \" Paths handed to the platform for a native file drag. Directory metadata is\"] # [doc = \" provided by the caller to avoid querying it when the platform drag starts.\"] # [derive (Debug, Clone, Default, Eq, PartialEq)] pub struct FileDragPaths (SmallVec<[(PathBuf, bool); 2]>);", "cfg": [] }, { "id": "gpui::interactive::FileDragPaths::entries", "name": "entries", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The dragged paths, each paired with whether it is a directory.", "documentation": "The dragged paths, each paired with whether it is a directory.", "signature": "pub fn entries (& self) -> & [(PathBuf, bool)]", "cfg": [], "target": "FileDragPaths" }, { "id": "gpui::interactive::FileDragPaths::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Creates a native file-drag payload from paths paired with whether each path is a directory.", "documentation": "Creates a native file-drag payload from paths paired with whether each path is a directory.", "signature": "pub fn new (entries : impl IntoIterator) -> Self", "cfg": [], "target": "FileDragPaths" }, { "id": "gpui::interactive::FileDropEvent", "name": "FileDropEvent", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A file drop event from the platform, generated when files are dragged and dropped onto the window.", "documentation": "A file drop event from the platform, generated when files are dragged and dropped onto the window.", "signature": "# [doc = \" A file drop event from the platform, generated when files are dragged and dropped onto the window.\"] # [derive (Debug, Clone)] pub enum FileDropEvent { # [doc = \" The files have entered the window.\"] Entered { # [doc = \" The position of the mouse relative to the window.\"] position : Point, # [doc = \" The paths of the files that are being dragged.\"] paths : ExternalPaths, }, # [doc = \" The files are being dragged over the window\"] Pending { # [doc = \" The position of the mouse relative to the window.\"] position : Point, }, # [doc = \" The files have been dropped onto the window.\"] Submit { # [doc = \" The position of the mouse relative to the window.\"] position : Point, }, # [doc = \" The user has stopped dragging the files over the window.\"] Exited, # [doc = \" The platform-owned drag session has ended.\"] Ended, }", "cfg": [] }, { "id": "gpui::interactive::GestureEvent", "name": "GestureEvent", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A gesture event from the platform.", "documentation": "A gesture event from the platform.", "signature": "# [doc = \" A gesture event from the platform.\"] pub trait GestureEvent : InputEvent { }", "cfg": [] }, { "id": "gpui::interactive::InputEvent", "name": "InputEvent", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "An event from a platform input source.", "documentation": "An event from a platform input source.", "signature": "# [doc = \" An event from a platform input source.\"] pub trait InputEvent : Sealed + 'static { # [doc = \" Convert this event into the platform input enum.\"] fn to_platform_input (self) -> PlatformInput; }", "cfg": [] }, { "id": "gpui::interactive::KeyDownEvent", "name": "KeyDownEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The key down event equivalent for the platform.", "documentation": "The key down event equivalent for the platform.", "signature": "# [doc = \" The key down event equivalent for the platform.\"] # [derive (Clone, Debug, Eq, PartialEq)] pub struct KeyDownEvent { # [doc = \" The keystroke that was generated.\"] pub keystroke : Keystroke, # [doc = \" Whether the key is currently held down.\"] pub is_held : bool, # [doc = \" Whether to prefer character input over keybindings for this keystroke.\"] # [doc = \" In some cases, like AltGr on Windows, modifiers are significant for character input.\"] pub prefer_character_input : bool, }", "cfg": [] }, { "id": "gpui::interactive::KeyEvent", "name": "KeyEvent", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A key event from the platform.", "documentation": "A key event from the platform.", "signature": "# [doc = \" A key event from the platform.\"] pub trait KeyEvent : InputEvent { }", "cfg": [] }, { "id": "gpui::interactive::KeyUpEvent", "name": "KeyUpEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The key up event equivalent for the platform.", "documentation": "The key up event equivalent for the platform.", "signature": "# [doc = \" The key up event equivalent for the platform.\"] # [derive (Clone, Debug)] pub struct KeyUpEvent { # [doc = \" The keystroke that was released.\"] pub keystroke : Keystroke, }", "cfg": [] }, { "id": "gpui::interactive::KeyboardButton", "name": "KeyboardButton", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "An enum representing the keyboard button that was pressed for a click event.", "documentation": "An enum representing the keyboard button that was pressed for a click event.", "signature": "# [doc = \" An enum representing the keyboard button that was pressed for a click event.\"] # [derive (Hash, PartialEq, Eq, Copy, Clone, Debug, Default)] pub enum KeyboardButton { # [doc = \" Enter key was clicked\"] # [default] Enter, # [doc = \" Space key was clicked\"] Space, }", "cfg": [] }, { "id": "gpui::interactive::KeyboardClickEvent", "name": "KeyboardClickEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A click event that was generated by a keyboard button being pressed and released.", "documentation": "A click event that was generated by a keyboard button being pressed and released.", "signature": "# [doc = \" A click event that was generated by a keyboard button being pressed and released.\"] # [derive (Clone, Debug, Default)] pub struct KeyboardClickEvent { # [doc = \" The keyboard button that was pressed to trigger the click.\"] pub button : KeyboardButton, # [doc = \" The bounds of the element that was clicked.\"] pub bounds : Bounds, }", "cfg": [] }, { "id": "gpui::interactive::ModifiersChangedEvent", "name": "ModifiersChangedEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The modifiers changed event equivalent for the platform.", "documentation": "The modifiers changed event equivalent for the platform.", "signature": "# [doc = \" The modifiers changed event equivalent for the platform.\"] # [derive (Clone, Debug, Default)] pub struct ModifiersChangedEvent { # [doc = \" The new state of the modifier keys\"] pub modifiers : Modifiers, # [doc = \" The new state of the capslock key\"] pub capslock : Capslock, }", "cfg": [] }, { "id": "gpui::interactive::MouseButton", "name": "MouseButton", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "An enum representing the mouse button that was pressed.", "documentation": "An enum representing the mouse button that was pressed.", "signature": "# [doc = \" An enum representing the mouse button that was pressed.\"] # [derive (Hash, Default, PartialEq, Eq, Copy, Clone, Debug)] pub enum MouseButton { # [doc = \" The left mouse button.\"] # [default] Left, # [doc = \" The right mouse button.\"] Right, # [doc = \" The middle mouse button.\"] Middle, # [doc = \" A navigation button, such as back or forward.\"] Navigate (NavigationDirection), }", "cfg": [] }, { "id": "gpui::interactive::MouseButton::all", "name": "all", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Get all the mouse buttons in a list.", "documentation": "Get all the mouse buttons in a list.", "signature": "pub fn all () -> Vec", "cfg": [], "target": "MouseButton" }, { "id": "gpui::interactive::MouseCancelEvent", "name": "MouseCancelEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The platform ended a mouse/pointer stream without a release (capture loss, cancellation, or deactivation). This is not a mouse-up and must not click or drop. Window broadcasts it to mouse listeners even if propagation is stopped, then releases capture and cancels dragging. Gesture owners should discard pending presses during the capture phase. Repeated cancellation is harmless.", "documentation": "The platform ended a mouse/pointer stream without a release (capture loss,\ncancellation, or deactivation). This is not a mouse-up and must not click or\ndrop. Window broadcasts it to mouse listeners even if propagation is stopped,\nthen releases capture and cancels dragging. Gesture owners should discard\npending presses during the capture phase. Repeated cancellation is harmless.", "signature": "# [doc = \" The platform ended a mouse/pointer stream without a release (capture loss,\"] # [doc = \" cancellation, or deactivation). This is not a mouse-up and must not click or\"] # [doc = \" drop. Window broadcasts it to mouse listeners even if propagation is stopped,\"] # [doc = \" then releases capture and cancels dragging. Gesture owners should discard\"] # [doc = \" pending presses during the capture phase. Repeated cancellation is harmless.\"] # [derive (Clone, Copy, Debug, Default)] pub struct MouseCancelEvent;", "cfg": [] }, { "id": "gpui::interactive::MouseClickEvent", "name": "MouseClickEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A click event, generated when a mouse button is pressed and released.", "documentation": "A click event, generated when a mouse button is pressed and released.", "signature": "# [doc = \" A click event, generated when a mouse button is pressed and released.\"] # [derive (Clone, Debug, Default)] pub struct MouseClickEvent { # [doc = \" The mouse event when the button was pressed.\"] pub down : MouseDownEvent, # [doc = \" The mouse event when the button was released.\"] pub up : MouseUpEvent, }", "cfg": [] }, { "id": "gpui::interactive::MouseDownEvent", "name": "MouseDownEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse down event from the platform", "documentation": "A mouse down event from the platform", "signature": "# [doc = \" A mouse down event from the platform\"] # [derive (Clone, Debug, Default)] pub struct MouseDownEvent { # [doc = \" Which mouse button was pressed.\"] pub button : MouseButton, # [doc = \" The position of the mouse on the window.\"] pub position : Point, # [doc = \" The modifiers that were held down when the mouse was pressed.\"] pub modifiers : Modifiers, # [doc = \" The number of times the button has been clicked.\"] pub click_count : usize, # [doc = \" Whether this is the first, focusing click.\"] pub first_mouse : bool, }", "cfg": [] }, { "id": "gpui::interactive::MouseDownEvent::is_focusing", "name": "is_focusing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns true if this mouse up event should focus the element.", "documentation": "Returns true if this mouse up event should focus the element.", "signature": "pub fn is_focusing (& self) -> bool", "cfg": [], "target": "MouseDownEvent" }, { "id": "gpui::interactive::MouseEvent", "name": "MouseEvent", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse event from the platform.", "documentation": "A mouse event from the platform.", "signature": "# [doc = \" A mouse event from the platform.\"] pub trait MouseEvent : InputEvent { }", "cfg": [] }, { "id": "gpui::interactive::MouseExitEvent", "name": "MouseExitEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse exit event from the platform, generated when the mouse leaves the window.", "documentation": "A mouse exit event from the platform, generated when the mouse leaves the window.", "signature": "# [doc = \" A mouse exit event from the platform, generated when the mouse leaves the window.\"] # [derive (Clone, Debug, Default)] pub struct MouseExitEvent { # [doc = \" The position of the mouse relative to the window.\"] pub position : Point, # [doc = \" The mouse button that was pressed, if any.\"] pub pressed_button : Option, # [doc = \" The modifiers that were held down when the mouse was moved.\"] pub modifiers : Modifiers, }", "cfg": [] }, { "id": "gpui::interactive::MouseMoveEvent", "name": "MouseMoveEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse move event from the platform.", "documentation": "A mouse move event from the platform.", "signature": "# [doc = \" A mouse move event from the platform.\"] # [derive (Clone, Debug, Default)] pub struct MouseMoveEvent { # [doc = \" The position of the mouse on the window.\"] pub position : Point, # [doc = \" The mouse button that was pressed, if any.\"] pub pressed_button : Option, # [doc = \" The modifiers that were held down when the mouse was moved.\"] pub modifiers : Modifiers, }", "cfg": [] }, { "id": "gpui::interactive::MouseMoveEvent::dragging", "name": "dragging", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns true if the left mouse button is currently held down.", "documentation": "Returns true if the left mouse button is currently held down.", "signature": "pub fn dragging (& self) -> bool", "cfg": [], "target": "MouseMoveEvent" }, { "id": "gpui::interactive::MousePressureEvent", "name": "MousePressureEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse pressure event from the platform. Generated when a force-sensitive trackpad is pressed hard. Currently only implemented for macOS trackpads.", "documentation": "A mouse pressure event from the platform. Generated when a force-sensitive trackpad is pressed hard.\nCurrently only implemented for macOS trackpads.", "signature": "# [doc = \" A mouse pressure event from the platform. Generated when a force-sensitive trackpad is pressed hard.\"] # [doc = \" Currently only implemented for macOS trackpads.\"] # [derive (Debug, Clone, Default)] pub struct MousePressureEvent { # [doc = \" Pressure of the current stage as a float between 0 and 1\"] pub pressure : f32, # [doc = \" The pressure stage of the event.\"] pub stage : PressureStage, # [doc = \" The position of the mouse on the window.\"] pub position : Point, # [doc = \" The modifiers that were held down when the mouse pressure changed.\"] pub modifiers : Modifiers, }", "cfg": [] }, { "id": "gpui::interactive::MouseUpEvent", "name": "MouseUpEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse up event from the platform", "documentation": "A mouse up event from the platform", "signature": "# [doc = \" A mouse up event from the platform\"] # [derive (Clone, Debug, Default)] pub struct MouseUpEvent { # [doc = \" Which mouse button was released.\"] pub button : MouseButton, # [doc = \" The position of the mouse on the window.\"] pub position : Point, # [doc = \" The modifiers that were held down when the mouse was released.\"] pub modifiers : Modifiers, # [doc = \" The number of times the button has been clicked.\"] pub click_count : usize, }", "cfg": [] }, { "id": "gpui::interactive::MouseUpEvent::is_focusing", "name": "is_focusing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns true if this mouse up event should focus the element.", "documentation": "Returns true if this mouse up event should focus the element.", "signature": "pub fn is_focusing (& self) -> bool", "cfg": [], "target": "MouseUpEvent" }, { "id": "gpui::interactive::NavigationDirection", "name": "NavigationDirection", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A navigation direction, such as back or forward.", "documentation": "A navigation direction, such as back or forward.", "signature": "# [doc = \" A navigation direction, such as back or forward.\"] # [derive (Hash, Default, PartialEq, Eq, Copy, Clone, Debug)] pub enum NavigationDirection { # [doc = \" The back button.\"] # [default] Back, # [doc = \" The forward button.\"] Forward, }", "cfg": [] }, { "id": "gpui::interactive::PinchEvent", "name": "PinchEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A pinch gesture from a platform trackpad or GPUI's portable touch recognizer.", "documentation": "A pinch gesture from a platform trackpad or GPUI's portable touch recognizer.\n", "signature": "# [doc = \" A pinch gesture from a platform trackpad or GPUI's portable touch recognizer.\"] # [doc = \"\"] # [derive (Clone, Debug, Default)] pub struct PinchEvent { # [doc = \" The position of the pinch center on the window.\"] pub position : Point, # [doc = \" The zoom delta for this event.\"] # [doc = \" Positive values indicate zooming in, negative values indicate zooming out.\"] # [doc = \" For example, 0.1 represents a 10% zoom increase.\"] # [doc = \" Portable touch pinch reports the ratio to the previous contact span\"] # [doc = \" minus one; consumers multiply their scale by `1.0 + delta`.\"] pub delta : f32, # [doc = \" The modifiers that were held down during the pinch gesture.\"] pub modifiers : Modifiers, # [doc = \" The phase of the pinch gesture.\"] pub phase : TouchPhase, }", "cfg": [] }, { "id": "gpui::interactive::PlatformInput", "name": "PlatformInput", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "An enum corresponding to all kinds of platform input events.", "documentation": "An enum corresponding to all kinds of platform input events.", "signature": "# [doc = \" An enum corresponding to all kinds of platform input events.\"] # [derive (Clone, Debug)] pub enum PlatformInput { # [doc = \" A key was pressed.\"] KeyDown (KeyDownEvent), # [doc = \" A key was released.\"] KeyUp (KeyUpEvent), # [doc = \" The keyboard modifiers were changed.\"] ModifiersChanged (ModifiersChangedEvent), # [doc = \" The mouse was pressed.\"] MouseDown (MouseDownEvent), # [doc = \" The mouse was released.\"] MouseUp (MouseUpEvent), # [doc = \" A pointer stream ended without a release or click.\"] MouseCancelled (MouseCancelEvent), # [doc = \" Mouse pressure.\"] MousePressure (MousePressureEvent), # [doc = \" The mouse was moved.\"] MouseMove (MouseMoveEvent), # [doc = \" The mouse exited the window.\"] MouseExited (MouseExitEvent), # [doc = \" The scroll wheel was used.\"] ScrollWheel (ScrollWheelEvent), # [doc = \" A pinch gesture was performed.\"] Pinch (PinchEvent), # [doc = \" A long-press gesture recognized from touch input.\"] LongPress (LongPressEvent), # [doc = \" A direct touch drag claimed by an element.\"] TouchDrag (TouchDragEvent), # [doc = \" A direction-aware touch manipulation acquired after slop.\"] TouchPan (crate::TouchPanEvent), # [doc = \" Files were dragged and dropped onto the window.\"] FileDrop (FileDropEvent), # [doc = \" Non-path native data was dragged and dropped onto the window.\"] ExternalDrop (ExternalDropEvent), # [doc = \" A raw touch event on a touch screen.\"] Touch (TouchEvent), }", "cfg": [] }, { "id": "gpui::interactive::PlatformInput::kind_name", "name": "kind_name", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A short static name for this input's variant, for diagnostics and telemetry.", "documentation": "A short static name for this input's variant, for diagnostics and\ntelemetry.", "signature": "pub fn kind_name (& self) -> & 'static str", "cfg": [], "target": "PlatformInput" }, { "id": "gpui::interactive::PlatformInput::touch_event", "name": "touch_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns the touch event contained in this input, if any.", "documentation": "Returns the touch event contained in this input, if any.", "signature": "pub fn touch_event (& self) -> Option<& TouchEvent>", "cfg": [], "target": "PlatformInput" }, { "id": "gpui::interactive::PointerButtonState", "name": "PointerButtonState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Complete button state for platform adapters that receive button snapshots. Bits 0..4 denote left, right, middle, back and forward, respectively (the standard pointer `buttons` layout). Unknown bits are ignored. Reconciliation emits each changed button once, releases before presses, including chord transitions delivered in a move rather than a down/up platform message.", "documentation": "Complete button state for platform adapters that receive button snapshots.\nBits 0..4 denote left, right, middle, back and forward, respectively (the\nstandard pointer `buttons` layout). Unknown bits are ignored. Reconciliation\nemits each changed button once, releases before presses, including chord\ntransitions delivered in a move rather than a down/up platform message.", "signature": "# [doc = \" Complete button state for platform adapters that receive button snapshots.\"] # [doc = \" Bits 0..4 denote left, right, middle, back and forward, respectively (the\"] # [doc = \" standard pointer `buttons` layout). Unknown bits are ignored. Reconciliation\"] # [doc = \" emits each changed button once, releases before presses, including chord\"] # [doc = \" transitions delivered in a move rather than a down/up platform message.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct PointerButtonState (u16);", "cfg": [] }, { "id": "gpui::interactive::PointerButtonState::cancel", "name": "cancel", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Forget a cancelled stream without producing synthetic releases/clicks. Returns whether any button was held; repeated calls return false.", "documentation": "Forget a cancelled stream without producing synthetic releases/clicks.\nReturns whether any button was held; repeated calls return false.", "signature": "pub fn cancel (& mut self) -> bool", "cfg": [], "target": "PointerButtonState" }, { "id": "gpui::interactive::PointerButtonState::pressed_button", "name": "pressed_button", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "One held button for the legacy move API, preferring left, right, middle, back, then forward. Never returns an already released button.", "documentation": "One held button for the legacy move API, preferring left, right, middle,\nback, then forward. Never returns an already released button.", "signature": "pub fn pressed_button (self) -> Option", "cfg": [], "target": "PointerButtonState" }, { "id": "gpui::interactive::PointerButtonState::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Reconcile a platform snapshot; the bool is true for a press.", "documentation": "Reconcile a platform snapshot; the bool is true for a press.", "signature": "pub fn update (& mut self, buttons : u16) -> Vec<(MouseButton, bool)>", "cfg": [], "target": "PointerButtonState" }, { "id": "gpui::interactive::PressureStage", "name": "PressureStage", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The stage of a pressure click event.", "documentation": "The stage of a pressure click event.", "signature": "# [doc = \" The stage of a pressure click event.\"] # [derive (Clone, Copy, Debug, Default, PartialEq)] pub enum PressureStage { # [doc = \" No pressure.\"] # [default] Zero, # [doc = \" Normal click pressure.\"] Normal, # [doc = \" High pressure, enough to trigger a force click.\"] Force, }", "cfg": [] }, { "id": "gpui::interactive::ScrollDelta", "name": "ScrollDelta", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The scroll delta for a scroll wheel event.", "documentation": "The scroll delta for a scroll wheel event.", "signature": "# [doc = \" The scroll delta for a scroll wheel event.\"] # [derive (Clone, Copy, Debug)] pub enum ScrollDelta { # [doc = \" An exact scroll delta in pixels.\"] Pixels (Point), # [doc = \" An inexact scroll delta in lines.\"] Lines (Point), }", "cfg": [] }, { "id": "gpui::interactive::ScrollDelta::coalesce", "name": "coalesce", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Combines two scroll deltas into one. If the signs of the deltas are the same (both positive or both negative), the deltas are added together. If the signs are opposite, the second delta (other) is used, effectively overriding the first delta.", "documentation": "Combines two scroll deltas into one.\nIf the signs of the deltas are the same (both positive or both negative),\nthe deltas are added together. If the signs are opposite, the second delta\n(other) is used, effectively overriding the first delta.", "signature": "pub fn coalesce (self, other : ScrollDelta) -> ScrollDelta", "cfg": [], "target": "ScrollDelta" }, { "id": "gpui::interactive::ScrollDelta::pixel_delta", "name": "pixel_delta", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Converts this scroll event into exact pixels.", "documentation": "Converts this scroll event into exact pixels.", "signature": "pub fn pixel_delta (& self, line_height : Pixels) -> Point", "cfg": [], "target": "ScrollDelta" }, { "id": "gpui::interactive::ScrollDelta::precise", "name": "precise", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Returns true if this is a precise scroll delta in pixels.", "documentation": "Returns true if this is a precise scroll delta in pixels.", "signature": "pub fn precise (& self) -> bool", "cfg": [], "target": "ScrollDelta" }, { "id": "gpui::interactive::ScrollWheelEvent", "name": "ScrollWheelEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A mouse wheel event from the platform.", "documentation": "A mouse wheel event from the platform.", "signature": "# [doc = \" A mouse wheel event from the platform.\"] # [derive (Clone, Debug, Default)] pub struct ScrollWheelEvent { # [doc = \" The position of the mouse on the window.\"] pub position : Point, # [doc = \" The change in scroll wheel position for this event.\"] pub delta : ScrollDelta, # [doc = \" The modifiers that were held down when the mouse was moved.\"] pub modifiers : Modifiers, # [doc = \" The phase of the touch event.\"] pub touch_phase : TouchPhase, }", "cfg": [] }, { "id": "gpui::interactive::TouchClickEvent", "name": "TouchClickEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A click event that was generated by a recognized tap gesture on a touch screen.", "documentation": "A click event that was generated by a recognized tap gesture on a touch\nscreen.", "signature": "# [doc = \" A click event that was generated by a recognized tap gesture on a touch\"] # [doc = \" screen.\"] # [derive (Clone, Debug, Default)] pub struct TouchClickEvent { # [doc = \" The position of the tap in window coordinates.\"] pub position : Point, # [doc = \" The number of consecutive taps at this location (double tap = 2),\"] # [doc = \" analogous to the mouse `click_count`.\"] pub tap_count : usize, # [doc = \" Whether this was a long press rather than a tap. Long presses are\"] # [doc = \" touch's secondary activation: they are delivered to aux-click\"] # [doc = \" listeners alongside right clicks, not to primary click listeners.\"] pub long_press : bool, }", "cfg": [] }, { "id": "gpui::interactive::TouchEvent", "name": "TouchEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "A raw touch event from the platform.", "documentation": "A raw touch event from the platform.\n\nForward all contacts using stable IDs, never their index in a native event.\nCoordinates are logical window pixels. Deliver historical samples before\ncurrent samples, and never also synthesize mouse/native gestures for these\ncontacts. Predictions affect pan output only. Cancellation is per-contact;\na system-wide interruption must call [`Window::cancel_touch_input`] as well\nto stop post-release momentum and pending recognition.", "signature": "# [doc = \" A raw touch event from the platform.\"] # [doc = \"\"] # [doc = \" Forward all contacts using stable IDs, never their index in a native event.\"] # [doc = \" Coordinates are logical window pixels. Deliver historical samples before\"] # [doc = \" current samples, and never also synthesize mouse/native gestures for these\"] # [doc = \" contacts. Predictions affect pan output only. Cancellation is per-contact;\"] # [doc = \" a system-wide interruption must call [`Window::cancel_touch_input`] as well\"] # [doc = \" to stop post-release momentum and pending recognition.\"] # [derive (Clone, Debug, Default)] pub struct TouchEvent { # [doc = \" Which touch this event belongs to.\"] pub id : TouchId, # [doc = \" The phase of the touch.\"] pub phase : TouchPhase, # [doc = \" The position of the touch in window coordinates.\"] pub position : Point, # [doc = \" Where the platform predicts the touch will be roughly one frame from\"] # [doc = \" now, in the same coordinate space as `position`, when the platform\"] # [doc = \" offers a prediction for a [`TouchPhase::Moved`] event.\"] # [doc = \"\"] # [doc = \" Best-effort latency compensation only: it may influence how far a\"] # [doc = \" recognized pan scrolls within a frame, but never hit testing, gesture\"] # [doc = \" classification, or velocity estimation. Later events reconcile any\"] # [doc = \" prediction error.\"] pub predicted_position : Option>, # [doc = \" Normalized touch force in `0.0..=1.0`, if the hardware reports it.\"] pub force : Option, }", "cfg": [] }, { "id": "gpui::interactive::TouchId", "name": "TouchId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "Identifies one touch (finger or stylus contact) for its lifetime, from [`TouchPhase::Started`] through [`TouchPhase::Ended`] or [`TouchPhase::Cancelled`].", "documentation": "Identifies one touch (finger or stylus contact) for its lifetime, from\n[`TouchPhase::Started`] through [`TouchPhase::Ended`] or\n[`TouchPhase::Cancelled`].\n\nThe value is opaque and platform-defined; it is only guaranteed to be\nstable for the duration of the touch and unique among concurrent touches.", "signature": "# [doc = \" Identifies one touch (finger or stylus contact) for its lifetime, from\"] # [doc = \" [`TouchPhase::Started`] through [`TouchPhase::Ended`] or\"] # [doc = \" [`TouchPhase::Cancelled`].\"] # [doc = \"\"] # [doc = \" The value is opaque and platform-defined; it is only guaranteed to be\"] # [doc = \" stable for the duration of the touch and unique among concurrent touches.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, Hash, PartialOrd, Ord)] pub struct TouchId (pub u64);", "cfg": [] }, { "id": "gpui::interactive::TouchPhase", "name": "TouchPhase", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "interactive", "path": "gpui::interactive", "source": "crates/gpui/src/interactive.rs", "summary": "The phase of a touch motion event. Based on the winit enum of the same name.", "documentation": "The phase of a touch motion event.\nBased on the winit enum of the same name.", "signature": "# [doc = \" The phase of a touch motion event.\"] # [doc = \" Based on the winit enum of the same name.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub enum TouchPhase { # [doc = \" The touch started.\"] Started, # [doc = \" The touch event is moving.\"] # [default] Moved, # [doc = \" The touch phase has ended\"] Ended, # [doc = \" The touch was cancelled: the system took it and it will not end\"] # [doc = \" normally. Consumers must fully unwind any in-progress interaction,\"] # [doc = \" treating the touch as if it never committed.\"] Cancelled, }", "cfg": [] }, { "id": "gpui::key_dispatch::DispatchTree::active_node_id", "name": "active_node_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn active_node_id (& self) -> Option", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::available_actions", "name": "available_actions", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn available_actions (& self, target : DispatchNodeId) -> Vec>", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::bindings_for_action", "name": "bindings_for_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "Returns key bindings that invoke an action on the currently focused element. Bindings are returned in the order they were added. For display, the last binding should take precedence.", "documentation": "Returns key bindings that invoke an action on the currently focused element. Bindings are\nreturned in the order they were added. For display, the last binding should take precedence.\n\nBindings are only included if they are the highest precedence match for their keystrokes, so\nshadowed bindings are not included.", "signature": "pub fn bindings_for_action (& self, action : & dyn Action, context_stack : & [KeyContext],) -> Vec", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::dispatch_key", "name": "dispatch_key", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "dispatch_key processes the keystroke input should be set to the value of `pending` from the previous call to dispatch_key. This returns three instructions to the input handler: - bindings: any bindings to execute before processing this keystroke - pending: the new set of pending keystrokes to store - to_replay: any keystroke that had been pushed to pending, but are no-longer matched, these should be replayed first.", "documentation": "dispatch_key processes the keystroke\ninput should be set to the value of `pending` from the previous call to dispatch_key.\nThis returns three instructions to the input handler:\n- bindings: any bindings to execute before processing this keystroke\n- pending: the new set of pending keystrokes to store\n- to_replay: any keystroke that had been pushed to pending, but are no-longer matched,\nthese should be replayed first.", "signature": "pub fn dispatch_key (& mut self, mut input : SmallVec<[Keystroke; 1]>, keystroke : Keystroke, dispatch_path : & SmallVec<[DispatchNodeId; 32]>,) -> DispatchResult", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::dispatch_path", "name": "dispatch_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn dispatch_path (& self, target : DispatchNodeId) -> SmallVec<[DispatchNodeId; 32]>", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::flush_dispatch", "name": "flush_dispatch", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "If the user types a matching prefix of a binding and then waits for a timeout flush_dispatch() converts any previously pending input to replay events.", "documentation": "If the user types a matching prefix of a binding and then waits for a timeout\nflush_dispatch() converts any previously pending input to replay events.", "signature": "pub fn flush_dispatch (& mut self, input : SmallVec<[Keystroke; 1]>, dispatch_path : & SmallVec<[DispatchNodeId; 32]>,) -> SmallVec<[Replay; 1]>", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::focus_contains", "name": "focus_contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn focus_contains (& self, parent : FocusId, child : FocusId) -> bool", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::focus_path", "name": "focus_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn focus_path (& self, focus_id : FocusId) -> SmallVec<[FocusId; 8]>", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::focusable_node_id", "name": "focusable_node_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn focusable_node_id (& self, target : FocusId) -> Option", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::highest_precedence_binding_for_action", "name": "highest_precedence_binding_for_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "Returns the highest precedence binding for the given action and context stack. This is the same as the last result of `bindings_for_action`, but more efficient than getting all bindings.", "documentation": "Returns the highest precedence binding for the given action and context stack. This is the\nsame as the last result of `bindings_for_action`, but more efficient than getting all bindings.", "signature": "pub fn highest_precedence_binding_for_action (& self, action : & dyn Action, context_stack : & [KeyContext],) -> Option", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::is_action_available", "name": "is_action_available", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn is_action_available (& self, action : & dyn Action, target : DispatchNodeId) -> bool", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn new (keymap : Rc>, action_registry : Rc) -> Self", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::node", "name": "node", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn node (& self, node_id : DispatchNodeId) -> & DispatchNode", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::on_action", "name": "on_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn on_action (& mut self, action_type : TypeId, listener : Rc,)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::on_key_event", "name": "on_key_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn on_key_event (& mut self, listener : KeyListener)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::on_modifiers_changed", "name": "on_modifiers_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn on_modifiers_changed (& mut self, listener : ModifiersChangedListener)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::pop_node", "name": "pop_node", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn pop_node (& mut self)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::possible_next_bindings_for_input", "name": "possible_next_bindings_for_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "Find the bindings that can follow the current input sequence.", "documentation": "Find the bindings that can follow the current input sequence.", "signature": "pub fn possible_next_bindings_for_input (& self, input : & [Keystroke], context_stack : & [KeyContext],) -> Vec", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::push_node", "name": "push_node", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn push_node (& mut self) -> DispatchNodeId", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::reuse_subtree", "name": "reuse_subtree", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn reuse_subtree (& mut self, old_range : Range, source : & mut Self, focus : Option,) -> ReusedSubtree", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::root_node_id", "name": "root_node_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn root_node_id (& self) -> DispatchNodeId", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::set_active_node", "name": "set_active_node", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn set_active_node (& mut self, node_id : DispatchNodeId)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::set_focus_id", "name": "set_focus_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn set_focus_id (& mut self, focus_id : FocusId)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::set_key_context", "name": "set_key_context", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn set_key_context (& mut self, context : KeyContext)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::set_view_id", "name": "set_view_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn set_view_id (& mut self, view_id : EntityId)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::truncate", "name": "truncate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn truncate (& mut self, index : usize)", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::DispatchTree::view_path_reversed", "name": "view_path_reversed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn view_path_reversed (& self, view_id : EntityId) -> impl Iterator", "cfg": [], "target": "DispatchTree" }, { "id": "gpui::key_dispatch::ReusedSubtree::contains_focus", "name": "contains_focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn contains_focus (& self) -> bool", "cfg": [], "target": "ReusedSubtree" }, { "id": "gpui::key_dispatch::ReusedSubtree::refresh_node_id", "name": "refresh_node_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "key_dispatch", "path": "gpui::key_dispatch", "source": "crates/gpui/src/key_dispatch.rs", "summary": "", "documentation": "", "signature": "pub fn refresh_node_id (& self, node_id : DispatchNodeId) -> DispatchNodeId", "cfg": [], "target": "ReusedSubtree" }, { "id": "gpui::keymap::BindingIndex", "name": "BindingIndex", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Index of a binding within a keymap.", "documentation": "Index of a binding within a keymap.", "signature": "# [doc = \" Index of a binding within a keymap.\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)] pub struct BindingIndex (usize);", "cfg": [] }, { "id": "gpui::keymap::Keymap", "name": "Keymap", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "A collection of key bindings for the user's application.", "documentation": "A collection of key bindings for the user's application.", "signature": "# [doc = \" A collection of key bindings for the user's application.\"] # [derive (Default)] pub struct Keymap { bindings : Vec, binding_indices_by_action_id : TypeIdHashMap>, disabled_binding_indices : Vec, version : KeymapVersion, }", "cfg": [] }, { "id": "gpui::keymap::Keymap::add_bindings", "name": "add_bindings", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Add more bindings to the keymap.", "documentation": "Add more bindings to the keymap.", "signature": "pub fn add_bindings> (& mut self, bindings : T)", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::all_bindings_for_input", "name": "all_bindings_for_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Returns all bindings that might match the input without checking context. The bindings returned in precedence order (reverse of the order they were added to the keymap).", "documentation": "Returns all bindings that might match the input without checking context. The bindings\nreturned in precedence order (reverse of the order they were added to the keymap).", "signature": "pub fn all_bindings_for_input (& self, input : & [Keystroke]) -> Vec", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::bindings", "name": "bindings", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Iterate over all bindings, in the order they were added.", "documentation": "Iterate over all bindings, in the order they were added.", "signature": "pub fn bindings (& self) -> impl DoubleEndedIterator + ExactSizeIterator", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::bindings_for_action", "name": "bindings_for_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Iterate over all bindings for the given action, in the order they were added. For display, the last binding should take precedence.", "documentation": "Iterate over all bindings for the given action, in the order they were added. For display,\nthe last binding should take precedence.", "signature": "pub fn bindings_for_action<'a> (& 'a self, action : & 'a dyn Action,) -> impl 'a + DoubleEndedIterator", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::bindings_for_input", "name": "bindings_for_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Returns a list of bindings that match the given input, and a boolean indicating whether or not more bindings might match if the input was longer. Bindings are returned in precedence order (higher precedence first, reverse of the order they were added to the keymap).", "documentation": "Returns a list of bindings that match the given input, and a boolean indicating whether or\nnot more bindings might match if the input was longer. Bindings are returned in precedence\norder (higher precedence first, reverse of the order they were added to the keymap).\n\nPrecedence is defined by the depth in the tree (matches on the Editor take precedence over\nmatches on the Pane, then the Workspace, etc.). Bindings with no context are treated as the\nsame as the deepest context.\n\nIn the case of multiple bindings at the same depth, the ones added to the keymap later take\nprecedence. User bindings are added after built-in bindings so that they take precedence.\n\nIf a binding has been disabled with `\"x\": null` it will not be returned. Disabled bindings\nare evaluated with the same precedence rules so you can disable a rule in a given context\nonly. A disabled binding only suppresses bindings from sources with equal or weaker\nprecedence: a base keymap null hides default bindings, but user bindings still apply.", "signature": "pub fn bindings_for_input (& self, input : & [impl AsKeystroke], context_stack : & [KeyContext],) -> (SmallVec<[KeyBinding; 1]>, bool)", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Reset this keymap to its initial state.", "documentation": "Reset this keymap to its initial state.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Create a new keymap with the given bindings.", "documentation": "Create a new keymap with the given bindings.", "signature": "pub fn new (bindings : Vec) -> Self", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::possible_next_bindings_for_input", "name": "possible_next_bindings_for_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Find the bindings that can follow the current input sequence.", "documentation": "Find the bindings that can follow the current input sequence.", "signature": "pub fn possible_next_bindings_for_input (& self, input : & [Keystroke], context_stack : & [KeyContext],) -> Vec", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::Keymap::version", "name": "version", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "Get the current version of the keymap.", "documentation": "Get the current version of the keymap.", "signature": "pub fn version (& self) -> KeymapVersion", "cfg": [], "target": "Keymap" }, { "id": "gpui::keymap::KeymapVersion", "name": "KeymapVersion", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "An opaque identifier of which version of the keymap is currently active. The keymap's version is changed whenever bindings are added or removed.", "documentation": "An opaque identifier of which version of the keymap is currently active.\nThe keymap's version is changed whenever bindings are added or removed.", "signature": "# [doc = \" An opaque identifier of which version of the keymap is currently active.\"] # [doc = \" The keymap's version is changed whenever bindings are added or removed.\"] # [derive (Copy, Clone, Eq, PartialEq, Default)] pub struct KeymapVersion (usize);", "cfg": [] }, { "id": "gpui::keymap::binding::KeyBinding", "name": "KeyBinding", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "A keybinding and its associated metadata, from the keymap.", "documentation": "A keybinding and its associated metadata, from the keymap.", "signature": "# [doc = \" A keybinding and its associated metadata, from the keymap.\"] pub struct KeyBinding { pub (crate) action : Box, pub (crate) keystrokes : SmallVec<[KeybindingKeystroke; 2]>, pub (crate) context_predicate : Option>, pub (crate) meta : Option, # [doc = \" The json input string used when building the keybinding, if any\"] pub (crate) action_input : Option, }", "cfg": [] }, { "id": "gpui::keymap::binding::KeyBinding::action", "name": "action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Get the action associated with this binding", "documentation": "Get the action associated with this binding", "signature": "pub fn action (& self) -> & dyn Action", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::action_input", "name": "action_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Get the action input associated with the action for this binding", "documentation": "Get the action input associated with the action for this binding", "signature": "pub fn action_input (& self) -> Option", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::keystrokes", "name": "keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Get the keystrokes associated with this binding", "documentation": "Get the keystrokes associated with this binding", "signature": "pub fn keystrokes (& self) -> & [KeybindingKeystroke]", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::load", "name": "load", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Load a keybinding from the given raw data.", "documentation": "Load a keybinding from the given raw data.", "signature": "pub fn load (keystrokes : & str, action : Box, context_predicate : Option>, use_key_equivalents : bool, action_input : Option, keyboard_mapper : & dyn PlatformKeyboardMapper,) -> std::result::Result", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::match_keystrokes", "name": "match_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Check if the given keystrokes match this binding.", "documentation": "Check if the given keystrokes match this binding.", "signature": "pub fn match_keystrokes (& self, typed : & [impl AsKeystroke]) -> Option", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::meta", "name": "meta", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Get the metadata for this binding", "documentation": "Get the metadata for this binding", "signature": "pub fn meta (& self) -> Option", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Construct a new keybinding from the given data. Panics on parse error.", "documentation": "Construct a new keybinding from the given data. Panics on parse error.", "signature": "pub fn new (keystrokes : & str, action : A, context : Option<& str>) -> Self", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::predicate", "name": "predicate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Get the predicate used to match this binding", "documentation": "Get the predicate used to match this binding", "signature": "pub fn predicate (& self) -> Option>", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::set_meta", "name": "set_meta", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Set the metadata for this binding.", "documentation": "Set the metadata for this binding.", "signature": "pub fn set_meta (& mut self, meta : KeyBindingMetaIndex)", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBinding::with_meta", "name": "with_meta", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "Set the metadata for this binding.", "documentation": "Set the metadata for this binding.", "signature": "pub fn with_meta (mut self, meta : KeyBindingMetaIndex) -> Self", "cfg": [], "target": "KeyBinding" }, { "id": "gpui::keymap::binding::KeyBindingMetaIndex", "name": "KeyBindingMetaIndex", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap::binding", "path": "gpui::keymap::binding", "source": "crates/gpui/src/keymap/binding.rs", "summary": "A unique identifier for retrieval of metadata associated with a key binding. Intended to be used as an index or key into a user-defined store of metadata associated with the binding, such as the source of the binding.", "documentation": "A unique identifier for retrieval of metadata associated with a key binding.\nIntended to be used as an index or key into a user-defined store of metadata\nassociated with the binding, such as the source of the binding.", "signature": "# [doc = \" A unique identifier for retrieval of metadata associated with a key binding.\"] # [doc = \" Intended to be used as an index or key into a user-defined store of metadata\"] # [doc = \" associated with the binding, such as the source of the binding.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash)] pub struct KeyBindingMetaIndex (pub u32);", "cfg": [] }, { "id": "gpui::keymap::context::ContextEntry", "name": "ContextEntry", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "An entry in a KeyContext", "documentation": "An entry in a KeyContext", "signature": "# [derive (Clone, Debug, Eq, PartialEq, Hash)] # [doc = \" An entry in a KeyContext\"] pub struct ContextEntry { # [doc = \" The key (or name if no value)\"] pub key : SharedString, # [doc = \" The value\"] pub value : Option, }", "cfg": [] }, { "id": "gpui::keymap::context::KeyBindingContextPredicate", "name": "KeyBindingContextPredicate", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "A datastructure for resolving whether an action should be dispatched Representing a small language for describing which contexts correspond to which actions.", "documentation": "A datastructure for resolving whether an action should be dispatched\nRepresenting a small language for describing which contexts correspond\nto which actions.", "signature": "# [doc = \" A datastructure for resolving whether an action should be dispatched\"] # [doc = \" Representing a small language for describing which contexts correspond\"] # [doc = \" to which actions.\"] # [derive (Clone, Debug, Eq, PartialEq, Hash)] pub enum KeyBindingContextPredicate { # [doc = \" A predicate that will match a given identifier.\"] Identifier (SharedString), # [doc = \" A predicate that will match a given key-value pair.\"] Equal (SharedString, SharedString), # [doc = \" A predicate that will match a given key-value pair not being present.\"] NotEqual (SharedString, SharedString), # [doc = \" A predicate that will match a given predicate appearing below another predicate.\"] # [doc = \" in the element tree\"] Descendant (Box, Box,), # [doc = \" Predicate that will invert another predicate.\"] Not (Box), # [doc = \" A predicate that will match if both of its children match.\"] And (Box, Box,), # [doc = \" A predicate that will match if either of its children match.\"] Or (Box, Box,), }", "cfg": [] }, { "id": "gpui::keymap::context::KeyBindingContextPredicate::depth_of", "name": "depth_of", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Find the deepest depth at which the predicate matches.", "documentation": "Find the deepest depth at which the predicate matches.", "signature": "pub fn depth_of (& self, contexts : & [KeyContext]) -> Option", "cfg": [], "target": "KeyBindingContextPredicate" }, { "id": "gpui::keymap::context::KeyBindingContextPredicate::eval", "name": "eval", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Eval a predicate against a set of contexts, arranged from lowest to highest.", "documentation": "Eval a predicate against a set of contexts, arranged from lowest to highest.", "signature": "pub fn eval (& self, contexts : & [KeyContext]) -> bool", "cfg": [], "target": "KeyBindingContextPredicate" }, { "id": "gpui::keymap::context::KeyBindingContextPredicate::eval_inner", "name": "eval_inner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Eval a predicate against a set of contexts, arranged from lowest to highest.", "documentation": "Eval a predicate against a set of contexts, arranged from lowest to highest.", "signature": "pub fn eval_inner (& self, contexts : & [KeyContext], all_contexts : & [KeyContext]) -> bool", "cfg": [], "target": "KeyBindingContextPredicate" }, { "id": "gpui::keymap::context::KeyBindingContextPredicate::is_superset", "name": "is_superset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Returns whether or not this predicate matches all possible contexts matched by the other predicate.", "documentation": "Returns whether or not this predicate matches all possible contexts matched by\nthe other predicate.", "signature": "pub fn is_superset (& self, other : & Self) -> bool", "cfg": [], "target": "KeyBindingContextPredicate" }, { "id": "gpui::keymap::context::KeyBindingContextPredicate::parse", "name": "parse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Parse a string in the same format as the keymap's context field.", "documentation": "Parse a string in the same format as the keymap's context field.\n\nA basic equivalence check against a set of identifiers can performed by\nsimply writing a string:\n\n`StatusBar` -> A predicate that will match a context with the identifier `StatusBar`\n\nYou can also specify a key-value pair:\n\n`mode == visible` -> A predicate that will match a context with the key `mode`\nwith the value `visible`\n\nAnd a logical operations combining these two checks:\n\n`StatusBar && mode == visible` -> A predicate that will match a context with the\nidentifier `StatusBar` and the key `mode`\nwith the value `visible`\n\n\nThere is also a special child `>` operator that will match a predicate that is\nbelow another predicate:\n\n`StatusBar > mode == visible` -> A predicate that will match a context identifier `StatusBar`\nand a child context that has the key `mode` with the\nvalue `visible`\n\nThis syntax supports `!=`, `||` and `&&` as logical operators.\nYou can also preface an operation or check with a `!` to negate it.", "signature": "pub fn parse (source : & str) -> Result", "cfg": [], "target": "KeyBindingContextPredicate" }, { "id": "gpui::keymap::context::KeyContext", "name": "KeyContext", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "A datastructure for resolving whether an action should be dispatched at this point in the element tree. Contains a set of identifiers and/or key value pairs representing the current context for the keymap.", "documentation": "A datastructure for resolving whether an action should be dispatched\nat this point in the element tree. Contains a set of identifiers\nand/or key value pairs representing the current context for the\nkeymap.", "signature": "# [doc = \" A datastructure for resolving whether an action should be dispatched\"] # [doc = \" at this point in the element tree. Contains a set of identifiers\"] # [doc = \" and/or key value pairs representing the current context for the\"] # [doc = \" keymap.\"] # [derive (Clone, Default, Eq, PartialEq, Hash)] pub struct KeyContext (Vec);", "cfg": [] }, { "id": "gpui::keymap::context::KeyContext::add", "name": "add", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Add an identifier to this context, if it's not already in this context.", "documentation": "Add an identifier to this context, if it's not already in this context.", "signature": "pub fn add> (& mut self, identifier : I)", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Clear this context.", "documentation": "Clear this context.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Check if this context contains a given identifier or key.", "documentation": "Check if this context contains a given identifier or key.", "signature": "pub fn contains (& self, key : & str) -> bool", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::extend", "name": "extend", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Extend this context with another context.", "documentation": "Extend this context with another context.", "signature": "pub fn extend (& mut self, other : & Self)", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::get", "name": "get", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Get the associated value for a given identifier or key.", "documentation": "Get the associated value for a given identifier or key.", "signature": "pub fn get (& self, key : & str) -> Option<& SharedString>", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Check if this context is empty.", "documentation": "Check if this context is empty.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::new_with_defaults", "name": "new_with_defaults", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Initialize a new [`KeyContext`] that contains an `os` key set to either `macos`, `linux`, `windows` or `unknown`.", "documentation": "Initialize a new [`KeyContext`] that contains an `os` key set to either `macos`, `linux`, `windows` or `unknown`.", "signature": "pub fn new_with_defaults () -> Self", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::parse", "name": "parse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Parse a key context from a string. The key context format is very simple: - either a single identifier, such as `StatusBar` - or a key value pair, such as `mode = visible` - separated by whitespace, such as `StatusBar mode = visible`", "documentation": "Parse a key context from a string.\nThe key context format is very simple:\n- either a single identifier, such as `StatusBar`\n- or a key value pair, such as `mode = visible`\n- separated by whitespace, such as `StatusBar mode = visible`", "signature": "pub fn parse (source : & str) -> Result", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::primary", "name": "primary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Returns the primary context entry (usually the name of the component)", "documentation": "Returns the primary context entry (usually the name of the component)", "signature": "pub fn primary (& self) -> Option<& ContextEntry>", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::secondary", "name": "secondary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Returns everything except the primary context entry.", "documentation": "Returns everything except the primary context entry.", "signature": "pub fn secondary (& self) -> impl Iterator", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::context::KeyContext::set", "name": "set", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "keymap::context", "path": "gpui::keymap::context", "source": "crates/gpui/src/keymap/context.rs", "summary": "Set a key value pair in this context, if it's not already set.", "documentation": "Set a key value pair in this context, if it's not already set.", "signature": "pub fn set, S2 : Into> (& mut self, key : S1, value : S2)", "cfg": [], "target": "KeyContext" }, { "id": "gpui::keymap::reexport-1", "name": "binding :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "", "documentation": "", "signature": "pub use binding::*;", "cfg": [] }, { "id": "gpui::keymap::reexport-2", "name": "context :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "keymap", "path": "gpui::keymap", "source": "crates/gpui/src/keymap.rs", "summary": "", "documentation": "", "signature": "pub use context::*;", "cfg": [] }, { "id": "gpui::luminance::BackdropStatistics", "name": "BackdropStatistics", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Statistics of the five optical-source texels copied by a glass probe: center and diagonal quarter points, after scattering when enabled and before glass compositing. These are encoded RGB measurements, not linear light, exhaustive backdrop extrema, or exhaustive backdrop variance. Alpha is ignored: stored RGB is neither unpremultiplied nor alpha-weighted.", "documentation": "Statistics of the five optical-source texels copied by a glass probe:\ncenter and diagonal quarter points, after scattering when enabled and\nbefore glass compositing. These are encoded RGB measurements, not linear\nlight, exhaustive backdrop extrema, or exhaustive backdrop variance.\nAlpha is ignored: stored RGB is neither unpremultiplied nor alpha-weighted.", "signature": "# [doc = \" Statistics of the five optical-source texels copied by a glass probe:\"] # [doc = \" center and diagonal quarter points, after scattering when enabled and\"] # [doc = \" before glass compositing. These are encoded RGB measurements, not linear\"] # [doc = \" light, exhaustive backdrop extrema, or exhaustive backdrop variance.\"] # [doc = \" Alpha is ignored: stored RGB is neither unpremultiplied nor alpha-weighted.\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct BackdropStatistics { # [doc = \" Arithmetic mean of stored encoded red, green, and blue, in `0..=1`.\"] pub mean_rgb : [f32; 3], # [doc = \" Mean encoded luminance; identical to the legacy probe reading.\"] pub mean_luminance : f32, # [doc = \" Minimum encoded luminance among the five sampled texels only.\"] pub min_luminance : f32, # [doc = \" Maximum encoded luminance among the five sampled texels only.\"] pub max_luminance : f32, # [doc = \" Population variance of the five encoded luminances (divisor five).\"] pub luminance_variance : f32, }", "cfg": [] }, { "id": "gpui::luminance::BackdropStatistics::from_encoded_texels", "name": "from_encoded_texels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Decode five RGBA8 or BGRA8 texels at `stride` byte intervals. The caller supplies the slice beginning at the probe's first texel; row padding and other probes are never included in the measurement. Panics if the slice cannot contain all five texels or stride is below four.", "documentation": "Decode five RGBA8 or BGRA8 texels at `stride` byte intervals.\nThe caller supplies the slice beginning at the probe's first texel;\nrow padding and other probes are never included in the measurement.\nPanics if the slice cannot contain all five texels or stride is below four.", "signature": "pub fn from_encoded_texels (data : & [u8], stride : usize, bgra : bool) -> Self", "cfg": [], "target": "BackdropStatistics" }, { "id": "gpui::luminance::LuminanceProbeCache", "name": "LuminanceProbeCache", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Generation- and submission-aware CPU cache shared by all glass renderers.", "documentation": "Generation- and submission-aware CPU cache shared by all glass renderers.\n\nEach frame registers only probes actually encoded for admitted surfaces.\nMissing probes immediately read `None`, including surfaces painted through\nan opaque budget fallback. Completion callbacks carry the full lease ID\nand submission sequence, not merely the physical GPU slot.", "signature": "# [doc = \" Generation- and submission-aware CPU cache shared by all glass renderers.\"] # [doc = \"\"] # [doc = \" Each frame registers only probes actually encoded for admitted surfaces.\"] # [doc = \" Missing probes immediately read `None`, including surfaces painted through\"] # [doc = \" an opaque budget fallback. Completion callbacks carry the full lease ID\"] # [doc = \" and submission sequence, not merely the physical GPU slot.\"] # [derive (Clone, Copy, Default)] pub struct LuminanceProbeCache { frame : u64, slots : [CachedProbe; MAX_LUMINANCE_PROBES], }", "cfg": [] }, { "id": "gpui::luminance::LuminanceProbeCache::begin_frame", "name": "begin_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Register a frame's encoded probe IDs, including an empty frame, and return the sequence to capture with its GPU completion. Continuous owners keep their latest completed value without waiting for the GPU.", "documentation": "Register a frame's encoded probe IDs, including an empty frame, and\nreturn the sequence to capture with its GPU completion. Continuous\nowners keep their latest completed value without waiting for the GPU.", "signature": "pub fn begin_frame (& mut self, probes : impl IntoIterator) -> u64", "cfg": [], "target": "LuminanceProbeCache" }, { "id": "gpui::luminance::LuminanceProbeCache::get", "name": "get", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Latest verified value for this exact active lease, or `None` before its first completion, after replacement, or when not submitted.", "documentation": "Latest verified value for this exact active lease, or `None` before\nits first completion, after replacement, or when not submitted.", "signature": "pub fn get (& self, id : u32) -> Option", "cfg": [], "target": "LuminanceProbeCache" }, { "id": "gpui::luminance::LuminanceProbeCache::publish", "name": "publish", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Publish a completed sample only for its still-active owner and activation. Late older submissions cannot overwrite a newer sample; an older frame of the same continuously active owner remains usable.", "documentation": "Publish a completed sample only for its still-active owner and\nactivation. Late older submissions cannot overwrite a newer sample;\nan older frame of the same continuously active owner remains usable.", "signature": "pub fn publish (& mut self, frame : u64, id : u32, luminance : f32)", "cfg": [], "target": "LuminanceProbeCache" }, { "id": "gpui::luminance::LuminanceProbeCache::publish_statistics", "name": "publish_statistics", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Publish statistics atomically with their legacy mean, using the same owner, activation, and completion-order checks as scalar readings.", "documentation": "Publish statistics atomically with their legacy mean, using the same\nowner, activation, and completion-order checks as scalar readings.", "signature": "pub fn publish_statistics (& mut self, frame : u64, id : u32, statistics : BackdropStatistics)", "cfg": [], "target": "LuminanceProbeCache" }, { "id": "gpui::luminance::LuminanceProbeCache::statistics", "name": "statistics", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Latest statistics for the exact active lease, with the same freshness rules as [`Self::get`]. A scalar-only publication has no statistics.", "documentation": "Latest statistics for the exact active lease, with the same freshness\nrules as [`Self::get`]. A scalar-only publication has no statistics.", "signature": "pub fn statistics (& self, id : u32) -> Option", "cfg": [], "target": "LuminanceProbeCache" }, { "id": "gpui::luminance::LuminanceProbeLease", "name": "LuminanceProbeLease", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "A lazy, exclusive claim on one backdrop luminance readback slot.", "documentation": "A lazy, exclusive claim on one backdrop luminance readback slot.\n\nPass [`Self::id`] to [`crate::GlassMaterial::probe`] and\n[`crate::Window::backdrop_luminance`], retaining the lease while using it.\nIDs are opaque: their low **4 bits** address a physical GPU slot and their\nhigh **28 bits** are a per-slot generation. Reacquisition advances that\ngeneration, so a new owner cannot read an old owner's cached sample.\n\nGenerations never wrap. At exhaustion the slot is permanently retired;\nthe all-ones [`NO_LUMINANCE_PROBE`] ID is never issued. Exhaustion therefore\nmakes probes unavailable instead of aliasing an old ID. Allocation remains\nprocess-wide and conservative across windows, as each renderer has its own\ncache. The ID is valid only while its lease is alive.", "signature": "# [doc = \" A lazy, exclusive claim on one backdrop luminance readback slot.\"] # [doc = \"\"] # [doc = \" Pass [`Self::id`] to [`crate::GlassMaterial::probe`] and\"] # [doc = \" [`crate::Window::backdrop_luminance`], retaining the lease while using it.\"] # [doc = \" IDs are opaque: their low **4 bits** address a physical GPU slot and their\"] # [doc = \" high **28 bits** are a per-slot generation. Reacquisition advances that\"] # [doc = \" generation, so a new owner cannot read an old owner's cached sample.\"] # [doc = \"\"] # [doc = \" Generations never wrap. At exhaustion the slot is permanently retired;\"] # [doc = \" the all-ones [`NO_LUMINANCE_PROBE`] ID is never issued. Exhaustion therefore\"] # [doc = \" makes probes unavailable instead of aliasing an old ID. Allocation remains\"] # [doc = \" process-wide and conservative across windows, as each renderer has its own\"] # [doc = \" cache. The ID is valid only while its lease is alive.\"] # [derive (Debug, Default)] pub struct LuminanceProbeLease (Option);", "cfg": [] }, { "id": "gpui::luminance::LuminanceProbeLease::id", "name": "id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Return this lease's opaque ID, claiming a free slot on first use. Return `None` when all physical slots are leased or retired; a later call retries if the lease has not acquired a slot yet.", "documentation": "Return this lease's opaque ID, claiming a free slot on first use.\nReturn `None` when all physical slots are leased or retired; a later\ncall retries if the lease has not acquired a slot yet.", "signature": "pub fn id (& mut self) -> Option", "cfg": [], "target": "LuminanceProbeLease" }, { "id": "gpui::luminance::luminance_probe_slot", "name": "luminance_probe_slot", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "luminance", "path": "gpui::luminance", "source": "crates/gpui/src/luminance.rs", "summary": "Decode only the physical readback index, never the cache's ownership key. The no-probe sentinel has no slot. GPU texture/buffer sizes remain fixed.", "documentation": "Decode only the physical readback index, never the cache's ownership key.\nThe no-probe sentinel has no slot. GPU texture/buffer sizes remain fixed.", "signature": "pub fn luminance_probe_slot (id : u32) -> Option", "cfg": [] }, { "id": "gpui::paint_recording::PaintMark", "name": "PaintMark", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "paint_recording", "path": "gpui::paint_recording", "source": "crates/gpui/src/paint_recording.rs", "summary": "A paint-phase position, usable only in the same window and scene epoch. Take this immediately before painting the live subtree.", "documentation": "A paint-phase position, usable only in the same window and scene epoch.\nTake this immediately before painting the live subtree.", "signature": "# [doc = \" A paint-phase position, usable only in the same window and scene epoch.\"] # [doc = \" Take this immediately before painting the live subtree.\"] pub struct PaintMark { pub (crate) epoch : Arc<()>, pub (crate) start : usize, pub (crate) window : WindowId, pub (crate) scale : f32, pub (crate) platform_views : usize, pub (crate) resource_revision : u64, pub (crate) transform : crate::VisualTransform, pub (crate) opacity : f32, pub (crate) layers : Vec>, }", "cfg": [] }, { "id": "gpui::paint_recording::PaintRecording", "name": "PaintRecording", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "paint_recording", "path": "gpui::paint_recording", "source": "crates/gpui/src/paint_recording.rs", "summary": "Immutable last-live paint operations, not an element and not a screenshot.", "documentation": "Immutable last-live paint operations, not an element and not a screenshot.\n\nSupports quads/gradients, paths, shadows, underlines and leased text/image\nsprites. Replay owns no input, focus, IME, accessibility or semantic targets.\nCapture-time visible clipping is part of the picture: moving it never reveals\npixels clipped or culled during capture. Replay maps that picture from the\ncaptured ambient transform/opacity into the current scope, then intersects\ncurrent ancestor clipping. Subtree-local transforms/opacity remain frozen.\nGlass, surfaces, hosted views and deferred overlays refuse capture; frozen\ncomposited snapshots remain a separate framework gap.\n\nClones share storage. Callers must bound the number/lifetime of recordings\nand drop them on retirement completion, reinsertion and reduced motion. The\nsubmitted frame retains its resources until that frame is cleared.", "signature": "# [doc = \" Immutable last-live paint operations, not an element and not a screenshot.\"] # [doc = \"\"] # [doc = \" Supports quads/gradients, paths, shadows, underlines and leased text/image\"] # [doc = \" sprites. Replay owns no input, focus, IME, accessibility or semantic targets.\"] # [doc = \" Capture-time visible clipping is part of the picture: moving it never reveals\"] # [doc = \" pixels clipped or culled during capture. Replay maps that picture from the\"] # [doc = \" captured ambient transform/opacity into the current scope, then intersects\"] # [doc = \" current ancestor clipping. Subtree-local transforms/opacity remain frozen.\"] # [doc = \" Glass, surfaces, hosted views and deferred overlays refuse capture; frozen\"] # [doc = \" composited snapshots remain a separate framework gap.\"] # [doc = \"\"] # [doc = \" Clones share storage. Callers must bound the number/lifetime of recordings\"] # [doc = \" and drop them on retirement completion, reinsertion and reduced motion. The\"] # [doc = \" submitted frame retains its resources until that frame is cleared.\"] # [derive (Clone)] pub struct PaintRecording { pub (crate) scene : Rc, pub (crate) window : WindowId, pub (crate) scale : f32, pub (crate) transform : crate::VisualTransform, pub (crate) opacity : f32, }", "cfg": [] }, { "id": "gpui::paint_recording::PaintRecordingError", "name": "PaintRecordingError", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "paint_recording", "path": "gpui::paint_recording", "source": "crates/gpui/src/paint_recording.rs", "summary": "Capture/replay refusal. No partial recording or partially replayed subtree is returned. Callers should immediately retire unsupported content.", "documentation": "Capture/replay refusal. No partial recording or partially replayed subtree\nis returned. Callers should immediately retire unsupported content.", "signature": "# [doc = \" Capture/replay refusal. No partial recording or partially replayed subtree\"] # [doc = \" is returned. Callers should immediately retire unsupported content.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)] pub enum PaintRecordingError { # [doc = \" The mark is from another paint frame or does not name a valid range.\"] # [error (\"paint mark is stale\")] StaleMark, # [doc = \" Paint cannot cross windows.\"] # [error (\"paint recording belongs to another window\")] WindowMismatch, # [doc = \" Raster resources cannot cross display scale factors.\"] # [error (\"paint recording display scale changed\")] ScaleMismatch, # [doc = \" Device loss or atlas reset invalidated owned resources.\"] # [error (\"paint recording resources were reset\")] ResourceReset, # [doc = \" The atlas cannot retain these allocations, or they have been evicted.\"] # [error (\"atlas cannot retain the recorded tiles\")] AtlasUnsupported, # [doc = \" Glass requires a frozen composited backdrop, not live-backdrop replay.\"] # [error (\"backdrop glass requires composited snapshot capture\")] BackdropGlass, # [doc = \" Platform pixel buffers may be externally mutable.\"] # [error (\"platform surfaces cannot be frozen as paint operations\")] Surface, # [doc = \" Hosted platform views are not GPUI paint operations.\"] # [error (\"hosted platform views cannot be recorded\")] PlatformView, # [doc = \" Deferred elements paint outside the contiguous subtree paint range.\"] # [error (\"frames containing deferred draws cannot be recorded\")] DeferredDraw, # [doc = \" A range cannot close inherited layers or leave newly opened layers open.\"] # [error (\"paint recording crosses a layer boundary\")] UnbalancedLayers, # [doc = \" Edge fade is a position-dependent policy, not a uniform replay opacity.\"] # [error (\"edge-fade replay requires an explicit composited snapshot\")] EdgeFade, # [doc = \" Zero/nonfinite ambient opacity cannot be normalized for future scopes.\"] # [error (\"capture needs finite positive ambient opacity\")] InvisibleCapture, # [doc = \" Replay translations must be finite.\"] # [error (\"paint recording offset must be finite\")] InvalidOffset, # [doc = \" The normalized transform or opacity exceeded finite renderer values.\"] # [error (\"paint recording replay scope is not finite\")] InvalidReplayScope, }", "cfg": [] }, { "id": "gpui::particles::MAX_PARTICLES_PER_BATCH", "name": "MAX_PARTICLES_PER_BATCH", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Hard ceiling for one sampled particle batch.", "documentation": "Hard ceiling for one sampled particle batch.\n\nHosts that need more concurrent work should split it across the semantic\neffect budget rather than allocating an unbounded temporary instance list.", "signature": "pub const MAX_PARTICLES_PER_BATCH: u32", "cfg": [] }, { "id": "gpui::particles::ParticleEmitter", "name": "ParticleEmitter", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "One deterministic emitter sampled into atlas-backed sprite instances.", "documentation": "One deterministic emitter sampled into atlas-backed sprite instances.\n\nCoordinates are logical window pixels. Speed is pixels per second and\nacceleration is pixels per second squared. All particles share one source\nrectangle and paint mode while seed-derived values vary spawn position,\ndirection, speed, size, and initial rotation.", "signature": "# [doc = \" One deterministic emitter sampled into atlas-backed sprite instances.\"] # [doc = \"\"] # [doc = \" Coordinates are logical window pixels. Speed is pixels per second and\"] # [doc = \" acceleration is pixels per second squared. All particles share one source\"] # [doc = \" rectangle and paint mode while seed-derived values vary spawn position,\"] # [doc = \" direction, speed, size, and initial rotation.\"] # [derive (Clone, Debug, PartialEq)] pub struct ParticleEmitter { seed : u64, source : Bounds, origin : Point, spawn_area : Size, count : u32, emission_span : Duration, lifetime : Duration, direction : Radians, spread : Radians, speed_min : f32, speed_max : f32, acceleration : Point, start_size : Size, end_size : Size, size_variation : f32, initial_rotation : Radians, rotation_spread : Radians, angular_velocity : Radians, fade_in : f32, fade_out : f32, opacity : f32, corner_radii : Corners, color_mode : SpriteColorMode, blend_mode : SpriteBlendMode, tint : Hsla, }", "cfg": [] }, { "id": "gpui::particles::ParticleEmitter::acceleration", "name": "acceleration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets constant acceleration in logical pixels per second squared.", "documentation": "Sets constant acceleration in logical pixels per second squared.", "signature": "pub fn acceleration (mut self, acceleration : Point) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::blend_mode", "name": "blend_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets the fixed-function compositing equation for this emitter.", "documentation": "Sets the fixed-function compositing equation for this emitter.", "signature": "pub fn blend_mode (mut self, blend_mode : SpriteBlendMode) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::color_mode", "name": "color_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets sample-to-color conversion and the alpha-mask tint.", "documentation": "Sets sample-to-color conversion and the alpha-mask tint.", "signature": "pub fn color_mode (mut self, color_mode : SpriteColorMode, tint : Hsla) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::corner_radii", "name": "corner_radii", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets the rounded mask applied to each sampled destination.", "documentation": "Sets the rounded mask applied to each sampled destination.", "signature": "pub fn corner_radii (mut self, corner_radii : Corners) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::count", "name": "count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Returns the number of deterministic particle slots in this emitter.", "documentation": "Returns the number of deterministic particle slots in this emitter.", "signature": "pub fn count (& self) -> u32", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::direction", "name": "direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets the central direction and total angular spread in radians.", "documentation": "Sets the central direction and total angular spread in radians.", "signature": "pub fn direction (mut self, direction : Radians, spread : Radians) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::emission_span", "name": "emission_span", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Distributes births over `span`; zero makes every particle a burst.", "documentation": "Distributes births over `span`; zero makes every particle a burst.", "signature": "pub fn emission_span (mut self, span : Duration) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::fade", "name": "fade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets fade-in and fade-out shares of each particle lifetime.", "documentation": "Sets fade-in and fade-out shares of each particle lifetime.\n\nEach share is in `0.0..=1.0`; overlapping fades multiply.", "signature": "pub fn fade (mut self, fade_in : f32, fade_out : f32) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::lifetime", "name": "lifetime", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets how long each particle remains alive after its own birth.", "documentation": "Sets how long each particle remains alive after its own birth.", "signature": "pub fn lifetime (mut self, lifetime : Duration) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Creates a bounded burst from `origin` using one image source rectangle.", "documentation": "Creates a bounded burst from `origin` using one image source rectangle.\n\nThe default motion emits in all directions for 800 ms with normal color\nand source-over compositing. Builders change geometry and paint policy;\ninvalid or oversized emitters are reported atomically by\n[`crate::Window::paint_particle_batch`].", "signature": "pub fn new (seed : u64, source : Bounds, origin : Point, count : u32) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::opacity", "name": "opacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets additional emitter opacity, clamped while painting.", "documentation": "Sets additional emitter opacity, clamped while painting.", "signature": "pub fn opacity (mut self, opacity : f32) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::rotation", "name": "rotation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets initial rotation, initial random spread, and radians per second.", "documentation": "Sets initial rotation, initial random spread, and radians per second.", "signature": "pub fn rotation (mut self, initial : Radians, spread : Radians, angular_velocity : Radians,) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::size", "name": "size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets the destination size at birth and at the end of the lifetime.", "documentation": "Sets the destination size at birth and at the end of the lifetime.", "signature": "pub fn size (mut self, start : Size, end : Size) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::size_variation", "name": "size_variation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Varies both dimensions by up to `fraction` around their sampled size.", "documentation": "Varies both dimensions by up to `fraction` around their sampled size.\n\nValid fractions are in `0.0..=1.0`.", "signature": "pub fn size_variation (mut self, fraction : f32) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::spawn_area", "name": "spawn_area", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Spreads spawn points uniformly across a rectangle centered on `origin`.", "documentation": "Spreads spawn points uniformly across a rectangle centered on `origin`.", "signature": "pub fn spawn_area (mut self, area : Size) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::speed", "name": "speed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Sets the inclusive initial speed range in logical pixels per second.", "documentation": "Sets the inclusive initial speed range in logical pixels per second.", "signature": "pub fn speed (mut self, min : f32, max : f32) -> Self", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::particles::ParticleEmitter::total_duration", "name": "total_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "particles", "path": "gpui::particles", "source": "crates/gpui/src/particles.rs", "summary": "Returns the time from the first birth until the final particle expires.", "documentation": "Returns the time from the first birth until the final particle expires.", "signature": "pub fn total_duration (& self) -> Duration", "cfg": [], "target": "ParticleEmitter" }, { "id": "gpui::path_builder::PathBuilder", "name": "PathBuilder", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "A [`Path`] builder.", "documentation": "A [`Path`] builder.", "signature": "# [doc = \" A [`Path`] builder.\"] pub struct PathBuilder { raw : lyon::path::builder::WithSvg, transform : Option, # [doc = \" PathStyle of the PathBuilder\"] pub style : PathStyle, dash_array : Option>, dash_offset : Pixels, stroke_trim : (f32, f32), }", "cfg": [] }, { "id": "gpui::path_builder::PathBuilder::add_polygon", "name": "add_polygon", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Adds a polygon.", "documentation": "Adds a polygon.", "signature": "pub fn add_polygon (& mut self, points : & [Point], closed : bool)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::arc_to", "name": "arc_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Adds an elliptical arc.", "documentation": "Adds an elliptical arc.", "signature": "pub fn arc_to (& mut self, radii : Point, x_rotation : Pixels, large_arc : bool, sweep : bool, to : Point,)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::build", "name": "build", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Builds into a [`Path`].", "documentation": "Builds into a [`Path`].", "signature": "pub fn build (self) -> Result, Error>", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::build_path", "name": "build_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Builds a [`Path`] from a [`lyon::tessellation::VertexBuffers`].", "documentation": "Builds a [`Path`] from a [`lyon::tessellation::VertexBuffers`].", "signature": "pub fn build_path (buf : VertexBuffers) -> Path", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::close", "name": "close", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Close the current sub-path.", "documentation": "Close the current sub-path.", "signature": "pub fn close (& mut self)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::cubic_bezier_to", "name": "cubic_bezier_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Adds a cubic Bézier to the [`Path`] given its two control points and its end point.", "documentation": "Adds a cubic Bézier to the [`Path`] given its two control points\nand its end point.", "signature": "pub fn cubic_bezier_to (& mut self, to : Point, control_a : Point, control_b : Point,)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::curve_to", "name": "curve_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Draw a curve from the current point to the given point, using the given control point.", "documentation": "Draw a curve from the current point to the given point, using the given control point.", "signature": "pub fn curve_to (& mut self, to : Point, ctrl : Point)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::dash_array", "name": "dash_array", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Sets the dash array of the [`PathBuilder`].", "documentation": "Sets the dash array of the [`PathBuilder`].\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/SVG/Reference/Attribute/stroke-dasharray)", "signature": "pub fn dash_array (mut self, dash_array : & [Pixels]) -> Self", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::dash_offset", "name": "dash_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Advances the dash pattern by this distance at the start of the path.", "documentation": "Advances the dash pattern by this distance at the start of the path.\n\nSampling a changing offset produces a travelling trace without callers\nsplitting the path into short line elements. Negative and oversized\nvalues wrap around the complete dash pattern.", "signature": "pub fn dash_offset (mut self, offset : Pixels) -> Self", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::fill", "name": "fill", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Creates a new [`PathBuilder`] to build a Fill path.", "documentation": "Creates a new [`PathBuilder`] to build a Fill path.", "signature": "pub fn fill () -> Self", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::line_to", "name": "line_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Draw a straight line from the current point to the given point.", "documentation": "Draw a straight line from the current point to the given point.", "signature": "pub fn line_to (& mut self, to : Point)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::move_to", "name": "move_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Move the current point to the given point.", "documentation": "Move the current point to the given point.", "signature": "pub fn move_to (& mut self, to : Point)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::relative_arc_to", "name": "relative_arc_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Equivalent to `arc_to` in relative coordinates.", "documentation": "Equivalent to `arc_to` in relative coordinates.", "signature": "pub fn relative_arc_to (& mut self, radii : Point, x_rotation : Pixels, large_arc : bool, sweep : bool, to : Point,)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::rotate", "name": "rotate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Applies a rotation to the path.", "documentation": "Applies a rotation to the path.\n\nThe `angle` is in degrees value in the range 0.0 to 360.0.", "signature": "pub fn rotate (& mut self, angle : f32)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Applies a scale to the path.", "documentation": "Applies a scale to the path.", "signature": "pub fn scale (& mut self, scale : f32)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::stroke", "name": "stroke", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Creates a new [`PathBuilder`] to build a Stroke path.", "documentation": "Creates a new [`PathBuilder`] to build a Stroke path.", "signature": "pub fn stroke (width : Pixels) -> Self", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::stroke_trim", "name": "stroke_trim", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Keeps one normalized interval of a stroked path.", "documentation": "Keeps one normalized interval of a stroked path.\n\n`0.0..1.0` is the full measured path. Sampling the end from zero to one\nreveals a stroke while preserving its actual curves, joins, caps, dash\nphase, clipping, and gradient paint. The interval is applied before\nstroke tessellation and is ignored by fill builders.", "signature": "pub fn stroke_trim (mut self, start : f32, end : f32) -> Self", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::transform", "name": "transform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Applies a transform to the path.", "documentation": "Applies a transform to the path.", "signature": "pub fn transform (& mut self, transform : Transform)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::translate", "name": "translate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Applies a translation to the path.", "documentation": "Applies a translation to the path.", "signature": "pub fn translate (& mut self, to : Point)", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathBuilder::with_style", "name": "with_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Sets the style of the [`PathBuilder`].", "documentation": "Sets the style of the [`PathBuilder`].", "signature": "pub fn with_style (self, style : PathStyle) -> Self", "cfg": [], "target": "PathBuilder" }, { "id": "gpui::path_builder::PathStyle", "name": "PathStyle", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "Style of the PathBuilder", "documentation": "Style of the PathBuilder", "signature": "# [doc = \" Style of the PathBuilder\"] pub enum PathStyle { # [doc = \" Stroke style\"] Stroke (StrokeOptions), # [doc = \" Fill style\"] Fill (FillOptions), }", "cfg": [] }, { "id": "gpui::path_builder::reexport-1", "name": "lyon :: math :: Transform", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "", "documentation": "", "signature": "pub use lyon::math::Transform;", "cfg": [] }, { "id": "gpui::path_builder::reexport-2", "name": "lyon :: tessellation :: { FillOptions , FillRule , StrokeOptions }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "path_builder", "path": "gpui::path_builder", "source": "crates/gpui/src/path_builder.rs", "summary": "", "documentation": "", "signature": "pub use lyon::tessellation::{ FillOptions, FillRule, StrokeOptions };", "cfg": [] }, { "id": "gpui::platform::A11yCallbacks", "name": "A11yCallbacks", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Callbacks for the accessibility adapter.", "documentation": "Callbacks for the accessibility adapter.", "signature": "# [doc = \" Callbacks for the accessibility adapter.\"] pub struct A11yCallbacks { # [doc = \" Called when the adapter is activated (a screen reader connects).\"] pub activation : Box Option + Send + 'static>, # [doc = \" Called when an action is requested by the screen reader.\"] pub action : Box, # [doc = \" Called when the adapter is deactivated (screen reader disconnects).\"] pub deactivation : Box, }", "cfg": [] }, { "id": "gpui::platform::AppLifecyclePhase", "name": "AppLifecyclePhase", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The application's lifecycle phase, as owned and reported by a mobile OS.", "documentation": "The application's lifecycle phase, as owned and reported by a mobile OS.\n\n`Inactive` means visible but not receiving input (a system dialog on\ntop), while `Background` means not visible at all, with process death\npossible at any time thereafter.\n\n| Phase | iOS | Android |\n|--------------|------------------------------|--------------|\n| `Active` | `didBecomeActive` | `onResume` |\n| `Inactive` | `willResignActive` | `onPause` |\n| `Background` | `didEnterBackground` | `onStop` |\n| `Foreground` | `willEnterForeground` | `onStart` |", "signature": "# [doc = \" The application's lifecycle phase, as owned and reported by a mobile OS.\"] # [doc = \"\"] # [doc = \" `Inactive` means visible but not receiving input (a system dialog on\"] # [doc = \" top), while `Background` means not visible at all, with process death\"] # [doc = \" possible at any time thereafter.\"] # [doc = \"\"] # [doc = \" | Phase | iOS | Android |\"] # [doc = \" |--------------|------------------------------|--------------|\"] # [doc = \" | `Active` | `didBecomeActive` | `onResume` |\"] # [doc = \" | `Inactive` | `willResignActive` | `onPause` |\"] # [doc = \" | `Background` | `didEnterBackground` | `onStop` |\"] # [doc = \" | `Foreground` | `willEnterForeground` | `onStart` |\"] # [derive (Debug, Copy, Clone, Eq, PartialEq, Hash)] pub enum AppLifecyclePhase { # [doc = \" Foreground and receiving input.\"] Active, # [doc = \" Foreground (visible) but not receiving input.\"] Inactive, # [doc = \" Not visible. The GPU surface may be destroyed while backgrounded and\"] # [doc = \" the process may be killed without further notice.\"] Background, # [doc = \" Becoming visible again, before input is restored.\"] Foreground, }", "cfg": [] }, { "id": "gpui::platform::AppOperation", "name": "AppOperation", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Application commands whose availability depends on the native host.", "documentation": "Application commands whose availability depends on the native host.", "signature": "# [doc = \" Application commands whose availability depends on the native host.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq)] pub enum AppOperation { # [doc = \" End the application process through the native host.\"] Quit, # [doc = \" Relaunch the application process.\"] Restart, # [doc = \" Hide this application.\"] Hide, # [doc = \" Hide other applications.\"] HideOtherApps, # [doc = \" Unhide other applications.\"] UnhideOtherApps, # [doc = \" Reveal a filesystem path in a native file manager.\"] RevealPath, # [doc = \" Open a filesystem path with its default application.\"] OpenWithSystem, # [doc = \" Install an application dock menu.\"] SetDockMenu, # [doc = \" Set the native pointer cursor style.\"] SetCursorStyle, # [doc = \" Hide the native pointer cursor until mouse movement.\"] HideCursorUntilMouseMoves, }", "cfg": [] }, { "id": "gpui::platform::AtlasKey", "name": "AtlasKey", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [derive (PartialEq, Eq, Hash, Clone)] # [expect (missing_docs)] pub enum AtlasKey { Glyph (RenderGlyphParams), Svg (RenderSvgParams), Image (RenderImageParams), }", "cfg": [] }, { "id": "gpui::platform::AtlasKey::texture_kind", "name": "texture_kind", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns the texture kind for this atlas key.", "documentation": "Returns the texture kind for this atlas key.", "signature": "pub fn texture_kind (& self) -> AtlasTextureKind", "cfg": [], "target": "AtlasKey" }, { "id": "gpui::platform::AtlasTextureId", "name": "AtlasTextureId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug, PartialEq, Eq, Hash)] # [repr (C)] # [expect (missing_docs)] pub struct AtlasTextureId { # [doc = \" The index of this texture in the atlas.\"] pub index : u32, # [doc = \" The kind of content stored in this texture.\"] pub kind : AtlasTextureKind, }", "cfg": [] }, { "id": "gpui::platform::AtlasTextureKind", "name": "AtlasTextureKind", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug, PartialEq, Eq, Hash)] # [repr (C)] # [cfg_attr (all (any (target_os = \"linux\", target_os = \"freebsd\"), not (any (feature = \"x11\", feature = \"wayland\"))), allow (dead_code))] # [expect (missing_docs)] pub enum AtlasTextureKind { Monochrome = 0, Polychrome = 1, Subpixel = 2, }", "cfg": [] }, { "id": "gpui::platform::AtlasTextureList", "name": "AtlasTextureList", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct AtlasTextureList { pub textures : Vec>, pub free_list : Vec, }", "cfg": [] }, { "id": "gpui::platform::AtlasTextureList::drain", "name": "drain", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn drain (& mut self) -> std::vec::Drain<'_, Option>", "cfg": [], "target": "AtlasTextureList" }, { "id": "gpui::platform::AtlasTextureList::iter_mut", "name": "iter_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn iter_mut (& mut self) -> impl DoubleEndedIterator", "cfg": [], "target": "AtlasTextureList" }, { "id": "gpui::platform::AtlasTile", "name": "AtlasTile", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [derive (Copy, Clone, Debug, PartialEq, Eq)] # [repr (C)] # [expect (missing_docs)] pub struct AtlasTile { # [doc = \" The texture this tile belongs to.\"] pub texture_id : AtlasTextureId, # [doc = \" The unique ID of this tile within its texture.\"] pub tile_id : TileId, # [doc = \" Padding around the tile content in pixels.\"] pub padding : u32, # [doc = \" The bounds of this tile within the texture.\"] pub bounds : Bounds, }", "cfg": [] }, { "id": "gpui::platform::AutofillPurpose", "name": "AutofillPurpose", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Semantic autofill hint. Availability depends on the platform and user settings; OneTimeCode neither reads SMS nor guarantees code retrieval.", "documentation": "Semantic autofill hint. Availability depends on the platform and user\nsettings; OneTimeCode neither reads SMS nor guarantees code retrieval.", "signature": "# [doc = \" Semantic autofill hint. Availability depends on the platform and user\"] # [doc = \" settings; OneTimeCode neither reads SMS nor guarantees code retrieval.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq)] pub enum AutofillPurpose { # [doc = \" Person's full name.\"] Name, # [doc = \" Account username.\"] Username, # [doc = \" Existing account password.\"] CurrentPassword, # [doc = \" Newly chosen password.\"] NewPassword, # [doc = \" Email address.\"] Email, # [doc = \" Telephone number.\"] Phone, # [doc = \" One-time verification code.\"] OneTimeCode, }", "cfg": [] }, { "id": "gpui::platform::ClipboardEntry", "name": "ClipboardEntry", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Either a ClipboardString or a ClipboardImage", "documentation": "Either a ClipboardString or a ClipboardImage", "signature": "# [doc = \" Either a ClipboardString or a ClipboardImage\"] # [derive (Clone, Debug, Eq, PartialEq)] pub enum ClipboardEntry { # [doc = \" A string entry\"] String (ClipboardString), # [doc = \" An image entry\"] Image (Image), # [doc = \" A file entry\"] ExternalPaths (crate::ExternalPaths), }", "cfg": [] }, { "id": "gpui::platform::ClipboardItem", "name": "ClipboardItem", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A clipboard item that should be copied to the clipboard", "documentation": "A clipboard item that should be copied to the clipboard", "signature": "# [doc = \" A clipboard item that should be copied to the clipboard\"] # [derive (Clone, Debug, Eq, PartialEq)] pub struct ClipboardItem { # [doc = \" The entries in this clipboard item.\"] pub entries : Vec, }", "cfg": [] }, { "id": "gpui::platform::ClipboardItem::entries", "name": "entries", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get the item's entries", "documentation": "Get the item's entries", "signature": "pub fn entries (& self) -> & [ClipboardEntry]", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::into_entries", "name": "into_entries", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get owned versions of the item's entries", "documentation": "Get owned versions of the item's entries", "signature": "pub fn into_entries (self) -> impl Iterator", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::metadata", "name": "metadata", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "If this item is one ClipboardEntry::String, returns its metadata.", "documentation": "If this item is one ClipboardEntry::String, returns its metadata.", "signature": "pub fn metadata (& self) -> Option<& String>", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::new_image", "name": "new_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a new ClipboardItem::Image with the given image with no associated metadata", "documentation": "Create a new ClipboardItem::Image with the given image with no associated metadata", "signature": "pub fn new_image (image : & Image) -> Self", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::new_string", "name": "new_string", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a new ClipboardItem::String with no associated metadata", "documentation": "Create a new ClipboardItem::String with no associated metadata", "signature": "pub fn new_string (text : String) -> Self", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::new_string_with_json_metadata", "name": "new_string_with_json_metadata", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a new ClipboardItem::String with the given text and associated metadata", "documentation": "Create a new ClipboardItem::String with the given text and associated metadata", "signature": "pub fn new_string_with_json_metadata (text : String, metadata : T) -> Self", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::new_string_with_metadata", "name": "new_string_with_metadata", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a new ClipboardItem::String with the given text and associated metadata", "documentation": "Create a new ClipboardItem::String with the given text and associated metadata", "signature": "pub fn new_string_with_metadata (text : String, metadata : String) -> Self", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardItem::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Concatenates together all the ClipboardString entries in the item. Returns None if there were no ClipboardString entries.", "documentation": "Concatenates together all the ClipboardString entries in the item.\nReturns None if there were no ClipboardString entries.", "signature": "pub fn text (& self) -> Option", "cfg": [], "target": "ClipboardItem" }, { "id": "gpui::platform::ClipboardString", "name": "ClipboardString", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A clipboard item that should be copied to the clipboard", "documentation": "A clipboard item that should be copied to the clipboard", "signature": "# [doc = \" A clipboard item that should be copied to the clipboard\"] # [derive (Clone, Debug, Eq, PartialEq)] pub struct ClipboardString { # [doc = \" The text content.\"] pub text : String, # [doc = \" Optional metadata associated with this clipboard string.\"] pub metadata : Option, }", "cfg": [] }, { "id": "gpui::platform::ClipboardString::into_text", "name": "into_text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get the owned text of the clipboard string", "documentation": "Get the owned text of the clipboard string", "signature": "pub fn into_text (self) -> String", "cfg": [], "target": "ClipboardString" }, { "id": "gpui::platform::ClipboardString::metadata_json", "name": "metadata_json", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get the metadata of the clipboard string, formatted as JSON", "documentation": "Get the metadata of the clipboard string, formatted as JSON", "signature": "pub fn metadata_json (& self) -> Option where T : for<'a> Deserialize<'a>,", "cfg": [], "target": "ClipboardString" }, { "id": "gpui::platform::ClipboardString::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a new clipboard string with the given text", "documentation": "Create a new clipboard string with the given text", "signature": "pub fn new (text : String) -> Self", "cfg": [], "target": "ClipboardString" }, { "id": "gpui::platform::ClipboardString::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get the text of the clipboard string", "documentation": "Get the text of the clipboard string", "signature": "pub fn text (& self) -> & String", "cfg": [], "target": "ClipboardString" }, { "id": "gpui::platform::ClipboardString::text_hash", "name": "text_hash", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Compute a hash of the given text for clipboard change detection.", "documentation": "Compute a hash of the given text for clipboard change detection.", "signature": "pub fn text_hash (text : & str) -> u64", "cfg": [], "target": "ClipboardString" }, { "id": "gpui::platform::ClipboardString::with_json_metadata", "name": "with_json_metadata", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Return a new clipboard item with the metadata replaced by the given metadata, after serializing it as JSON.", "documentation": "Return a new clipboard item with the metadata replaced by the given metadata,\nafter serializing it as JSON.", "signature": "pub fn with_json_metadata (mut self, metadata : T) -> Self", "cfg": [], "target": "ClipboardString" }, { "id": "gpui::platform::CursorStyle", "name": "CursorStyle", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The style of the cursor (pointer)", "documentation": "The style of the cursor (pointer)", "signature": "# [doc = \" The style of the cursor (pointer)\"] # [derive (Copy, Clone, Default, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)] pub enum CursorStyle { # [doc = \" The default cursor\"] # [default] Arrow, # [doc = \" A text input cursor\"] # [doc = \" corresponds to the CSS cursor value `text`\"] IBeam, # [doc = \" A crosshair cursor\"] # [doc = \" corresponds to the CSS cursor value `crosshair`\"] Crosshair, # [doc = \" A closed hand cursor\"] # [doc = \" corresponds to the CSS cursor value `grabbing`\"] ClosedHand, # [doc = \" An open hand cursor\"] # [doc = \" corresponds to the CSS cursor value `grab`\"] OpenHand, # [doc = \" A pointing hand cursor\"] # [doc = \" corresponds to the CSS cursor value `pointer`\"] PointingHand, # [doc = \" A resize left cursor\"] # [doc = \" corresponds to the CSS cursor value `w-resize`\"] ResizeLeft, # [doc = \" A resize right cursor\"] # [doc = \" corresponds to the CSS cursor value `e-resize`\"] ResizeRight, # [doc = \" A resize cursor to the left and right\"] # [doc = \" corresponds to the CSS cursor value `ew-resize`\"] ResizeLeftRight, # [doc = \" A resize up cursor\"] # [doc = \" corresponds to the CSS cursor value `n-resize`\"] ResizeUp, # [doc = \" A resize down cursor\"] # [doc = \" corresponds to the CSS cursor value `s-resize`\"] ResizeDown, # [doc = \" A resize cursor directing up and down\"] # [doc = \" corresponds to the CSS cursor value `ns-resize`\"] ResizeUpDown, # [doc = \" A resize cursor directing up-left and down-right\"] # [doc = \" corresponds to the CSS cursor value `nesw-resize`\"] ResizeUpLeftDownRight, # [doc = \" A resize cursor directing up-right and down-left\"] # [doc = \" corresponds to the CSS cursor value `nwse-resize`\"] ResizeUpRightDownLeft, # [doc = \" A cursor indicating that the item/column can be resized horizontally.\"] # [doc = \" corresponds to the CSS cursor value `col-resize`\"] ResizeColumn, # [doc = \" A cursor indicating that the item/row can be resized vertically.\"] # [doc = \" corresponds to the CSS cursor value `row-resize`\"] ResizeRow, # [doc = \" A text input cursor for vertical layout\"] # [doc = \" corresponds to the CSS cursor value `vertical-text`\"] IBeamCursorForVerticalLayout, # [doc = \" A cursor indicating that the operation is not allowed\"] # [doc = \" corresponds to the CSS cursor value `not-allowed`\"] OperationNotAllowed, # [doc = \" A cursor indicating that the operation will result in a link\"] # [doc = \" corresponds to the CSS cursor value `alias`\"] DragLink, # [doc = \" A cursor indicating that the operation will result in a copy\"] # [doc = \" corresponds to the CSS cursor value `copy`\"] DragCopy, # [doc = \" A cursor indicating that the operation will result in a context menu\"] # [doc = \" corresponds to the CSS cursor value `context-menu`\"] ContextualMenu, }", "cfg": [] }, { "id": "gpui::platform::DEFAULT_GRAYSCALE_ENHANCED_CONTRAST", "name": "DEFAULT_GRAYSCALE_ENHANCED_CONTRAST", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Contrast boost applied to dark grayscale foregrounds.", "documentation": "Contrast boost applied to dark grayscale foregrounds.\n\nMatches the WGPU fallback. DirectWrite supplies its own value on Windows.", "signature": "pub const DEFAULT_GRAYSCALE_ENHANCED_CONTRAST: f32", "cfg": [] }, { "id": "gpui::platform::DEFAULT_SUBPIXEL_ENHANCED_CONTRAST", "name": "DEFAULT_SUBPIXEL_ENHANCED_CONTRAST", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Contrast boost applied to subpixel coverage.", "documentation": "Contrast boost applied to subpixel coverage.\n\nUnused on macOS, which stays grayscale-only. Matches the WGPU fallback.", "signature": "pub const DEFAULT_SUBPIXEL_ENHANCED_CONTRAST: f32", "cfg": [] }, { "id": "gpui::platform::DEFAULT_TEXT_GAMMA", "name": "DEFAULT_TEXT_GAMMA", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Default glyph-compositing gamma when the platform does not report one.", "documentation": "Default glyph-compositing gamma when the platform does not report one.\n\nMatches the WGPU fallback and the historical DirectWrite 1.8 default.", "signature": "pub const DEFAULT_TEXT_GAMMA: f32", "cfg": [] }, { "id": "gpui::platform::Decorations", "name": "Decorations", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A type to describe how this window is currently configured", "documentation": "A type to describe how this window is currently configured", "signature": "# [doc = \" A type to describe how this window is currently configured\"] # [derive (Debug, Copy, Clone, Eq, PartialEq, Hash, Default)] pub enum Decorations { # [doc = \" The window is configured to use server side decorations\"] # [default] Server, # [doc = \" The window is configured to use client side decorations\"] Client { # [doc = \" The edge tiling state\"] tiling : Tiling, }, }", "cfg": [] }, { "id": "gpui::platform::DisplayId", "name": "DisplayId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "An opaque identifier for a hardware display", "documentation": "An opaque identifier for a hardware display", "signature": "# [doc = \" An opaque identifier for a hardware display\"] # [derive (PartialEq, Eq, Hash, Copy, Clone)] pub struct DisplayId (pub (crate) u64);", "cfg": [] }, { "id": "gpui::platform::DisplayId::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a new `DisplayId` from a raw platform display identifier.", "documentation": "Create a new `DisplayId` from a raw platform display identifier.", "signature": "pub fn new (id : u64) -> Self", "cfg": [], "target": "DisplayId" }, { "id": "gpui::platform::Image", "name": "Image", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "An image, with a format and certain bytes", "documentation": "An image, with a format and certain bytes", "signature": "# [doc = \" An image, with a format and certain bytes\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct Image { # [doc = \" The image format the bytes represent (e.g. PNG)\"] pub format : ImageFormat, # [doc = \" The raw image bytes\"] pub bytes : Vec, # [doc = \" The unique ID for the image\"] pub id : u64, }", "cfg": [] }, { "id": "gpui::platform::Image::bytes", "name": "bytes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get the raw bytes of the clipboard image", "documentation": "Get the raw bytes of the clipboard image", "signature": "pub fn bytes (& self) -> & [u8]", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::empty", "name": "empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "An empty image containing no data", "documentation": "An empty image containing no data", "signature": "pub fn empty () -> Self", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::format", "name": "format", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get the format of the clipboard image", "documentation": "Get the format of the clipboard image", "signature": "pub fn format (& self) -> ImageFormat", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::from_bytes", "name": "from_bytes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create an image from a format and bytes", "documentation": "Create an image from a format and bytes", "signature": "pub fn from_bytes (format : ImageFormat, bytes : Vec) -> Self", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::get_render_image", "name": "get_render_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Use the GPUI `get_asset` API to make this image renderable", "documentation": "Use the GPUI `get_asset` API to make this image renderable", "signature": "pub fn get_render_image (self : Arc, window : & mut Window, cx : & mut App,) -> Option>", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::id", "name": "id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Get this image's ID", "documentation": "Get this image's ID", "signature": "pub fn id (& self) -> u64", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::is_asset_cached", "name": "is_asset_cached", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Check whether this image is present in GPUI's asset cache (loading or loaded), without fetching it.", "documentation": "Check whether this image is present in GPUI's asset cache (loading or\nloaded), without fetching it.", "signature": "pub fn is_asset_cached (self : & Arc, cx : & App) -> bool", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Image" }, { "id": "gpui::platform::Image::remove_asset", "name": "remove_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Use the GPUI `remove_asset` API to drop this image, if possible.", "documentation": "Use the GPUI `remove_asset` API to drop this image, if possible.", "signature": "pub fn remove_asset (self : Arc, cx : & mut App)", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::to_image_data", "name": "to_image_data", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Convert the clipboard image to an `ImageData` object.", "documentation": "Convert the clipboard image to an `ImageData` object.", "signature": "pub fn to_image_data (& self, svg_renderer : SvgRenderer) -> Result>", "cfg": [], "target": "Image" }, { "id": "gpui::platform::Image::use_render_image", "name": "use_render_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Use the GPUI `use_asset` API to make this image renderable", "documentation": "Use the GPUI `use_asset` API to make this image renderable", "signature": "pub fn use_render_image (self : Arc, window : & mut Window, cx : & mut App,) -> Option>", "cfg": [], "target": "Image" }, { "id": "gpui::platform::ImageFormat", "name": "ImageFormat", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "One of the editor's supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard", "documentation": "One of the editor's supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard", "signature": "# [doc = \" One of the editor's supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard\"] # [derive (Clone, Copy, Debug, Eq, PartialEq, EnumIter, Hash)] pub enum ImageFormat { # [doc = \" .png\"] Png, # [doc = \" .jpeg or .jpg\"] Jpeg, # [doc = \" .webp\"] Webp, # [doc = \" .gif\"] Gif, # [doc = \" .svg\"] Svg, # [doc = \" .bmp\"] Bmp, # [doc = \" .tif or .tiff\"] Tiff, # [doc = \" .ico\"] Ico, # [doc = \" Netpbm image formats (.pbm, .ppm, .pgm).\"] Pnm, }", "cfg": [] }, { "id": "gpui::platform::ImageFormat::extension", "name": "extension", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns the file extension for this image format (without leading dot).", "documentation": "Returns the file extension for this image format (without leading dot).", "signature": "pub const fn extension (self) -> & 'static str", "cfg": [], "target": "ImageFormat" }, { "id": "gpui::platform::ImageFormat::from_mime_type", "name": "from_mime_type", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns the ImageFormat for the given mime type, including known aliases.", "documentation": "Returns the ImageFormat for the given mime type, including known aliases.", "signature": "pub fn from_mime_type (mime_type : & str) -> Option", "cfg": [], "target": "ImageFormat" }, { "id": "gpui::platform::ImageFormat::mime_type", "name": "mime_type", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns the mime type for the ImageFormat", "documentation": "Returns the mime type for the ImageFormat", "signature": "pub const fn mime_type (self) -> & 'static str", "cfg": [], "target": "ImageFormat" }, { "id": "gpui::platform::InputHandler", "name": "InputHandler", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Zed's interface for handling text input from the platform's IME system This is currently a 1:1 exposure of the NSTextInputClient API:", "documentation": "Zed's interface for handling text input from the platform's IME system\nThis is currently a 1:1 exposure of the NSTextInputClient API:\n\n", "signature": "# [doc = \" Zed's interface for handling text input from the platform's IME system\"] # [doc = \" This is currently a 1:1 exposure of the NSTextInputClient API:\"] # [doc = \"\"] # [doc = \" \"] pub trait InputHandler : 'static { # [doc = \" Query both primary selection endpoints atomically, preserving visual\"] # [doc = \" affinity even when offsets coincide. None means unsupported, not empty.\"] fn native_selection (& mut self, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" Atomically apply primary anchor/head offsets and affinities to the\"] # [doc = \" caller-owned edit model. Return false on unsupported/invalid requests;\"] # [doc = \" do not change the range and then separately patch cached affinity.\"] fn set_native_selection (& mut self, _selection : crate::NativeTextSelection, _window : & mut Window, _cx : & mut App,) -> bool { false } # [doc = \" Navigate physical caret stops while preserving bidi/wrap affinity.\"] # [doc = \" Unlike offset-only navigation, two positions at one UTF-16 index may\"] # [doc = \" remain distinct. None means unavailable; never invent downstream affinity.\"] fn native_position_in_direction (& mut self, _position : crate::NativeTextPosition, _direction : crate::TextNavigationDirection, _offset : usize, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" Painted caret geometry for the exact UTF-16 index and affinity.\"] fn native_position_bounds (& mut self, _position : crate::NativeTextPosition, _window : & mut Window, _cx : & mut App,) -> Option> { None } # [doc = \" Nearest painted caret to a logical window point, retaining visual affinity.\"] # [doc = \" When supplied, the UTF-16 range restricts eligible caret stops before\"] # [doc = \" comparing geometry; never clamp the resulting logical offset afterward.\"] # [doc = \" Return unavailable when geometry or an eligible stop is unavailable.\"] fn native_position_for_point (& mut self, _point : Point, _within_range : Option>, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" Physical farthest caret in a UTF-16 range, retaining incident affinity.\"] fn farthest_native_position (& mut self, _range : Range, _direction : crate::TextNavigationDirection, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" Painted selection fragments for a UTF-16 range, in logical window\"] # [doc = \" coordinates. Return empty when geometry is unavailable. Never replace\"] # [doc = \" bidirectional fragments with a guessed union rectangle.\"] fn selection_rects_for_range (& mut self, _range : Range, _window : & mut Window, _cx : & mut App,) -> Vec { Vec::new () } # [doc = \" Move by `offset` visual caret stops in a physical direction. Input and\"] # [doc = \" output positions are UTF-16 offsets; do not add/subtract UTF-16 units\"] # [doc = \" as a substitute for visual or grapheme navigation. None means unavailable.\"] # [doc = \" This compatibility API projects to downstream affinity; native clients\"] # [doc = \" needing exact bidi/wrap caret identity use `native_position_in_direction`.\"] fn text_position_in_direction (& mut self, _position : usize, _direction : crate::TextNavigationDirection, _offset : usize, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" The visually farthest caret in a UTF-16 range in the given physical\"] # [doc = \" direction. None means unavailable; logical endpoints are not a fallback.\"] fn farthest_text_position (& mut self, _range : Range, _direction : crate::TextNavigationDirection, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" Resolved paragraph direction at a UTF-16 position, or None if unknown.\"] fn base_writing_direction (& mut self, _position : usize, _window : & mut Window, _cx : & mut App,) -> Option { None } # [doc = \" Request paragraph direction for a UTF-16 range. Return false if the\"] # [doc = \" editor cannot represent or apply this mutation; never report a no-op\"] # [doc = \" as success. Plain text need not support explicit paragraph attributes.\"] fn set_base_writing_direction (& mut self, _direction : crate::TextWritingDirection, _range : Range, _window : & mut Window, _cx : & mut App,) -> bool { false } # [doc = \" Extended grapheme containing a UTF-16 position; None if unavailable or\"] # [doc = \" outside the document. Never split surrogate pairs or combining clusters.\"] fn grapheme_range_at (& mut self, _position : usize, _window : & mut Window, _cx : & mut App,) -> Option> { None } # [doc = \" Visual caret geometry at a UTF-16 position in logical window pixels.\"] # [doc = \" None is preferable to guessed geometry when shaping is unavailable.\"] # [doc = \" This compatibility API uses downstream affinity. Prefer\"] # [doc = \" `native_position_bounds` when the platform retains visual affinity.\"] fn native_caret_bounds (& mut self, _position : usize, _window : & mut Window, _cx : & mut App,) -> Option> { None } # [doc = \" Requested keyboard/autofill hints; unsupported hints are best-effort.\"] fn text_input_options (& mut self, _window : & mut Window, _cx : & mut App) -> TextInputOptions { TextInputOptions::default () } # [doc = \" Handle an explicit platform IME action. Return true only if handled.\"] # [doc = \" The default refuses all actions; platforms may deliver their ordinary\"] # [doc = \" return-key input path when appropriate, but must not invent submission.\"] fn perform_text_input_action (& mut self, _action : TextInputAction, _window : & mut Window, _cx : & mut App,) -> bool { false } # [doc = \" Get the range of the user's currently selected text, if any\"] # [doc = \" Corresponds to [selectedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438242-selectedrange)\"] # [doc = \"\"] # [doc = \" Return value is in terms of UTF-16 characters, from 0 to the length of the document\"] fn selected_text_range (& mut self, ignore_disabled_input : bool, window : & mut Window, cx : & mut App,) -> Option; # [doc = \" Get the range of the currently marked text, if any\"] # [doc = \" Corresponds to [markedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438250-markedrange)\"] # [doc = \"\"] # [doc = \" Return value is in terms of UTF-16 characters, from 0 to the length of the document\"] fn marked_text_range (& mut self, window : & mut Window, cx : & mut App) -> Option>; # [doc = \" Get the text for the given document range in UTF-16 characters\"] # [doc = \" Corresponds to [attributedSubstring(forProposedRange: actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438238-attributedsubstring)\"] # [doc = \"\"] # [doc = \" range_utf16 is in terms of UTF-16 characters\"] fn text_for_range (& mut self, range_utf16 : Range, adjusted_range : & mut Option>, window : & mut Window, cx : & mut App,) -> Option; # [doc = \" Replace the text in the given document range with the given text\"] # [doc = \" Corresponds to [insertText(_:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438258-inserttext)\"] # [doc = \"\"] # [doc = \" replacement_range is in terms of UTF-16 characters\"] fn replace_text_in_range (& mut self, replacement_range : Option>, text : & str, window : & mut Window, cx : & mut App,); # [doc = \" Replace the text in the given document range with the given text,\"] # [doc = \" and mark the given text as part of an IME 'composing' state\"] # [doc = \" Corresponds to [setMarkedText(_:selectedRange:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438246-setmarkedtext)\"] # [doc = \"\"] # [doc = \" range_utf16 is in terms of UTF-16 characters\"] # [doc = \" new_selected_range is in terms of UTF-16 characters\"] fn replace_and_mark_text_in_range (& mut self, range_utf16 : Option>, new_text : & str, new_selected_range : Option>, window : & mut Window, cx : & mut App,); # [doc = \" Remove the IME 'composing' state from the document\"] # [doc = \" Corresponds to [unmarkText()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438239-unmarktext)\"] fn unmark_text (& mut self, window : & mut Window, cx : & mut App); # [doc = \" Get the bounds of the given document range in screen coordinates\"] # [doc = \" Corresponds to [firstRect(forCharacterRange:actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438240-firstrect)\"] # [doc = \"\"] # [doc = \" This is used for positioning the IME candidate window\"] fn bounds_for_range (& mut self, range_utf16 : Range, window : & mut Window, cx : & mut App,) -> Option>; # [doc = \" Get the character offset for the given point in terms of UTF16 characters\"] # [doc = \"\"] # [doc = \" Corresponds to [characterIndexForPoint:](https://developer.apple.com/documentation/appkit/nstextinputclient/characterindex(for:))\"] fn character_index_for_point (& mut self, point : Point, window : & mut Window, cx : & mut App,) -> Option; # [doc = \" Set the range of the user's currently selected text.\"] # [doc = \"\"] # [doc = \" This is the reverse data-flow direction from [`Self::selected_text_range`]:\"] # [doc = \" platforms call it when the system text machinery moves the selection on the\"] # [doc = \" application's behalf — e.g. the user drags a system selection handle or\"] # [doc = \" invokes Select All from system UI (iOS `UITextInput setSelectedTextRange:`,\"] # [doc = \" Android `InputConnection.setSelection`).\"] # [doc = \"\"] # [doc = \" range_utf16 is in terms of UTF-16 characters, from 0 to the length of the document\"] fn set_selected_text_range (& mut self, _range_utf16 : Range, _window : & mut Window, _cx : & mut App,) { } # [doc = \" Get the bounds of the focused text element in window coordinates, if known.\"] # [doc = \"\"] # [doc = \" This is the pull counterpart to the [`PlatformWindow::update_ime_position`]\"] # [doc = \" push: mobile platforms ask for the focused element's geometry when they\"] # [doc = \" need it (e.g. to frame system text-interaction UI overlaid on the focused\"] # [doc = \" element).\"] fn element_bounds (& mut self, _window : & mut Window, _cx : & mut App) -> Option> { None } # [doc = \" Get the length of the document in UTF-16 characters, if known.\"] fn text_length_utf16 (& mut self, _window : & mut Window, _cx : & mut App) -> Option { None } # [doc = \" Allows a given input context to opt into getting raw key repeats instead of\"] # [doc = \" sending these to the platform.\"] # [doc = \" TODO: Ideally we should be able to set ApplePressAndHoldEnabled in NSUserDefaults\"] # [doc = \" (which is how iTerm does it) but it doesn't seem to work for me.\"] # [allow (dead_code)] fn apple_press_and_hold_enabled (& mut self) -> bool { true } # [doc = \" Returns whether this handler is accepting text input to be inserted.\"] fn accepts_text_input (& mut self, _window : & mut Window, _cx : & mut App) -> bool { true } # [doc = \" Returns whether printable keys should be routed to the IME before keybinding\"] # [doc = \" matching when a non-ASCII input source (e.g. Japanese, Korean, Chinese IME)\"] # [doc = \" is active. This prevents multi-stroke keybindings like `jj` from intercepting\"] # [doc = \" keys that the IME should compose.\"] # [doc = \"\"] # [doc = \" Defaults to `false`. The editor overrides this based on whether it expects\"] # [doc = \" character input (e.g. Vim insert mode returns `true`, normal mode returns `false`).\"] # [doc = \" The terminal keeps the default `false` so that raw keys reach the terminal process.\"] fn prefers_ime_for_printable_keys (& mut self, _window : & mut Window, _cx : & mut App) -> bool { false } }", "cfg": [] }, { "id": "gpui::platform::KeyboardPurpose", "name": "KeyboardPurpose", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Requested keyboard layout. This is a hint, never input validation.", "documentation": "Requested keyboard layout. This is a hint, never input validation.", "signature": "# [doc = \" Requested keyboard layout. This is a hint, never input validation.\"] # [derive (Clone, Copy, Debug, Default, Eq, PartialEq)] pub enum KeyboardPurpose { # [doc = \" General text entry.\"] # [default] Text, # [doc = \" Integer numeric entry.\"] Number, # [doc = \" Decimal numeric entry.\"] Decimal, # [doc = \" Telephone entry.\"] Phone, # [doc = \" Email address entry.\"] Email, # [doc = \" URL entry.\"] Url, # [doc = \" Search query entry.\"] Search, }", "cfg": [] }, { "id": "gpui::platform::MAX_BUTTONS_PER_SIDE", "name": "MAX_BUTTONS_PER_SIDE", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Maximum number of [`WindowButton`]s per side in the titlebar.", "documentation": "Maximum number of [`WindowButton`]s per side in the titlebar.", "signature": "pub const MAX_BUTTONS_PER_SIDE: usize", "cfg": [] }, { "id": "gpui::platform::NoopTextSystem", "name": "NoopTextSystem", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub struct NoopTextSystem;", "cfg": [] }, { "id": "gpui::platform::NoopTextSystem::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "NoopTextSystem" }, { "id": "gpui::platform::PathPromptOptions", "name": "PathPromptOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The options that can be configured for a file dialog prompt", "documentation": "The options that can be configured for a file dialog prompt", "signature": "# [doc = \" The options that can be configured for a file dialog prompt\"] # [derive (Clone, Debug)] pub struct PathPromptOptions { # [doc = \" Should the prompt allow files to be selected?\"] pub files : bool, # [doc = \" Should the prompt allow directories to be selected?\"] pub directories : bool, # [doc = \" Should the prompt allow multiple files to be selected?\"] pub multiple : bool, # [doc = \" The prompt to show to a user when selecting a path\"] pub prompt : Option, }", "cfg": [] }, { "id": "gpui::platform::Platform", "name": "Platform", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub trait Platform : 'static { # [doc = \" Checks a native command immediately before issuing it on the owner UI thread.\"] # [doc = \" Backends must report unsupported, unavailable and refused distinctly. Mobile\"] # [doc = \" backends must override this conservative default for commands they implement.\"] # [doc = \" `Ok` means the request may be issued, not that an asynchronous OS transition\"] # [doc = \" has completed. Legacy void methods cannot report errors; cross-platform\"] # [doc = \" callers should use the corresponding `App::try_*` methods.\"] fn check_app_operation (& self, _operation : AppOperation) -> Result<(), PlatformOperationError> { if cfg ! (any (target_os = \"android\", target_os = \"ios\")) { Err (PlatformOperationError::Unsupported (\"application command\")) } else { Ok (()) } } fn background_executor (& self) -> BackgroundExecutor; fn foreground_executor (& self) -> ForegroundExecutor; fn text_system (& self) -> Arc; fn run (& self, on_finish_launching : Box); fn quit (& self); fn restart (& self, binary_path : Option); fn activate (& self, ignoring_other_apps : bool); fn hide (& self); fn hide_other_apps (& self); fn unhide_other_apps (& self); fn displays (& self) -> Vec>; fn primary_display (& self) -> Option>; fn active_window (& self) -> Option; fn window_stack (& self) -> Option> { None } fn is_screen_capture_supported (& self) -> bool { false } fn screen_capture_sources (& self,) -> oneshot::Receiver>>> { let (sources_tx, sources_rx) = oneshot::channel (); sources_tx . send (Err (anyhow::anyhow ! (\"screen capture is unsupported by this platform implementation\"))) . ok (); sources_rx } fn open_window (& self, handle : AnyWindowHandle, options : WindowParams,) -> anyhow::Result>; # [doc = \" Returns the appearance of the application's windows.\"] fn window_appearance (& self) -> WindowAppearance; # [doc = \" Overrides the appearance (light/dark) applied to the app's windows, independent\"] # [doc = \" of the OS-wide setting. Pass `None` to clear the override and follow the system\"] # [doc = \" again. The override is reflected by [`Platform::window_appearance`].\"] # [doc = \"\"] # [doc = \" Currently only implemented on macOS, where it sets `NSApplication.appearance` so\"] # [doc = \" the native window chrome (the window border and titlebar) of every window matches\"] # [doc = \" a dark app theme even when the system is in light mode (or vice versa). A no-op on\"] # [doc = \" other platforms.\"] fn set_window_appearance (& self, _appearance : Option) { } # [doc = \" Returns the window button layout configuration when supported.\"] fn button_layout (& self) -> Option { None } fn open_url (& self, url : & str); fn on_open_urls (& self, callback : Box)>); fn register_url_scheme (& self, url : & str) -> Task>; fn prompt_for_paths (& self, options : PathPromptOptions,) -> oneshot::Receiver>>>; fn prompt_for_new_path (& self, directory : & Path, suggested_name : Option<& str>,) -> oneshot::Receiver>>; fn can_select_mixed_files_and_dirs (& self) -> bool; fn reveal_path (& self, path : & Path); fn open_with_system (& self, path : & Path); fn on_quit (& self, callback : Box); fn on_reopen (& self, callback : Box); fn on_system_wake (& self, callback : Box); # [doc = \" Registers a callback invoked whenever the application's lifecycle\"] # [doc = \" phase changes. See [`AppLifecyclePhase`] for the phase vocabulary and\"] # [doc = \" its mapping onto iOS and Android.\"] # [doc = \"\"] # [doc = \" Desktop platforms never invoke this.\"] fn on_app_lifecycle (& self, _callback : Box) { } # [doc = \" Registers a callback invoked when the OS signals memory pressure\"] # [doc = \" (iOS `didReceiveMemoryWarning`, Android `onTrimMemory`).\"] # [doc = \"\"] # [doc = \" Desktop platforms never invoke this.\"] fn on_memory_warning (& self, _callback : Box) { } # [doc = \" The platform's gesture recognition services, if it provides any\"] # [doc = \" beyond gpui's portable recognizers. See\"] # [doc = \" [`PlatformGestures`](crate::PlatformGestures).\"] fn gestures (& self) -> Option> { None } fn set_menus (& self, menus : Vec

, keymap : & Keymap); fn get_menus (& self) -> Option> { None } fn set_dock_menu (& self, menu : Vec, keymap : & Keymap); fn perform_dock_menu_action (& self, _action : usize) { } fn add_recent_document (& self, _path : & Path) { } fn update_jump_list (& self, _menus : Vec, _entries : Vec>,) -> Task>> { Task::ready (Vec::new ()) } fn on_app_menu_action (& self, callback : Box); fn on_will_open_app_menu (& self, callback : Box); fn on_validate_app_menu_command (& self, callback : Box bool>); fn thermal_state (& self) -> ThermalState; fn on_thermal_state_change (& self, callback : Box); # [doc = \" Sets the application's process-wide identity and user-visible name.\"] # [doc = \"\"] # [doc = \" The identifier is used for platform identity mechanisms such as the\"] # [doc = \" Windows AppUserModelID. The name is used wherever the operating system\"] # [doc = \" presents the application to the user. Call this once, early in startup,\"] # [doc = \" before opening windows or posting notifications.\"] fn set_app_identity (& self, identifier : & str, name : & str) { _ = (identifier, name); } # [doc = \" Posts a notification to the operating system's notification center.\"] # [doc = \"\"] # [doc = \" Posting a notification whose [`SystemNotification::tag`] matches an\"] # [doc = \" earlier one replaces that notification where the platform supports it.\"] # [doc = \" No-op on platforms without notification support, or when delivery is\"] # [doc = \" unavailable (e.g. authorization was denied).\"] fn show_system_notification (& self, notification : SystemNotification) { _ = notification; } # [doc = \" Removes the delivered or pending notification with this tag.\"] # [doc = \"\"] # [doc = \" Best-effort: some platforms cannot retract a notification once shown,\"] # [doc = \" in which case it ages out of the notification center on its own.\"] fn dismiss_system_notification (& self, tag : & str) { _ = tag; } # [doc = \" Registers the callback invoked when the user activates a system\"] # [doc = \" notification, either by clicking its body or one of its action\"] # [doc = \" buttons.\"] # [doc = \"\"] # [doc = \" Implementations must invoke the callback on the main thread.\"] fn on_system_notification_response (& self, callback : Box,) { _ = callback; } fn compositor_name (& self) -> & 'static str { \"\" } fn app_path (& self) -> Result; fn path_for_auxiliary_executable (& self, name : & str) -> Result; # [doc = \" Sets the native pointer cursor style. Automatic framework updates check\"] # [doc = \" `AppOperation::SetCursorStyle` immediately before calling this method.\"] # [doc = \" Pointer styling and hiding are independent capabilities; a host may support\"] # [doc = \" one without the other. Refusal skips only the native update, not the frame's\"] # [doc = \" cursor requests or hit testing. Direct calls retain the backend's behavior.\"] fn set_cursor_style (& self, style : CursorStyle); # [doc = \" Hides the mouse cursor until the user moves the mouse over one of\"] # [doc = \" this application's windows. Automatic typing/action updates independently\"] # [doc = \" check `AppOperation::HideCursorUntilMouseMoves` immediately before calling.\"] # [doc = \" Direct calls retain the backend's behavior, including explicit refusal.\"] fn hide_cursor_until_mouse_moves (& self); # [doc = \" Returns whether the mouse cursor is currently visible.\"] fn is_cursor_visible (& self) -> bool; fn should_auto_hide_scrollbars (& self) -> bool; fn read_from_clipboard (& self) -> Option; fn write_to_clipboard (& self, item : ClipboardItem); # [cfg (any (target_os = \"linux\", target_os = \"freebsd\"))] fn read_from_primary (& self) -> Option; # [cfg (any (target_os = \"linux\", target_os = \"freebsd\"))] fn write_to_primary (& self, item : ClipboardItem); # [cfg (target_os = \"macos\")] fn read_from_find_pasteboard (& self) -> Option; # [cfg (target_os = \"macos\")] fn write_to_find_pasteboard (& self, item : ClipboardItem); fn write_credentials (& self, url : & str, username : & str, password : & [u8]) -> Task>; fn read_credentials (& self, url : & str) -> Task)>>>; fn delete_credentials (& self, url : & str) -> Task>; fn keyboard_layout (& self) -> Box; fn keyboard_mapper (& self) -> Rc; fn on_keyboard_layout_change (& self, callback : Box); }", "cfg": [] }, { "id": "gpui::platform::PlatformAtlas", "name": "PlatformAtlas", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub trait PlatformAtlas { fn get_or_insert_with<'a> (& self, key : & AtlasKey, build : & mut dyn FnMut () -> Result, Cow<'a, [u8]>)>>,) -> Result>; fn remove (& self, key : & AtlasKey); # [doc = \" Changes before unleased coordinates can be recycled by eviction/reset.\"] # [doc = \" Atlases supporting retention must implement this capture-interval fence.\"] fn resource_revision (& self) -> u64 { 0 } # [doc = \" Retains every requested allocation until the last lease is dropped.\"] # [doc = \" Unsupported atlases refuse capture. Implementations must invalidate all\"] # [doc = \" leases before clearing/resetting resources or reusing tile identities.\"] fn retain_tiles (self : Arc, _tiles : & [AtlasTile]) -> Option { None } # [cfg (any (test, feature = \"test-support\"))] fn contains (& self, _key : & AtlasKey) -> bool { false } }", "cfg": [] }, { "id": "gpui::platform::PlatformDispatcher", "name": "PlatformDispatcher", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "This type is public so that our test macro can generate and use it, but it should not be considered part of our public API.", "documentation": "This type is public so that our test macro can generate and use it, but it should not\nbe considered part of our public API.", "signature": "# [doc = \" This type is public so that our test macro can generate and use it, but it should not\"] # [doc = \" be considered part of our public API.\"] # [doc (hidden)] pub trait PlatformDispatcher : Send + Sync { fn is_main_thread (& self) -> bool; fn dispatch (& self, runnable : RunnableVariant, priority : Priority); fn dispatch_on_main_thread (& self, runnable : RunnableVariant, priority : Priority); fn dispatch_after (& self, duration : Duration, runnable : RunnableVariant); fn dispatch_on_main_thread_when_idle (& self, runnable : RunnableVariant, timeout : Option,) { let _ = timeout; self . dispatch_on_main_thread (runnable, Priority::Low); } fn idle_time_remaining (& self) -> Option { None } fn spawn_realtime (& self, f : Box); fn now (& self) -> Instant { Instant::now () } fn increase_timer_resolution (& self) -> TimerResolutionGuard { gpui_util::defer (Box::new (| | { })) } # [cfg (any (test, feature = \"test-support\"))] fn as_test (& self) -> Option<& TestDispatcher> { None } # [cfg (any (test, feature = \"test-support\"))] fn as_threaded (& self) -> Option<& ThreadedDispatcher> { None } }", "cfg": [] }, { "id": "gpui::platform::PlatformDisplay", "name": "PlatformDisplay", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A handle to a platform's display, e.g. a monitor or laptop screen.", "documentation": "A handle to a platform's display, e.g. a monitor or laptop screen.", "signature": "# [doc = \" A handle to a platform's display, e.g. a monitor or laptop screen.\"] pub trait PlatformDisplay : Debug { # [doc = \" Get the ID for this display\"] fn id (& self) -> DisplayId; # [doc = \" Returns a stable identifier for this display that can be persisted and used\"] # [doc = \" across system restarts.\"] fn uuid (& self) -> Result; # [doc = \" Get the bounds for this display\"] fn bounds (& self) -> Bounds; # [doc = \" Get the visible bounds for this display, excluding taskbar/dock areas.\"] # [doc = \" This is the usable area where windows can be placed without being obscured.\"] # [doc = \" Defaults to the full display bounds if not overridden.\"] fn visible_bounds (& self) -> Bounds { self . bounds () } # [doc = \" Get the default bounds for this display to place a window\"] fn default_bounds (& self) -> Bounds { let bounds = self . bounds (); let center = bounds . center (); let clipped_window_size = DEFAULT_WINDOW_SIZE . min (& bounds . size); let offset = clipped_window_size / 2.0; let origin = point (center . x - offset . width, center . y - offset . height); Bounds::new (origin, clipped_window_size) } }", "cfg": [] }, { "id": "gpui::platform::PlatformHeadlessRenderer", "name": "PlatformHeadlessRenderer", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A renderer for headless windows that can produce real rendered output.", "documentation": "A renderer for headless windows that can produce real rendered output.", "signature": "# [doc = \" A renderer for headless windows that can produce real rendered output.\"] # [cfg (any (test, feature = \"test-support\"))] pub trait PlatformHeadlessRenderer { # [doc = \" Render a scene and return the result as an RGBA image.\"] fn render_scene_to_image (& mut self, scene : & Scene, size : Size,) -> Result; # [doc = \" Render a scene to an offscreen target without reading the result back.\"] # [doc = \"\"] # [doc = \" This is the headless analogue of presenting a frame: it performs the\"] # [doc = \" same CPU-side scene encoding and GPU submission as drawing to a real\"] # [doc = \" window, but doesn't block on GPU completion or copy pixels back.\"] fn render_scene (& mut self, scene : & Scene, size : Size) -> Result<()>; # [doc = \" Opt-in, blocking measurement of one offscreen submission. Ordinary rendering\"] # [doc = \" stays nonblocking. Completion is not presentation, and pixel capture is not\"] # [doc = \" GPU execution. Unsupported implementations return an error, not zero time.\"] fn measure_scene (& mut self, _scene : & Scene, _size : Size,) -> Result { anyhow::bail ! (\"renderer timing is unsupported by this backend\") } # [doc = \" Adapter/backend identity for same-host evidence, not a portability promise.\"] fn timing_identity (& self) -> String { \"unsupported\" . into () } # [doc = \" Returns the sprite atlas used by this renderer.\"] fn sprite_atlas (& self) -> Arc; # [doc = \" The luminance this renderer read back for a probe slot, with the same\"] # [doc = \" meaning as [`PlatformWindow::backdrop_luminance`].\"] fn backdrop_luminance (& mut self, _slot : u32) -> Option { None } # [doc = \" Same measurement and availability as [`PlatformWindow::backdrop_statistics`].\"] fn backdrop_statistics (& mut self, _id : u32) -> Option { None } }", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::platform::PlatformInputHandler", "name": "PlatformInputHandler", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub struct PlatformInputHandler { cx : AsyncWindowContext, handler : Box, effect_owner : Option, }", "cfg": [] }, { "id": "gpui::platform::PlatformInputHandler::accepts_text_input", "name": "accepts_text_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn accepts_text_input (& mut self, window : & mut Window, cx : & mut App) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::apple_press_and_hold_enabled", "name": "apple_press_and_hold_enabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn apple_press_and_hold_enabled (& mut self) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::base_writing_direction", "name": "base_writing_direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::base_writing_direction`].", "documentation": "See [`InputHandler::base_writing_direction`].", "signature": "pub fn base_writing_direction (& mut self, position : usize,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::bounds_for_range", "name": "bounds_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn bounds_for_range (& mut self, range_utf16 : Range) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::character_index_for_point", "name": "character_index_for_point", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn character_index_for_point (& mut self, point : Point) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::compute_ime_candidate_bounds", "name": "compute_ime_candidate_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn compute_ime_candidate_bounds (marked_range : Option>, selection : & UTF16Selection, mut bounds_for_range : impl FnMut (Range) -> Option>,) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::dispatch_input", "name": "dispatch_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn dispatch_input (& mut self, input : & str, window : & mut Window, cx : & mut App)", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::element_bounds", "name": "element_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::element_bounds`].", "documentation": "See [`InputHandler::element_bounds`].", "signature": "pub fn element_bounds (& mut self) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::farthest_native_position", "name": "farthest_native_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::farthest_native_position`].", "documentation": "See [`InputHandler::farthest_native_position`].", "signature": "pub fn farthest_native_position (& mut self, range : Range, direction : crate::TextNavigationDirection,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::farthest_text_position", "name": "farthest_text_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::farthest_text_position`].", "documentation": "See [`InputHandler::farthest_text_position`].", "signature": "pub fn farthest_text_position (& mut self, range : Range, direction : crate::TextNavigationDirection,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::grapheme_range_at", "name": "grapheme_range_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::grapheme_range_at`].", "documentation": "See [`InputHandler::grapheme_range_at`].", "signature": "pub fn grapheme_range_at (& mut self, position : usize) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::ime_candidate_bounds", "name": "ime_candidate_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn ime_candidate_bounds (& mut self) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::marked_text_range", "name": "marked_text_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn marked_text_range (& mut self) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::native_caret_bounds", "name": "native_caret_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::native_caret_bounds`].", "documentation": "See [`InputHandler::native_caret_bounds`].", "signature": "pub fn native_caret_bounds (& mut self, position : usize) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::native_position_bounds", "name": "native_position_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::native_position_bounds`].", "documentation": "See [`InputHandler::native_position_bounds`].", "signature": "pub fn native_position_bounds (& mut self, position : crate::NativeTextPosition,) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::native_position_for_point", "name": "native_position_for_point", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::native_position_for_point`].", "documentation": "See [`InputHandler::native_position_for_point`].", "signature": "pub fn native_position_for_point (& mut self, point : Point, within_range : Option>,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::native_position_in_direction", "name": "native_position_in_direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::native_position_in_direction`].", "documentation": "See [`InputHandler::native_position_in_direction`].", "signature": "pub fn native_position_in_direction (& mut self, position : crate::NativeTextPosition, direction : crate::TextNavigationDirection, offset : usize,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::native_selection", "name": "native_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::native_selection`].", "documentation": "See [`InputHandler::native_selection`].", "signature": "pub fn native_selection (& mut self) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn new (cx : AsyncWindowContext, handler : Box) -> Self", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::perform_text_input_action", "name": "perform_text_input_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Dispatch an IME action. Returns false if the editor refuses it or the window is gone. A refused action must not be reported as submitted.", "documentation": "Dispatch an IME action. Returns false if the editor refuses it or the\nwindow is gone. A refused action must not be reported as submitted.", "signature": "pub fn perform_text_input_action (& mut self, action : TextInputAction) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::query_accepts_text_input", "name": "query_accepts_text_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn query_accepts_text_input (& mut self) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::query_prefers_ime_for_printable_keys", "name": "query_prefers_ime_for_printable_keys", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::prefers_ime_for_printable_keys`].", "documentation": "See [`InputHandler::prefers_ime_for_printable_keys`].\n\nThis is not a pure delegation to the handler: while a multi-stroke binding is pending this\nreturns `false` regardless of the handler's preference, because the next printable key may\ncomplete a binding whose prefix already bypassed the IME.", "signature": "pub fn query_prefers_ime_for_printable_keys (& mut self) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::replace_and_mark_text_in_range", "name": "replace_and_mark_text_in_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn replace_and_mark_text_in_range (& mut self, range_utf16 : Option>, new_text : & str, new_selected_range : Option>,)", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::replace_text_in_range", "name": "replace_text_in_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn replace_text_in_range (& mut self, replacement_range : Option>, text : & str)", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::selected_bounds", "name": "selected_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn selected_bounds (& mut self, window : & mut Window, cx : & mut App) -> Option>", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::selected_text_range", "name": "selected_text_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn selected_text_range (& mut self, ignore_disabled_input : bool) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::selection_rects_for_range", "name": "selection_rects_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::selection_rects_for_range`].", "documentation": "See [`InputHandler::selection_rects_for_range`].", "signature": "pub fn selection_rects_for_range (& mut self, range : Range,) -> Vec", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::set_base_writing_direction", "name": "set_base_writing_direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::set_base_writing_direction`].", "documentation": "See [`InputHandler::set_base_writing_direction`].", "signature": "pub fn set_base_writing_direction (& mut self, direction : crate::TextWritingDirection, range : Range,) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::set_native_selection", "name": "set_native_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::set_native_selection`].", "documentation": "See [`InputHandler::set_native_selection`].", "signature": "pub fn set_native_selection (& mut self, selection : crate::NativeTextSelection) -> bool", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::set_selected_text_range", "name": "set_selected_text_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::set_selected_text_range`].", "documentation": "See [`InputHandler::set_selected_text_range`].", "signature": "pub fn set_selected_text_range (& mut self, range_utf16 : Range)", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::text_for_range", "name": "text_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn text_for_range (& mut self, range_utf16 : Range, adjusted : & mut Option>,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::text_input_options", "name": "text_input_options", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Query the focused editor's keyboard hints. `None` means the window is no longer accessible, not that default hints were requested.", "documentation": "Query the focused editor's keyboard hints. `None` means the window is\nno longer accessible, not that default hints were requested.", "signature": "pub fn text_input_options (& mut self) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::text_length_utf16", "name": "text_length_utf16", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::text_length_utf16`].", "documentation": "See [`InputHandler::text_length_utf16`].", "signature": "pub fn text_length_utf16 (& mut self) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::text_position_in_direction", "name": "text_position_in_direction", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "See [`InputHandler::text_position_in_direction`].", "documentation": "See [`InputHandler::text_position_in_direction`].", "signature": "pub fn text_position_in_direction (& mut self, position : usize, direction : crate::TextNavigationDirection, offset : usize,) -> Option", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformInputHandler::unmark_text", "name": "unmark_text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn unmark_text (& mut self)", "cfg": [], "target": "PlatformInputHandler" }, { "id": "gpui::platform::PlatformNativeSurface", "name": "PlatformNativeSurface", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A platform-native surface inserted between GPUI's base and overlay scene planes.", "documentation": "A platform-native surface inserted between GPUI's base and overlay scene\nplanes.", "signature": "# [doc = \" A platform-native surface inserted between GPUI's base and overlay scene\"] # [doc = \" planes.\"] pub trait PlatformNativeSurface { # [doc = \" Updates the native surface geometry in device pixels.\"] fn set_bounds (& self, bounds : Bounds) -> Result<()>; # [doc = \" Updates whether the native surface participates in composition.\"] fn set_visible (& self, visible : bool) -> Result<()>; # [doc = \" Returns the platform attachment object, such as an\"] # [doc = \" `IDCompositionVisual` on Windows.\"] fn platform_handle (& self) -> Box; }", "cfg": [] }, { "id": "gpui::platform::PlatformOperationError", "name": "PlatformOperationError", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Why a checked native command was not accepted. A refusal is never success.", "documentation": "Why a checked native command was not accepted. A refusal is never success.", "signature": "# [doc = \" Why a checked native command was not accepted. A refusal is never success.\"] # [derive (Clone, Debug, Eq, PartialEq, thiserror::Error)] pub enum PlatformOperationError { # [doc = \" The backend does not implement this operation.\"] # [error (\"unsupported platform operation: {0}\")] Unsupported (& 'static str), # [doc = \" The backend implements it, but the required native state is absent.\"] # [error (\"platform operation temporarily unavailable: {0}\")] Unavailable (& 'static str), # [doc = \" The host denied the request, for example because of policy or permission.\"] # [error (\"platform operation refused: {0}\")] Refused (& 'static str), }", "cfg": [] }, { "id": "gpui::platform::PlatformTextSystem", "name": "PlatformTextSystem", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub trait PlatformTextSystem : Send + Sync { fn add_fonts (& self, fonts : Vec>) -> Result<()>; # [doc = \" Get all available font names.\"] fn all_font_names (& self) -> Vec; # [doc = \" Get the font ID for a font descriptor.\"] fn font_id (& self, descriptor : & Font) -> Result; # [doc = \" Get metrics for a font.\"] fn font_metrics (& self, font_id : FontId) -> FontMetrics; # [doc = \" Get typographic bounds for a glyph.\"] fn typographic_bounds (& self, font_id : FontId, glyph_id : GlyphId) -> Result>; # [doc = \" Get the advance width for a glyph.\"] fn advance (& self, font_id : FontId, glyph_id : GlyphId) -> Result>; # [doc = \" Get the glyph ID for a character.\"] fn glyph_for_char (& self, font_id : FontId, ch : char) -> Option; # [doc = \" Get raster bounds for a glyph.\"] fn glyph_raster_bounds (& self, params : & RenderGlyphParams) -> Result>; # [doc = \" Rasterize a glyph.\"] fn rasterize_glyph (& self, params : & RenderGlyphParams, raster_bounds : Bounds,) -> Result<(Size, Vec)>; # [doc = \" Layout a line of text with the given font runs.\"] fn layout_line (& self, text : & str, font_size : Pixels, runs : & [FontRun]) -> LineLayout; # [doc = \" Returns the recommended text rendering mode for the given font and size.\"] fn recommended_rendering_mode (& self, _font_id : FontId, _font_size : Pixels) -> TextRenderingMode; # [doc = \" Returns the dilation level to use for a glyph painted in the given color.\"] fn glyph_dilation_for_color (& self, _color : Hsla) -> u8 { 0 } }", "cfg": [] }, { "id": "gpui::platform::PlatformWindow", "name": "PlatformWindow", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub trait PlatformWindow : HasWindowHandle + HasDisplayHandle { # [doc = \" Checks a native command on the owner UI thread immediately before dispatch.\"] # [doc = \" Mobile backends must opt in to commands they implement; OS-owned window\"] # [doc = \" geometry is not a successful resize. Use `Window::try_*` to receive errors\"] # [doc = \" instead of relying on legacy void commands, which may do nothing on mobile.\"] fn check_window_operation (& self, _operation : WindowOperation,) -> Result<(), PlatformOperationError> { if cfg ! (any (target_os = \"android\", target_os = \"ios\")) { Err (PlatformOperationError::Unsupported (\"window command\")) } else { Ok (()) } } fn bounds (& self) -> Bounds; fn is_maximized (& self) -> bool; fn window_bounds (& self) -> WindowBounds; fn content_size (& self) -> Size; fn resize (& mut self, size : Size); fn scale_factor (& self) -> f32; fn appearance (& self) -> WindowAppearance; fn display (& self) -> Option>; fn mouse_position (& self) -> Point; fn modifiers (& self) -> Modifiers; fn capslock (& self) -> Capslock; fn set_input_handler (& mut self, input_handler : PlatformInputHandler); fn take_input_handler (& mut self) -> Option; fn prompt (& self, level : PromptLevel, msg : & str, detail : Option<& str>, answers : & [PromptButton],) -> Option>; fn activate (& self); # [doc = \" Requests that the operating system draw attention to this window.\"] fn request_attention (& self) { } fn is_active (& self) -> bool; fn is_hovered (& self) -> bool; fn background_appearance (& self) -> WindowBackgroundAppearance; fn set_title (& mut self, title : & str); fn set_background_appearance (& self, background_appearance : WindowBackgroundAppearance); fn minimize (& self); fn zoom (& self); # [doc = \" Asks the platform to close this window through its normal close path.\"] # [doc = \"\"] # [doc = \" The request must run the callback registered by [`Self::on_should_close`]\"] # [doc = \" and leave the window open when that callback refuses.\"] fn request_close (& self); fn toggle_fullscreen (& self); fn is_fullscreen (& self) -> bool; fn on_request_frame (& self, callback : Box); fn on_input (& self, callback : Box DispatchEventResult>); fn on_active_status_change (& self, callback : Box); fn on_hover_status_change (& self, callback : Box); fn on_resize (& self, callback : Box, f32)>); fn on_moved (& self, callback : Box); fn on_should_close (& self, callback : Box bool>); # [doc = \" Registers the hit test for client-drawn window chrome.\"] # [doc = \"\"] # [doc = \" The platform supplies the position from the native hit-test request\"] # [doc = \" itself. Using the last delivered pointer event is one movement behind\"] # [doc = \" on Windows, where `WM_NCHITTEST` precedes `WM_MOUSEMOVE`, and can make a\"] # [doc = \" maximize button report client area on entry instead of `HTMAXBUTTON`.\"] fn on_hit_test_window_control (& self, callback : Box) -> Option>,); fn on_close (& self, callback : Box); fn on_appearance_changed (& self, callback : Box); fn on_button_layout_changed (& self, _callback : Box) { } fn draw (& self, scene : & Scene); # [doc = \" Draws a scene with primitives at and after `overlay_start` on a platform\"] # [doc = \" overlay surface when one has been enabled.\"] # [doc = \"\"] # [doc = \" Platforms without layered scene support fall back to drawing the complete\"] # [doc = \" scene on their primary surface.\"] fn draw_layered (& self, scene : & Scene, _overlay_start : usize) { self . draw (scene); } # [doc = \" Enables a transparent GPUI surface above native child views.\"] # [doc = \"\"] # [doc = \" This is currently an experimental capability for embedding native\"] # [doc = \" surfaces between GPUI's base and deferred-overlay paint planes.\"] fn enable_scene_overlay (& self) -> anyhow::Result<()> { anyhow::bail ! (\"layered GPUI scenes are not supported on this platform\") } # [doc = \" Creates a native surface slot between GPUI's base and overlay planes.\"] fn create_native_surface (& self) -> Result> { anyhow::bail ! (\"native surface portals are not supported on this platform\") } # [doc = \" Attaches, repositions and detaches natively hosted views to match the\"] # [doc = \" frame GPUI just drew.\"] # [doc = \"\"] # [doc = \" Called from the window's draw, which runs on the platform's UI thread, so\"] # [doc = \" implementations may touch native view hierarchies directly. Platforms\"] # [doc = \" without native view hosting ignore the update.\"] fn update_platform_views (& self, _update : & PlatformViewUpdate) { } fn completed_frame (& self) { } fn sprite_atlas (& self) -> Arc; fn is_subpixel_rendering_supported (& self) -> bool; fn get_title (& self) -> String { String::new () } fn tabbed_windows (& self) -> Option> { None } fn tab_bar_visible (& self) -> bool { false } fn set_edited (& mut self, _edited : bool) { } fn set_document_path (& self, _path : Option<& std::path::Path>) { } # [cfg (target_os = \"macos\")] fn set_traffic_light_position (& self, _position : Point) { } fn show_character_palette (& self) { } fn titlebar_double_click (& self, _is_resizable : bool, _is_minimizable : bool) { } fn on_move_tab_to_new_window (& self, _callback : Box) { } fn on_merge_all_windows (& self, _callback : Box) { } fn on_select_previous_tab (& self, _callback : Box) { } fn on_select_next_tab (& self, _callback : Box) { } fn on_toggle_tab_bar (& self, _callback : Box) { } fn merge_all_windows (& self) { } fn move_tab_to_new_window (& self) { } fn toggle_window_tab_overview (& self) { } fn set_tabbing_identifier (& self, _identifier : Option) { } # [cfg (target_os = \"windows\")] fn get_raw_handle (& self) -> windows::Win32::Foundation::HWND; fn inner_window_bounds (& self) -> WindowBounds { self . window_bounds () } fn request_decorations (& self, _decorations : WindowDecorations) { } fn show_window_menu (& self, _position : Point) { } # [doc = \" Presents one opaque menu revision. Replacements must invalidate the old\"] # [doc = \" revision and wait for its native tracking loop to exit before starting\"] # [doc = \" the next, including replacements from another window on this UI thread.\"] # [doc = \"\"] # [doc = \" Implementations must run a blocking native tracking loop only after the\"] # [doc = \" current GPUI call stack has yielded. Coordinates are window-relative\"] # [doc = \" logical pixels. Unsupported platforms return\"] # [doc = \" [`NativeMenuError::NotSupported`] so the component can render in-window.\"] # [doc = \" Failed replacement cancellation is a refusal, not unsupported capability.\"] fn show_context_menu (& self, _session : NativeMenuSessionId, _menu : Menu, _position : Point,) -> std::result::Result, NativeMenuError> { Err (NativeMenuNotSupportedError . into ()) } # [doc = \" Invalidates only the matching current revision. `true` means a cancel\"] # [doc = \" request, not completed closure; the result receiver confirms loop exit.\"] # [doc = \" A stale identity must never call a thread-wide native cancellation API.\"] # [doc = \" Even a refused cancellation must suppress that revision's late command.\"] fn cancel_context_menu (& self, _session : NativeMenuSessionId) -> Result { Ok (false) } # [doc = \" Observes a menu only while inside the actual native tracking call.\"] # [doc = \" Queued menus and test-platform simulations must return `None`. This is\"] # [doc = \" instrumentation for native loop smoke tests, not presentation state.\"] # [cfg (any (test, feature = \"test-support\"))] fn native_context_menu_tracking (& self) -> Option { None } fn start_window_move (& self) { } fn can_start_external_drag (& self) -> bool { false } fn start_external_drag (& self, _payload : & ExternalDragPayload) -> bool { false } fn start_window_resize (& self, _edge : ResizeEdge) { } fn set_exclusive_zone (& self, _zone : Pixels) { } # [cfg (all (target_os = \"linux\", feature = \"wayland\"))] fn set_exclusive_edge (& self, _edge : layer_shell::Anchor) { } fn set_input_region (& self, _region : Option<& [Bounds]>) { } fn window_decorations (& self) -> Decorations { Decorations::Server } fn set_app_id (& mut self, _app_id : & str) { } fn map_window (& mut self) -> anyhow::Result<()> { Ok (()) } fn window_controls (& self) -> WindowControls { WindowControls::default () } fn set_client_inset (& self, _inset : Pixels) { } fn gpu_specs (& self) -> Option; fn update_ime_position (& self, _bounds : Bounds); # [doc = \" The regions of this window currently obscured or reserved by the\"] # [doc = \" system. Zero on platforms without such regions.\"] fn insets (& self) -> WindowInsets { WindowInsets::default () } # [doc = \" Registers a callback invoked whenever [`Self::insets`] change. Update\"] # [doc = \" the value returned by `insets` before invoking this callback.\"] # [doc = \"\"] # [doc = \" Contract: fires continuously during animated transitions (Android\"] # [doc = \" `WindowInsetsAnimation` progress; on iOS the platform interpolates\"] # [doc = \" the keyboard animation curve on frame ticks) and is exact at rest.\"] fn on_insets_changed (& self, _callback : Box) { } # [doc = \" Sets the handler for the system back action (Android back\"] # [doc = \" button/gesture; no source on iOS or desktop).\"] fn set_back_handler (& self, _callback : Box) { } # [doc = \" Declares whether the application would currently handle the system\"] # [doc = \" back action (e.g. navigation depth> 0).\"] fn set_back_enabled (& self, _enabled : bool) { } # [doc = \" Requests that the soft keyboard be shown.\"] fn show_soft_keyboard (& self) { } # [doc = \" Requests that the soft keyboard be hidden.\"] fn hide_soft_keyboard (& self) { } # [doc = \" Inform the operating system that text input state changed. Called while\"] # [doc = \" the core window is borrowed; defer native queries through the input\"] # [doc = \" handler until after returning, rather than reentering the core window.\"] fn text_input_state_changed (& self, _change : TextInputStateChange) { } fn play_system_bell (& self) { } # [doc = \" Initialize the accessibility adapter with callbacks.\"] fn a11y_init (& self, _callbacks : A11yCallbacks) { } # [doc = \" Provide a TreeUpdate to the accessibility adapter.\"] fn a11y_tree_update (& self, _tree_update : accesskit::TreeUpdate) { } # [doc = \" Inform the adapter of updated window bounds.\"] fn a11y_update_window_bounds (& self) { } # [cfg (any (test, feature = \"test-support\"))] fn as_test (& mut self) -> Option<& mut TestWindow> { None } # [doc = \" Renders the given scene to a texture and returns the pixel data as an RGBA image.\"] # [doc = \" This does not present the frame to screen - useful for visual testing where we want\"] # [doc = \" to capture what would be rendered without displaying it or requiring the window to be visible.\"] # [cfg (any (test, feature = \"test-support\"))] fn render_to_image (& self, _scene : & Scene) -> Result { anyhow::bail ! (\"render_to_image not implemented for this platform\") } # [doc = \" The luminance the renderer read back for this probe slot, or `None`\"] # [doc = \" while no probed surface has completed a frame in it — including on a\"] # [doc = \" renderer that takes no probes at all, which is how the absence of the\"] # [doc = \" capability is reported rather than hidden.\"] fn backdrop_luminance (& self, _slot : u32) -> Option { None } # [doc = \" Five-sample optical-source statistics for an active probe lease.\"] # [doc = \" Unsupported renderers and probes without completed readings return `None`.\"] fn backdrop_statistics (& self, _id : u32) -> Option { None } }", "cfg": [] }, { "id": "gpui::platform::PromptButton", "name": "PromptButton", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Prompt Button", "documentation": "Prompt Button", "signature": "# [doc = \" Prompt Button\"] # [derive (Clone, Debug, PartialEq)] pub enum PromptButton { # [doc = \" Ok button\"] Ok (SharedString), # [doc = \" Cancel button\"] Cancel (SharedString), # [doc = \" Other button\"] Other (SharedString), }", "cfg": [] }, { "id": "gpui::platform::PromptButton::cancel", "name": "cancel", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a Cancel button", "documentation": "Create a Cancel button", "signature": "pub fn cancel (label : impl Into) -> Self", "cfg": [], "target": "PromptButton" }, { "id": "gpui::platform::PromptButton::is_cancel", "name": "is_cancel", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns true if this button is a cancel button.", "documentation": "Returns true if this button is a cancel button.", "signature": "pub fn is_cancel (& self) -> bool", "cfg": [], "target": "PromptButton" }, { "id": "gpui::platform::PromptButton::label", "name": "label", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns the label of the button", "documentation": "Returns the label of the button", "signature": "pub fn label (& self) -> & SharedString", "cfg": [], "target": "PromptButton" }, { "id": "gpui::platform::PromptButton::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create a button with label", "documentation": "Create a button with label", "signature": "pub fn new (label : impl Into) -> Self", "cfg": [], "target": "PromptButton" }, { "id": "gpui::platform::PromptButton::ok", "name": "ok", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Create an Ok button", "documentation": "Create an Ok button", "signature": "pub fn ok (label : impl Into) -> Self", "cfg": [], "target": "PromptButton" }, { "id": "gpui::platform::PromptLevel", "name": "PromptLevel", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "What kind of prompt styling to show", "documentation": "What kind of prompt styling to show", "signature": "# [doc = \" What kind of prompt styling to show\"] # [derive (Copy, Clone, Debug, PartialEq)] pub enum PromptLevel { # [doc = \" A prompt that is shown when the user should be notified of something\"] Info, # [doc = \" A prompt that is shown when the user needs to be warned of a potential problem\"] Warning, # [doc = \" A prompt that is shown when a critical problem has occurred\"] Critical, }", "cfg": [] }, { "id": "gpui::platform::RequestFrameOptions", "name": "RequestFrameOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Copy, Clone, Eq, PartialEq, Default)] # [expect (missing_docs)] pub struct RequestFrameOptions { # [doc = \" Whether a presentation is required.\"] pub require_presentation : bool, # [doc = \" Force refresh of all rendering states when true.\"] pub force_render : bool, }", "cfg": [] }, { "id": "gpui::platform::ResizeEdge", "name": "ResizeEdge", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Which part of the window to resize", "documentation": "Which part of the window to resize", "signature": "# [doc = \" Which part of the window to resize\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum ResizeEdge { # [doc = \" The top edge\"] Top, # [doc = \" The top right corner\"] TopRight, # [doc = \" The right edge\"] Right, # [doc = \" The bottom right corner\"] BottomRight, # [doc = \" The bottom edge\"] Bottom, # [doc = \" The bottom left corner\"] BottomLeft, # [doc = \" The left edge\"] Left, # [doc = \" The top left corner\"] TopLeft, }", "cfg": [] }, { "id": "gpui::platform::RunnableVariant", "name": "RunnableVariant", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Type alias for runnables with metadata. Previously an enum with a single variant, now simplified to a direct type alias.", "documentation": "Type alias for runnables with metadata.\nPreviously an enum with a single variant, now simplified to a direct type alias.", "signature": "# [doc = \" Type alias for runnables with metadata.\"] # [doc = \" Previously an enum with a single variant, now simplified to a direct type alias.\"] # [doc (hidden)] pub type RunnableVariant = Runnable;", "cfg": [] }, { "id": "gpui::platform::ScreenCaptureFrame", "name": "ScreenCaptureFrame", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A frame of video captured from a screen.", "documentation": "A frame of video captured from a screen.", "signature": "# [doc = \" A frame of video captured from a screen.\"] pub struct ScreenCaptureFrame (pub PlatformScreenCaptureFrame);", "cfg": [] }, { "id": "gpui::platform::ScreenCaptureSource", "name": "ScreenCaptureSource", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A source of on-screen video content that can be captured.", "documentation": "A source of on-screen video content that can be captured.", "signature": "# [doc = \" A source of on-screen video content that can be captured.\"] pub trait ScreenCaptureSource { # [doc = \" Returns metadata for this source.\"] fn metadata (& self) -> Result; # [doc = \" Start capture video from this source, invoking the given callback\"] # [doc = \" with each frame.\"] fn stream (& self, foreground_executor : & ForegroundExecutor, frame_callback : Box,) -> oneshot::Receiver>>; }", "cfg": [] }, { "id": "gpui::platform::ScreenCaptureStream", "name": "ScreenCaptureStream", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A video stream captured from a screen.", "documentation": "A video stream captured from a screen.", "signature": "# [doc = \" A video stream captured from a screen.\"] pub trait ScreenCaptureStream { # [doc = \" Returns metadata for this source.\"] fn metadata (& self) -> Result; }", "cfg": [] }, { "id": "gpui::platform::SourceMetadata", "name": "SourceMetadata", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Metadata for a given [ScreenCaptureSource]", "documentation": "Metadata for a given [ScreenCaptureSource]", "signature": "# [doc = \" Metadata for a given [ScreenCaptureSource]\"] # [derive (Clone)] pub struct SourceMetadata { # [doc = \" Opaque identifier of this screen.\"] pub id : u64, # [doc = \" Human-readable label for this source.\"] pub label : Option, # [doc = \" Whether this source is the main display.\"] pub is_main : Option, # [doc = \" Video resolution of this source.\"] pub resolution : Size, }", "cfg": [] }, { "id": "gpui::platform::SystemNotification", "name": "SystemNotification", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A notification posted to the operating system's notification center, rather than rendered as in-app UI.", "documentation": "A notification posted to the operating system's notification center,\nrather than rendered as in-app UI.", "signature": "# [doc = \" A notification posted to the operating system's notification center,\"] # [doc = \" rather than rendered as in-app UI.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct SystemNotification { # [doc = \" Stable identity for the notification. Posting a new notification with\"] # [doc = \" the same tag replaces the previous one where the platform supports it,\"] # [doc = \" and responses carry the tag back to the application.\"] pub tag : SharedString, # [doc = \" The notification's headline.\"] pub title : SharedString, # [doc = \" Additional text displayed below the title.\"] pub body : SharedString, # [doc = \" Buttons offered on the notification. Platforms that cannot display\"] # [doc = \" action buttons show the notification without them.\"] pub actions : Vec, }", "cfg": [] }, { "id": "gpui::platform::SystemNotificationAction", "name": "SystemNotificationAction", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A button offered on a [`SystemNotification`].", "documentation": "A button offered on a [`SystemNotification`].", "signature": "# [doc = \" A button offered on a [`SystemNotification`].\"] # [derive (Clone, Debug, PartialEq, Eq, Hash)] pub struct SystemNotificationAction { # [doc = \" Identifies the action in [`SystemNotificationResponse::action_id`]\"] # [doc = \" when the user presses this button.\"] pub id : SharedString, # [doc = \" The button's user-visible label.\"] pub label : SharedString, }", "cfg": [] }, { "id": "gpui::platform::SystemNotificationResponse", "name": "SystemNotificationResponse", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The user's activation of a [`SystemNotification`].", "documentation": "The user's activation of a [`SystemNotification`].", "signature": "# [doc = \" The user's activation of a [`SystemNotification`].\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct SystemNotificationResponse { # [doc = \" The [`SystemNotification::tag`] of the activated notification.\"] pub tag : SharedString, # [doc = \" The pressed action button's [`SystemNotificationAction::id`], or\"] # [doc = \" `None` when the user activated the notification body itself.\"] pub action_id : Option, }", "cfg": [] }, { "id": "gpui::platform::TasksIncluded", "name": "TasksIncluded", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub enum TasksIncluded { OnlyCompleted, CompletedAndRunning, }", "cfg": [] }, { "id": "gpui::platform::TextGammaParams", "name": "TextGammaParams", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Perceptual alpha correction applied when compositing atlas glyph coverage.", "documentation": "Perceptual alpha correction applied when compositing atlas glyph coverage.\n\nWindows and WGPU already reshape grayscale (and subpixel) coverage with this\nlayout before the hardware blend. Metal uses the same defaults so a tintable\nA8 mask is not left as a raw `color.a *= sample.a` multiply.", "signature": "# [doc = \" Perceptual alpha correction applied when compositing atlas glyph coverage.\"] # [doc = \"\"] # [doc = \" Windows and WGPU already reshape grayscale (and subpixel) coverage with this\"] # [doc = \" layout before the hardware blend. Metal uses the same defaults so a tintable\"] # [doc = \" A8 mask is not left as a raw `color.a *= sample.a` multiply.\"] # [repr (C)] # [derive (Clone, Copy, Debug, PartialEq)] pub struct TextGammaParams { # [doc = \" Four-term polynomial used by [`apply_contrast_and_gamma_correction`].\"] pub gamma_ratios : [f32; 4], # [doc = \" Contrast boost applied to dark grayscale foregrounds.\"] pub grayscale_enhanced_contrast : f32, # [doc = \" Contrast boost applied to subpixel coverage.\"] pub subpixel_enhanced_contrast : f32, # [doc = \" Pad to 32 bytes so Metal constant-buffer layout stays aligned.\"] pub pad : [f32; 2], }", "cfg": [] }, { "id": "gpui::platform::TextGammaParams::grayscale_default", "name": "grayscale_default", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Parameters used by the WGPU fallback path.", "documentation": "Parameters used by the WGPU fallback path.", "signature": "pub fn grayscale_default () -> Self", "cfg": [], "target": "TextGammaParams" }, { "id": "gpui::platform::TextGammaParams::identity", "name": "identity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Parameters that leave atlas coverage exactly as rasterized.", "documentation": "Parameters that leave atlas coverage exactly as rasterized.\n\nCore Graphics bakes its own gamma handling into the coverage it\nrasterizes, and the macOS text system already dilates strokes to match\nAppleFontSmoothing per foreground luminance. Reshaping that coverage a\nsecond time with the DirectWrite curve thickens and smudges glyphs, so\nMetal composites it untouched.", "signature": "pub fn identity () -> Self", "cfg": [], "target": "TextGammaParams" }, { "id": "gpui::platform::TextInputAction", "name": "TextInputAction", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Requested IME return-key action. The editor, not the platform, decides whether an action submits data or moves focus. Newline is explicit.", "documentation": "Requested IME return-key action. The editor, not the platform, decides\nwhether an action submits data or moves focus. Newline is explicit.", "signature": "# [doc = \" Requested IME return-key action. The editor, not the platform, decides\"] # [doc = \" whether an action submits data or moves focus. Newline is explicit.\"] # [derive (Clone, Copy, Debug, Default, Eq, PartialEq)] pub enum TextInputAction { # [doc = \" Platform default return key.\"] # [default] Default, # [doc = \" Insert a line break if the editor accepts it.\"] Newline, # [doc = \" Complete editing.\"] Done, # [doc = \" Navigate to the entered destination.\"] Go, # [doc = \" Move to the next input.\"] Next, # [doc = \" Move to the previous input.\"] Previous, # [doc = \" Submit a search query.\"] Search, # [doc = \" Send the composed content.\"] Send, }", "cfg": [] }, { "id": "gpui::platform::TextInputOptions", "name": "TextInputOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Caller-owned input traits, analogous to UIKit UITextInputTraits, Android EditorInfo and HTML inputmode/enterkeyhint/autocomplete. Platforms must document unsupported hints. These never validate text or perform actions.", "documentation": "Caller-owned input traits, analogous to UIKit UITextInputTraits, Android\nEditorInfo and HTML inputmode/enterkeyhint/autocomplete. Platforms must\ndocument unsupported hints. These never validate text or perform actions.", "signature": "# [doc = \" Caller-owned input traits, analogous to UIKit UITextInputTraits, Android\"] # [doc = \" EditorInfo and HTML inputmode/enterkeyhint/autocomplete. Platforms must\"] # [doc = \" document unsupported hints. These never validate text or perform actions.\"] # [derive (Clone, Copy, Debug, Default, Eq, PartialEq)] pub struct TextInputOptions { # [doc = \" Requested keyboard layout.\"] pub purpose : KeyboardPurpose, # [doc = \" Requested return-key label/action.\"] pub action : TextInputAction, # [doc = \" Semantic autofill purpose; None makes no autofill request.\"] pub autofill : Option, # [doc = \" Whether line breaks are meaningful to this editor.\"] pub multiline : bool, # [doc = \" Request secure platform input. The editor must still mask its rendered\"] # [doc = \" text and exclude sensitive content from diagnostics and accessibility.\"] pub secure : bool, }", "cfg": [] }, { "id": "gpui::platform::TextInputStateChange", "name": "TextInputStateChange", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A change in the state of the focused text input.", "documentation": "A change in the state of the focused text input.", "signature": "# [doc = \" A change in the state of the focused text input.\"] # [derive (Debug, Copy, Clone, Eq, PartialEq, Hash)] pub enum TextInputStateChange { # [doc = \" An editable element gained focus.\"] FocusGained, # [doc = \" The focused editable element lost focus.\"] FocusLost, # [doc = \" The selection or caret moved\"] SelectionChanged, # [doc = \" The document content changed outside of platform-initiated edits.\"] ContentChanged, # [doc = \" Keyboard layout, return action, or autofill hints changed.\"] OptionsChanged, }", "cfg": [] }, { "id": "gpui::platform::TextRenderingMode", "name": "TextRenderingMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The text rendering mode to use for drawing glyphs.", "documentation": "The text rendering mode to use for drawing glyphs.", "signature": "# [doc = \" The text rendering mode to use for drawing glyphs.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum TextRenderingMode { # [doc = \" Use the platform's default text rendering mode.\"] # [default] PlatformDefault, # [doc = \" Use subpixel (ClearType-style) text rendering.\"] Subpixel, # [doc = \" Use grayscale text rendering.\"] Grayscale, }", "cfg": [] }, { "id": "gpui::platform::ThermalState", "name": "ThermalState", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Thermal state of the system", "documentation": "Thermal state of the system", "signature": "# [doc = \" Thermal state of the system\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum ThermalState { # [doc = \" System has no thermal constraints\"] Nominal, # [doc = \" System is slightly constrained, reduce discretionary work\"] Fair, # [doc = \" System is moderately constrained, reduce CPU/GPU intensive work\"] Serious, # [doc = \" System is critically constrained, minimize all resource usage\"] Critical, }", "cfg": [] }, { "id": "gpui::platform::TileId", "name": "TileId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] # [repr (C)] # [expect (missing_docs)] pub struct TileId (pub u32);", "cfg": [] }, { "id": "gpui::platform::Tiling", "name": "Tiling", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A type to describe which sides of the window are currently tiled in some way", "documentation": "A type to describe which sides of the window are currently tiled in some way", "signature": "# [doc = \" A type to describe which sides of the window are currently tiled in some way\"] # [derive (Debug, Copy, Clone, Eq, PartialEq, Hash, Default)] pub struct Tiling { # [doc = \" Whether the top edge is tiled\"] pub top : bool, # [doc = \" Whether the left edge is tiled\"] pub left : bool, # [doc = \" Whether the right edge is tiled\"] pub right : bool, # [doc = \" Whether the bottom edge is tiled\"] pub bottom : bool, }", "cfg": [] }, { "id": "gpui::platform::Tiling::is_tiled", "name": "is_tiled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Whether any edge is tiled", "documentation": "Whether any edge is tiled", "signature": "pub fn is_tiled (& self) -> bool", "cfg": [], "target": "Tiling" }, { "id": "gpui::platform::Tiling::tiled", "name": "tiled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Initializes a [`Tiling`] type with all sides tiled", "documentation": "Initializes a [`Tiling`] type with all sides tiled", "signature": "pub fn tiled () -> Self", "cfg": [], "target": "Tiling" }, { "id": "gpui::platform::TimerResolutionGuard", "name": "TimerResolutionGuard", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub type TimerResolutionGuard = gpui_util::Deferred>;", "cfg": [] }, { "id": "gpui::platform::TitlebarOptions", "name": "TitlebarOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The options that can be configured for a window's titlebar", "documentation": "The options that can be configured for a window's titlebar", "signature": "# [doc = \" The options that can be configured for a window's titlebar\"] # [derive (Debug, Default)] pub struct TitlebarOptions { # [doc = \" The initial title of the window\"] pub title : Option, # [doc = \" Should the default system titlebar be hidden to allow for a custom-drawn titlebar? (macOS and Windows only)\"] # [doc = \" Refer to [`WindowOptions::window_decorations`] on Linux\"] pub appears_transparent : bool, # [doc = \" The position of the macOS traffic light buttons\"] pub traffic_light_position : Option>, }", "cfg": [] }, { "id": "gpui::platform::UTF16Selection", "name": "UTF16Selection", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A struct representing a selection in a text buffer, in UTF16 characters. This is different from a range because the head may be before the tail.", "documentation": "A struct representing a selection in a text buffer, in UTF16 characters.\nThis is different from a range because the head may be before the tail.", "signature": "# [doc = \" A struct representing a selection in a text buffer, in UTF16 characters.\"] # [doc = \" This is different from a range because the head may be before the tail.\"] # [derive (Debug)] pub struct UTF16Selection { # [doc = \" The range of text in the document this selection corresponds to\"] # [doc = \" in UTF16 characters.\"] pub range : Range, # [doc = \" Whether the head of this selection is at the start (true), or end (false)\"] # [doc = \" of the range\"] pub reversed : bool, }", "cfg": [] }, { "id": "gpui::platform::WindowAppearance", "name": "WindowAppearance", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The appearance of the window, as defined by the operating system.", "documentation": "The appearance of the window, as defined by the operating system.\n\nOn macOS, this corresponds to named [`NSAppearance`](https://developer.apple.com/documentation/appkit/nsappearance)\nvalues.", "signature": "# [doc = \" The appearance of the window, as defined by the operating system.\"] # [doc = \"\"] # [doc = \" On macOS, this corresponds to named [`NSAppearance`](https://developer.apple.com/documentation/appkit/nsappearance)\"] # [doc = \" values.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum WindowAppearance { # [doc = \" A light appearance.\"] # [doc = \"\"] # [doc = \" On macOS, this corresponds to the `aqua` appearance.\"] # [default] Light, # [doc = \" A light appearance with vibrant colors.\"] # [doc = \"\"] # [doc = \" On macOS, this corresponds to the `NSAppearanceNameVibrantLight` appearance.\"] VibrantLight, # [doc = \" A dark appearance.\"] # [doc = \"\"] # [doc = \" On macOS, this corresponds to the `darkAqua` appearance.\"] Dark, # [doc = \" A dark appearance with vibrant colors.\"] # [doc = \"\"] # [doc = \" On macOS, this corresponds to the `NSAppearanceNameVibrantDark` appearance.\"] VibrantDark, }", "cfg": [] }, { "id": "gpui::platform::WindowBackgroundAppearance", "name": "WindowBackgroundAppearance", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The appearance of the background of the window itself, when there is no content or the content is transparent.", "documentation": "The appearance of the background of the window itself, when there is\nno content or the content is transparent.", "signature": "# [doc = \" The appearance of the background of the window itself, when there is\"] # [doc = \" no content or the content is transparent.\"] # [derive (Copy, Clone, Debug, Default, PartialEq)] pub enum WindowBackgroundAppearance { # [doc = \" Opaque.\"] # [doc = \"\"] # [doc = \" This lets the window manager know that content behind this\"] # [doc = \" window does not need to be drawn.\"] # [doc = \"\"] # [doc = \" Actual color depends on the system and themes should define a fully\"] # [doc = \" opaque background color instead.\"] # [default] Opaque, # [doc = \" Plain alpha transparency.\"] Transparent, # [doc = \" Transparency, but the contents behind the window are blurred.\"] # [doc = \"\"] # [doc = \" Not always supported.\"] Blurred, # [doc = \" The Mica backdrop material, supported on Windows 11.\"] MicaBackdrop, # [doc = \" The Mica Alt backdrop material, supported on Windows 11.\"] MicaAltBackdrop, # [doc = \" The current platform's system glass material.\"] # [doc = \"\"] # [doc = \" On macOS 26+ this is `NSGlassEffectView` at the regular style, composited\"] # [doc = \" behind the window's content. On Windows 11 it is the main-window Mica\"] # [doc = \" backdrop. Other platforms treat it as [`Self::Opaque`].\"] SystemGlass, }", "cfg": [] }, { "id": "gpui::platform::WindowBounds", "name": "WindowBounds", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Represents the status of how a window should be opened.", "documentation": "Represents the status of how a window should be opened.", "signature": "# [doc = \" Represents the status of how a window should be opened.\"] # [derive (Debug, Copy, Clone, PartialEq)] pub enum WindowBounds { # [doc = \" Indicates that the window should open in a windowed state with the given bounds.\"] Windowed (Bounds), # [doc = \" Indicates that the window should open in a maximized state.\"] # [doc = \" The bounds provided here represent the restore size of the window.\"] Maximized (Bounds), # [doc = \" Indicates that the window should open in fullscreen mode.\"] # [doc = \" The bounds provided here represent the restore size of the window.\"] Fullscreen (Bounds), }", "cfg": [] }, { "id": "gpui::platform::WindowBounds::centered", "name": "centered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Creates a new window bounds that centers the window on the screen.", "documentation": "Creates a new window bounds that centers the window on the screen.", "signature": "pub fn centered (size : Size, cx : & App) -> Self", "cfg": [], "target": "WindowBounds" }, { "id": "gpui::platform::WindowBounds::get_bounds", "name": "get_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Retrieve the inner bounds", "documentation": "Retrieve the inner bounds", "signature": "pub fn get_bounds (& self) -> Bounds", "cfg": [], "target": "WindowBounds" }, { "id": "gpui::platform::WindowButton", "name": "WindowButton", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A window control button type used in [`WindowButtonLayout`].", "documentation": "A window control button type used in [`WindowButtonLayout`].", "signature": "# [doc = \" A window control button type used in [`WindowButtonLayout`].\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum WindowButton { # [doc = \" The minimize button\"] Minimize, # [doc = \" The maximize button\"] Maximize, # [doc = \" The close button\"] Close, }", "cfg": [] }, { "id": "gpui::platform::WindowButton::id", "name": "id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns a stable element ID for rendering this button.", "documentation": "Returns a stable element ID for rendering this button.", "signature": "pub fn id (& self) -> & 'static str", "cfg": [], "target": "WindowButton" }, { "id": "gpui::platform::WindowButtonLayout", "name": "WindowButtonLayout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Describes which [`WindowButton`]s appear on each side of the titlebar.", "documentation": "Describes which [`WindowButton`]s appear on each side of the titlebar.\n\nOn Linux, this is read from the desktop environment's configuration\n(e.g. GNOME's `gtk-decoration-layout` gsetting) via\n`WindowButtonLayout::parse`.", "signature": "# [doc = \" Describes which [`WindowButton`]s appear on each side of the titlebar.\"] # [doc = \"\"] # [doc = \" On Linux, this is read from the desktop environment's configuration\"] # [doc = \" (e.g. GNOME's `gtk-decoration-layout` gsetting) via\"] # [doc = \" `WindowButtonLayout::parse`.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct WindowButtonLayout { # [doc = \" Buttons on the left side of the titlebar.\"] pub left : [Option; MAX_BUTTONS_PER_SIDE], # [doc = \" Buttons on the right side of the titlebar.\"] pub right : [Option; MAX_BUTTONS_PER_SIDE], }", "cfg": [] }, { "id": "gpui::platform::WindowButtonLayout::format", "name": "format", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Formats the layout back into a GNOME-style `button-layout` string.", "documentation": "Formats the layout back into a GNOME-style `button-layout` string.", "signature": "pub fn format (& self) -> String", "cfg": [ "cfg (test)" ], "target": "WindowButtonLayout" }, { "id": "gpui::platform::WindowButtonLayout::linux_default", "name": "linux_default", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Returns Zed's built-in fallback button layout for Linux titlebars.", "documentation": "Returns Zed's built-in fallback button layout for Linux titlebars.", "signature": "pub fn linux_default () -> Self", "cfg": [], "target": "WindowButtonLayout" }, { "id": "gpui::platform::WindowButtonLayout::parse", "name": "parse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Parses a GNOME-style `button-layout` string (e.g. `\"close,minimize:maximize\"`).", "documentation": "Parses a GNOME-style `button-layout` string (e.g. `\"close,minimize:maximize\"`).", "signature": "pub fn parse (layout_string : & str) -> Result", "cfg": [], "target": "WindowButtonLayout" }, { "id": "gpui::platform::WindowControls", "name": "WindowControls", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "What window controls this platform supports", "documentation": "What window controls this platform supports", "signature": "# [doc = \" What window controls this platform supports\"] # [derive (Debug, Copy, Clone, Eq, PartialEq, Hash)] pub struct WindowControls { # [doc = \" Whether this platform supports fullscreen\"] pub fullscreen : bool, # [doc = \" Whether this platform supports maximize\"] pub maximize : bool, # [doc = \" Whether this platform supports minimize\"] pub minimize : bool, # [doc = \" Whether this platform supports a window menu\"] pub window_menu : bool, }", "cfg": [] }, { "id": "gpui::platform::WindowDecorations", "name": "WindowDecorations", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "A type to describe the appearance of a window", "documentation": "A type to describe the appearance of a window", "signature": "# [doc = \" A type to describe the appearance of a window\"] # [derive (Debug, Copy, Clone, Eq, PartialEq, Hash, Default)] pub enum WindowDecorations { # [default] # [doc = \" Server side decorations\"] Server, # [doc = \" Client side decorations\"] Client, }", "cfg": [] }, { "id": "gpui::platform::WindowInsets", "name": "WindowInsets", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Regions of a window that are obscured or reserved by the system.", "documentation": "Regions of a window that are obscured or reserved by the system.\n\nDistances are nonnegative logical pixels inward from the edges of the\ncurrent content viewport, not physical screen pixels or keyboard height.\nIf the platform already resizes the viewport above an IME, `ime` contains\nonly remaining overlap (normally zero). Overlay mode reports the occluded\nportion. Never apply both a viewport reduction and the same inset again.\nFloating/split keyboards cannot be represented faithfully as edge insets;\nthese values describe edge avoidance, not arbitrary occlusion geometry.", "signature": "# [doc = \" Regions of a window that are obscured or reserved by the system.\"] # [doc = \"\"] # [doc = \" Distances are nonnegative logical pixels inward from the edges of the\"] # [doc = \" current content viewport, not physical screen pixels or keyboard height.\"] # [doc = \" If the platform already resizes the viewport above an IME, `ime` contains\"] # [doc = \" only remaining overlap (normally zero). Overlay mode reports the occluded\"] # [doc = \" portion. Never apply both a viewport reduction and the same inset again.\"] # [doc = \" Floating/split keyboards cannot be represented faithfully as edge insets;\"] # [doc = \" these values describe edge avoidance, not arbitrary occlusion geometry.\"] # [derive (Debug, Clone, Default, PartialEq)] pub struct WindowInsets { # [doc = \" Regions covered by system UI or hardware: status bar, display\"] # [doc = \" cutouts/notch, home indicator, navigation bars.\"] # [doc = \" (iOS: `safeAreaInsets`. Android: `WindowInsets` of types\"] # [doc = \" `systemBars() | displayCutout()`.)\"] pub safe_area : Edges, # [doc = \" The region covered by the keyboard, when present.\"] # [doc = \" (iOS: derived from `keyboardWillShow`/frame-change notifications.\"] # [doc = \" Android: `WindowInsets.Type.ime()`.)\"] pub ime : Edges, }", "cfg": [] }, { "id": "gpui::platform::WindowInsets::effective", "name": "effective", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The combined inset content should avoid. Overlapping safe-area and keyboard regions combine by maximum, never by addition.", "documentation": "The combined inset content should avoid. Overlapping safe-area and\nkeyboard regions combine by maximum, never by addition.", "signature": "pub fn effective (& self) -> Edges", "cfg": [], "target": "WindowInsets" }, { "id": "gpui::platform::WindowKind", "name": "WindowKind", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The kind of window to create", "documentation": "The kind of window to create", "signature": "# [doc = \" The kind of window to create\"] # [derive (Clone, Debug, PartialEq, Eq)] pub enum WindowKind { # [doc = \" A normal application window\"] Normal, # [doc = \" A window that appears above all other windows, usually used for alerts or popups\"] # [doc = \" use sparingly!\"] PopUp, # [doc = \" A parent-anchored, platform-native popup window for menus, comboboxes, context menus and\"] # [doc = \" tooltips. Unlike [`WindowKind::PopUp`], it is positioned relative to a parent window.\"] # [doc = \"\"] # [doc = \" The popup's size comes from [`WindowOptions::window_bounds`], whose origin is ignored.\"] # [doc = \" See [`popup::PopupOptions`] for the placement options. Platforms without a native\"] # [doc = \" implementation reject it with [`popup::PopupNotSupportedError`].\"] AnchoredPopup (popup::PopupOptions), # [doc = \" A floating window that appears on top of its parent window\"] Floating, # [doc = \" A Wayland LayerShell window, used to draw overlays or backgrounds for applications such as\"] # [doc = \" docks, notifications or wallpapers.\"] # [cfg (all (target_os = \"linux\", feature = \"wayland\"))] LayerShell (layer_shell::LayerShellOptions), # [doc = \" A window that appears on top of its parent window and blocks interaction with it\"] # [doc = \" until the modal window is closed\"] Dialog, }", "cfg": [] }, { "id": "gpui::platform::WindowOperation", "name": "WindowOperation", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Window commands whose availability depends on the native host.", "documentation": "Window commands whose availability depends on the native host.", "signature": "# [doc = \" Window commands whose availability depends on the native host.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq)] pub enum WindowOperation { # [doc = \" Request a content size.\"] Resize, # [doc = \" Toggle maximization/zoom.\"] Zoom, # [doc = \" Minimize the window.\"] Minimize, # [doc = \" Toggle native fullscreen.\"] ToggleFullscreen, }", "cfg": [] }, { "id": "gpui::platform::WindowOptions", "name": "WindowOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The variables that can be configured when creating a new window", "documentation": "The variables that can be configured when creating a new window", "signature": "# [doc = \" The variables that can be configured when creating a new window\"] # [derive (Debug)] pub struct WindowOptions { # [doc = \" Specifies the state and bounds of the window in screen coordinates.\"] # [doc = \" - `None`: Inherit the bounds.\"] # [doc = \" - `Some(WindowBounds)`: Open a window with corresponding state and its restore size.\"] pub window_bounds : Option, # [doc = \" The titlebar configuration of the window\"] pub titlebar : Option, # [doc = \" Whether the window should be focused when created\"] pub focus : bool, # [doc = \" Whether the window should be shown when created\"] pub show : bool, # [doc = \" The kind of window to create\"] pub kind : WindowKind, # [doc = \" Whether the window can be moved by the user. When `false`, the user cannot drag\"] # [doc = \" the window (on macOS this sets `NSWindow.isMovable`, which also disables the\"] # [doc = \" Window-menu tiling items); programmatic moves are still allowed.\"] pub is_movable : bool, # [doc = \" Whether the application owns dragging of the (custom) titlebar, rather than\"] # [doc = \" AppKit. Only has an effect on macOS.\"] # [doc = \"\"] # [doc = \" Set this to `true` for windows that draw their own titlebar and move the window\"] # [doc = \" themselves via [`Window::start_window_move`]. It marks the whole content view as\"] # [doc = \" app-owned titlebar content, so AppKit neither drags the window from the titlebar\"] # [doc = \" nor delays titlebar clicks while disambiguating double-clicks (a delay first\"] # [doc = \" observed on macOS 27). It is independent of `is_movable`, so such windows stay\"] # [doc = \" user-movable (via their own drag) and keep the Window-menu tiling items enabled.\"] # [doc = \"\"] # [doc = \" Leave this `false` for windows that rely on AppKit's native titlebar dragging.\"] pub app_owns_titlebar_drag : bool, # [doc = \" Whether the window should be resizable by the user\"] pub is_resizable : bool, # [doc = \" Whether the window should be minimized by the user\"] pub is_minimizable : bool, # [doc = \" The display to create the window on, if this is None,\"] # [doc = \" the window will be created on the main display\"] pub display_id : Option, # [doc = \" The appearance of the window background.\"] pub window_background : WindowBackgroundAppearance, # [doc = \" Application identifier of the window. Can by used by desktop environments to group applications together.\"] pub app_id : Option, # [doc = \" Window minimum size\"] pub window_min_size : Option>, # [doc = \" Whether to use client or server-side decorations on X11 and Wayland.\"] # [doc = \" The platform may ignore requests it cannot satisfy.\"] pub window_decorations : Option, # [doc = \" Icon image (X11 only)\"] pub icon : Option>, # [doc = \" Tab group name, allows opening the window as a native tab on macOS 10.12+. Windows with the same tabbing identifier will be grouped together.\"] pub tabbing_identifier : Option, }", "cfg": [] }, { "id": "gpui::platform::WindowParams", "name": "WindowParams", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "The variables that can be configured when creating a new window", "documentation": "The variables that can be configured when creating a new window", "signature": "# [doc = \" The variables that can be configured when creating a new window\"] # [derive (Debug)] # [cfg_attr (all (any (target_os = \"linux\", target_os = \"freebsd\"), not (any (feature = \"x11\", feature = \"wayland\"))), allow (dead_code))] # [allow (missing_docs)] pub struct WindowParams { pub bounds : Bounds, # [doc = \" The titlebar configuration of the window\"] # [cfg_attr (feature = \"wayland\", allow (dead_code))] pub titlebar : Option, # [doc = \" The kind of window to create\"] # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\"), allow (dead_code))] pub kind : WindowKind, # [doc = \" Whether the window should be movable by the user\"] # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\"), allow (dead_code))] pub is_movable : bool, # [doc = \" Whether the application owns dragging of the (custom) titlebar (macOS only)\"] # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\", target_os = \"windows\"), allow (dead_code))] pub app_owns_titlebar_drag : bool, # [doc = \" Whether the window should be resizable by the user\"] # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\"), allow (dead_code))] pub is_resizable : bool, # [doc = \" Whether the window should be minimized by the user\"] # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\"), allow (dead_code))] pub is_minimizable : bool, # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\", target_os = \"windows\"), allow (dead_code))] pub focus : bool, # [cfg_attr (any (target_os = \"linux\", target_os = \"freebsd\"), allow (dead_code))] pub show : bool, # [doc = \" An image to set as the window icon (x11 only)\"] # [cfg_attr (feature = \"wayland\", allow (dead_code))] pub icon : Option>, # [cfg_attr (feature = \"wayland\", allow (dead_code))] pub display_id : Option, # [cfg_attr (feature = \"wayland\", allow (dead_code))] pub app_id : Option, pub window_min_size : Option>, # [cfg (target_os = \"macos\")] pub tabbing_identifier : Option, }", "cfg": [] }, { "id": "gpui::platform::app_menu::Menu", "name": "Menu", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "A menu of the application, either a main menu or a submenu", "documentation": "A menu of the application, either a main menu or a submenu", "signature": "# [doc = \" A menu of the application, either a main menu or a submenu\"] pub struct Menu { # [doc = \" The name of the menu\"] pub name : SharedString, # [doc = \" The items in the menu\"] pub items : Vec, # [doc = \" Whether this menu is disabled\"] pub disabled : bool, }", "cfg": [] }, { "id": "gpui::platform::app_menu::Menu::disabled", "name": "disabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Set whether this menu is disabled", "documentation": "Set whether this menu is disabled", "signature": "pub fn disabled (mut self, disabled : bool) -> Self", "cfg": [], "target": "Menu" }, { "id": "gpui::platform::app_menu::Menu::items", "name": "items", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Set items to be in this menu", "documentation": "Set items to be in this menu", "signature": "pub fn items (mut self, items : impl IntoIterator) -> Self", "cfg": [], "target": "Menu" }, { "id": "gpui::platform::app_menu::Menu::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Create a new Menu with the given name", "documentation": "Create a new Menu with the given name", "signature": "pub fn new (name : impl Into) -> Self", "cfg": [], "target": "Menu" }, { "id": "gpui::platform::app_menu::Menu::owned", "name": "owned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Create an OwnedMenu from this Menu", "documentation": "Create an OwnedMenu from this Menu", "signature": "pub fn owned (self) -> OwnedMenu", "cfg": [], "target": "Menu" }, { "id": "gpui::platform::app_menu::MenuItem", "name": "MenuItem", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "The different kinds of items that can be in a menu", "documentation": "The different kinds of items that can be in a menu", "signature": "# [doc = \" The different kinds of items that can be in a menu\"] pub enum MenuItem { # [doc = \" A separator between items\"] Separator, # [doc = \" A submenu\"] Submenu (Menu), # [doc = \" A menu, managed by the system (for example, the Services menu on macOS)\"] SystemMenu (OsMenu), # [doc = \" An action that can be performed\"] Action { # [doc = \" The name of this menu item\"] name : SharedString, # [doc = \" The action to perform when this menu item is selected\"] action : Box, # [doc = \" The OS Action that corresponds to this action, if any\"] # [doc = \" See [`OsAction`] for more information\"] os_action : Option, # [doc = \" Whether this action is checked\"] checked : bool, # [doc = \" Whether this action is disabled\"] disabled : bool, }, }", "cfg": [] }, { "id": "gpui::platform::app_menu::MenuItem::action", "name": "action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Creates a new menu item that invokes an action", "documentation": "Creates a new menu item that invokes an action", "signature": "pub fn action (name : impl Into, action : impl Action) -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::checked", "name": "checked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Set whether this menu item is checked", "documentation": "Set whether this menu item is checked\n\nOnly for [`MenuItem::Action`], otherwise, will be ignored", "signature": "pub fn checked (mut self, checked : bool) -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::disabled", "name": "disabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Set whether this menu item is disabled", "documentation": "Set whether this menu item is disabled", "signature": "pub fn disabled (mut self, disabled : bool) -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::is_checked", "name": "is_checked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Returns whether this menu item is checked", "documentation": "Returns whether this menu item is checked\n\nOnly for [`MenuItem::Action`], otherwise, returns false", "signature": "pub fn is_checked (& self) -> bool", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::is_disabled", "name": "is_disabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Returns whether this menu item is disabled", "documentation": "Returns whether this menu item is disabled\n\nOnly for [`MenuItem::Action`] and [`MenuItem::Submenu`], otherwise, returns false", "signature": "pub fn is_disabled (& self) -> bool", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::os_action", "name": "os_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Creates a new menu item that invokes an action and has an OS action", "documentation": "Creates a new menu item that invokes an action and has an OS action", "signature": "pub fn os_action (name : impl Into, action : impl Action, os_action : OsAction,) -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::os_submenu", "name": "os_submenu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Creates a new submenu that is populated by the OS", "documentation": "Creates a new submenu that is populated by the OS", "signature": "pub fn os_submenu (name : impl Into, menu_type : SystemMenuType) -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::owned", "name": "owned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Create an OwnedMenuItem from this MenuItem", "documentation": "Create an OwnedMenuItem from this MenuItem", "signature": "pub fn owned (self) -> OwnedMenuItem", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::separator", "name": "separator", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Creates a new menu item that is a separator", "documentation": "Creates a new menu item that is a separator", "signature": "pub fn separator () -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::MenuItem::submenu", "name": "submenu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Creates a new menu item that is a submenu", "documentation": "Creates a new menu item that is a submenu", "signature": "pub fn submenu (menu : Menu) -> Self", "cfg": [], "target": "MenuItem" }, { "id": "gpui::platform::app_menu::NativeMenuNotSupportedError", "name": "NativeMenuNotSupportedError", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Returned when the current platform cannot present application-provided context menus through the operating system.", "documentation": "Returned when the current platform cannot present application-provided\ncontext menus through the operating system.\n\nThis is a capability result, not a presentation failure. Components that\nwork on every platform should use it as the signal to draw their existing\nin-window menu instead.", "signature": "# [doc = \" Returned when the current platform cannot present application-provided\"] # [doc = \" context menus through the operating system.\"] # [doc = \"\"] # [doc = \" This is a capability result, not a presentation failure. Components that\"] # [doc = \" work on every platform should use it as the signal to draw their existing\"] # [doc = \" in-window menu instead.\"] # [derive (Debug, Error)] # [error (\"native context menus are not supported on this platform\")] pub struct NativeMenuNotSupportedError;", "cfg": [] }, { "id": "gpui::platform::app_menu::NativeMenuOutcome", "name": "NativeMenuOutcome", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "How a platform-native context menu finished.", "documentation": "How a platform-native context menu finished.\n\nThe selected action is dispatched through the focus context that was\nactive when the menu opened before [`Selected`](Self::Selected) is\nreported.", "signature": "# [doc = \" How a platform-native context menu finished.\"] # [doc = \"\"] # [doc = \" The selected action is dispatched through the focus context that was\"] # [doc = \" active when the menu opened before [`Selected`](Self::Selected) is\"] # [doc = \" reported.\"] # [derive (Copy, Clone, Debug, Eq, PartialEq)] pub enum NativeMenuOutcome { # [doc = \" The user selected an enabled action.\"] Selected, # [doc = \" The menu closed without selecting an action.\"] Dismissed, # [doc = \" The revision was cancelled/replaced. No command was dispatched.\"] Cancelled, # [doc = \" Presentation or its window/backend disappeared without a valid result.\"] # [doc = \" This is not a user dismissal.\"] Unavailable, }", "cfg": [] }, { "id": "gpui::platform::app_menu::OsAction", "name": "OsAction", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "OS actions are actions that are recognized by the operating system This allows the operating system to provide specialized behavior for these actions", "documentation": "OS actions are actions that are recognized by the operating system\nThis allows the operating system to provide specialized behavior for\nthese actions", "signature": "# [doc = \" OS actions are actions that are recognized by the operating system\"] # [doc = \" This allows the operating system to provide specialized behavior for\"] # [doc = \" these actions\"] # [derive (Copy, Clone, Eq, PartialEq)] pub enum OsAction { # [doc = \" The 'cut' action\"] Cut, # [doc = \" The 'copy' action\"] Copy, # [doc = \" The 'paste' action\"] Paste, # [doc = \" The 'select all' action\"] SelectAll, # [doc = \" The 'undo' action\"] Undo, # [doc = \" The 'redo' action\"] Redo, }", "cfg": [] }, { "id": "gpui::platform::app_menu::OsMenu", "name": "OsMenu", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "OS menus are menus that are recognized by the operating system This allows the operating system to provide specialized items for these menus", "documentation": "OS menus are menus that are recognized by the operating system\nThis allows the operating system to provide specialized items for\nthese menus", "signature": "# [doc = \" OS menus are menus that are recognized by the operating system\"] # [doc = \" This allows the operating system to provide specialized items for\"] # [doc = \" these menus\"] pub struct OsMenu { # [doc = \" The name of the menu\"] pub name : SharedString, # [doc = \" The type of menu\"] pub menu_type : SystemMenuType, }", "cfg": [] }, { "id": "gpui::platform::app_menu::OsMenu::owned", "name": "owned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "Create an OwnedOsMenu from this OsMenu", "documentation": "Create an OwnedOsMenu from this OsMenu", "signature": "pub fn owned (self) -> OwnedOsMenu", "cfg": [], "target": "OsMenu" }, { "id": "gpui::platform::app_menu::OwnedMenu", "name": "OwnedMenu", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "A menu of the application, either a main menu or a submenu", "documentation": "A menu of the application, either a main menu or a submenu", "signature": "# [doc = \" A menu of the application, either a main menu or a submenu\"] # [derive (Clone)] pub struct OwnedMenu { # [doc = \" The name of the menu\"] pub name : SharedString, # [doc = \" The items in the menu\"] pub items : Vec, # [doc = \" Whether this menu is disabled\"] pub disabled : bool, }", "cfg": [] }, { "id": "gpui::platform::app_menu::OwnedMenuItem", "name": "OwnedMenuItem", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "The different kinds of items that can be in a menu", "documentation": "The different kinds of items that can be in a menu", "signature": "# [doc = \" The different kinds of items that can be in a menu\"] pub enum OwnedMenuItem { # [doc = \" A separator between items\"] Separator, # [doc = \" A submenu\"] Submenu (OwnedMenu), # [doc = \" A menu, managed by the system (for example, the Services menu on macOS)\"] SystemMenu (OwnedOsMenu), # [doc = \" An action that can be performed\"] Action { # [doc = \" The name of this menu item\"] name : String, # [doc = \" The action to perform when this menu item is selected\"] action : Box, # [doc = \" The OS Action that corresponds to this action, if any\"] # [doc = \" See [`OsAction`] for more information\"] os_action : Option, # [doc = \" Whether this action is checked\"] checked : bool, # [doc = \" Whether this action is disabled\"] disabled : bool, }, }", "cfg": [] }, { "id": "gpui::platform::app_menu::OwnedOsMenu", "name": "OwnedOsMenu", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "OS menus are menus that are recognized by the operating system This allows the operating system to provide specialized items for these menus", "documentation": "OS menus are menus that are recognized by the operating system\nThis allows the operating system to provide specialized items for\nthese menus", "signature": "# [doc = \" OS menus are menus that are recognized by the operating system\"] # [doc = \" This allows the operating system to provide specialized items for\"] # [doc = \" these menus\"] # [derive (Clone)] pub struct OwnedOsMenu { # [doc = \" The name of the menu\"] pub name : SharedString, # [doc = \" The type of menu\"] pub menu_type : SystemMenuType, }", "cfg": [] }, { "id": "gpui::platform::app_menu::SystemMenuType", "name": "SystemMenuType", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::app_menu", "path": "gpui::platform::app_menu", "source": "crates/gpui/src/platform/app_menu.rs", "summary": "The type of system menu", "documentation": "The type of system menu", "signature": "# [doc = \" The type of system menu\"] # [derive (Copy, Clone, Eq, PartialEq)] pub enum SystemMenuType { # [doc = \" The 'Services' menu in the Application menu on macOS\"] Services, }", "cfg": [] }, { "id": "gpui::platform::apply_contrast_and_gamma_correction", "name": "apply_contrast_and_gamma_correction", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Reshape atlas coverage so grayscale text composites with the same perceptual contrast and gamma curve as Direct3D and WGPU.", "documentation": "Reshape atlas coverage so grayscale text composites with the same\nperceptual contrast and gamma curve as Direct3D and WGPU.\n\n`sample` is the single-channel coverage from the glyph (or SVG) atlas.\n`color` is the unpremultiplied RGB tint. The returned value replaces the\nraw coverage before `color.a *= coverage`.", "signature": "pub fn apply_contrast_and_gamma_correction (sample : f32, color : [f32; 3], enhanced_contrast_factor : f32, gamma_ratios : [f32; 4],) -> f32", "cfg": [] }, { "id": "gpui::platform::get_gamma_correction_ratios", "name": "get_gamma_correction_ratios", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Compute gamma correction ratios for grayscale and subpixel text compositing.", "documentation": "Compute gamma correction ratios for grayscale and subpixel text compositing.", "signature": "pub fn get_gamma_correction_ratios (gamma : f32) -> [f32; 4]", "cfg": [] }, { "id": "gpui::platform::guess_compositor", "name": "guess_compositor", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "Return which compositor we're guessing we'll use. Does not attempt to connect to the given compositor.", "documentation": "Return which compositor we're guessing we'll use.\nDoes not attempt to connect to the given compositor.", "signature": "pub fn guess_compositor () -> & 'static str", "cfg": [ "cfg (any (target_os = \"linux\", target_os = \"freebsd\"))" ] }, { "id": "gpui::platform::keyboard::DummyKeyboardMapper", "name": "DummyKeyboardMapper", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::keyboard", "path": "gpui::platform::keyboard", "source": "crates/gpui/src/platform/keyboard.rs", "summary": "A dummy implementation of the platform keyboard mapper", "documentation": "A dummy implementation of the platform keyboard mapper", "signature": "# [doc = \" A dummy implementation of the platform keyboard mapper\"] pub struct DummyKeyboardMapper;", "cfg": [] }, { "id": "gpui::platform::keyboard::PlatformKeyboardLayout", "name": "PlatformKeyboardLayout", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform::keyboard", "path": "gpui::platform::keyboard", "source": "crates/gpui/src/platform/keyboard.rs", "summary": "A trait for platform-specific keyboard layouts", "documentation": "A trait for platform-specific keyboard layouts", "signature": "# [doc = \" A trait for platform-specific keyboard layouts\"] pub trait PlatformKeyboardLayout { # [doc = \" Get the keyboard layout ID, which should be unique to the layout\"] fn id (& self) -> & str; # [doc = \" Get the keyboard layout display name\"] fn name (& self) -> & str; }", "cfg": [] }, { "id": "gpui::platform::keyboard::PlatformKeyboardMapper", "name": "PlatformKeyboardMapper", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform::keyboard", "path": "gpui::platform::keyboard", "source": "crates/gpui/src/platform/keyboard.rs", "summary": "A trait for platform-specific keyboard mappings", "documentation": "A trait for platform-specific keyboard mappings", "signature": "# [doc = \" A trait for platform-specific keyboard mappings\"] pub trait PlatformKeyboardMapper { # [doc = \" Map a key equivalent to its platform-specific representation\"] fn map_key_equivalent (& self, keystroke : Keystroke, use_key_equivalents : bool,) -> KeybindingKeystroke; # [doc = \" Get the key equivalents for the current keyboard layout,\"] # [doc = \" only used on macOS\"] fn get_key_equivalents (& self) -> Option<& HashMap>; }", "cfg": [] }, { "id": "gpui::platform::keystroke::AsKeystroke", "name": "AsKeystroke", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "This is a helper trait so that we can simplify the implementation of some functions", "documentation": "This is a helper trait so that we can simplify the implementation of some functions", "signature": "# [doc = \" This is a helper trait so that we can simplify the implementation of some functions\"] pub trait AsKeystroke { # [doc = \" Returns the GPUI representation of the keystroke.\"] fn as_keystroke (& self) -> & Keystroke; }", "cfg": [] }, { "id": "gpui::platform::keystroke::Capslock", "name": "Capslock", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "The state of the capslock key at some point in time", "documentation": "The state of the capslock key at some point in time", "signature": "# [doc = \" The state of the capslock key at some point in time\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Default, Serialize, Deserialize, Hash, JsonSchema)] pub struct Capslock { # [doc = \" The capslock key is on\"] # [serde (default)] pub on : bool, }", "cfg": [] }, { "id": "gpui::platform::keystroke::InvalidKeystrokeError", "name": "InvalidKeystrokeError", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Error type for `Keystroke::parse`. This is used instead of `anyhow::Error` so that Zed can use markdown to display it.", "documentation": "Error type for `Keystroke::parse`. This is used instead of `anyhow::Error` so that Zed can use\nmarkdown to display it.", "signature": "# [doc = \" Error type for `Keystroke::parse`. This is used instead of `anyhow::Error` so that Zed can use\"] # [doc = \" markdown to display it.\"] # [derive (Debug)] pub struct InvalidKeystrokeError { # [doc = \" The invalid keystroke.\"] pub keystroke : String, }", "cfg": [] }, { "id": "gpui::platform::keystroke::KEYSTROKE_PARSE_EXPECTED_MESSAGE", "name": "KEYSTROKE_PARSE_EXPECTED_MESSAGE", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Sentence explaining what keystroke parser expects, starting with \"Expected ...\"", "documentation": "Sentence explaining what keystroke parser expects, starting with \"Expected ...\"", "signature": "pub const KEYSTROKE_PARSE_EXPECTED_MESSAGE: & str", "cfg": [] }, { "id": "gpui::platform::keystroke::KeybindingKeystroke", "name": "KeybindingKeystroke", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Represents a keystroke that can be used in keybindings and displayed to the user.", "documentation": "Represents a keystroke that can be used in keybindings and displayed to the user.", "signature": "# [doc = \" Represents a keystroke that can be used in keybindings and displayed to the user.\"] # [derive (Debug, Clone, Eq, PartialEq, Hash)] pub struct KeybindingKeystroke { # [doc = \" The GPUI representation of the keystroke.\"] inner : Keystroke, # [doc = \" The modifiers to display.\"] # [cfg (target_os = \"windows\")] display_modifiers : Modifiers, # [doc = \" The key to display.\"] # [cfg (target_os = \"windows\")] display_key : String, }", "cfg": [] }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::from_keystroke", "name": "from_keystroke", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Create a new keybinding keystroke from the given keystroke, without any platform-specific mapping.", "documentation": "Create a new keybinding keystroke from the given keystroke, without any platform-specific mapping.", "signature": "pub fn from_keystroke (keystroke : Keystroke) -> Self", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::inner", "name": "inner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns the GPUI representation of the keystroke.", "documentation": "Returns the GPUI representation of the keystroke.", "signature": "pub fn inner (& self) -> & Keystroke", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::key", "name": "key", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns the key.", "documentation": "Returns the key.\n\nPlatform-specific behavior:\n- On macOS and Linux, this key is the same as `inner.key`, which is the GPUI representation of the keystroke.\n- On Windows, this key is the display key, for example, a `ctrl-@` keystroke will have `inner.key` as `@` and `display_key` as `2`.", "signature": "pub fn key (& self) -> & str", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::modifiers", "name": "modifiers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns the modifiers.", "documentation": "Returns the modifiers.\n\nPlatform-specific behavior:\n- On macOS and Linux, this modifiers is the same as `inner.modifiers`, which is the GPUI representation of the keystroke.\n- On Windows, this modifiers is the display modifiers, for example, a `ctrl-@` keystroke will have `inner.modifiers` as\n`Modifiers::control()` and `display_modifiers` as `Modifiers::control_shift()`.", "signature": "pub fn modifiers (& self) -> & Modifiers", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "", "documentation": "", "signature": "pub fn new (inner : Keystroke, display_modifiers : Modifiers, display_key : String) -> Self", "cfg": [ "cfg (target_os = \"windows\")" ], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::new_with_mapper", "name": "new_with_mapper", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Create a new keybinding keystroke from the given keystroke using the given keyboard mapper.", "documentation": "Create a new keybinding keystroke from the given keystroke using the given keyboard mapper.", "signature": "pub fn new_with_mapper (inner : Keystroke, use_key_equivalents : bool, keyboard_mapper : & dyn PlatformKeyboardMapper,) -> Self", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::remove_key_char", "name": "remove_key_char", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Removes the key_char", "documentation": "Removes the key_char", "signature": "pub fn remove_key_char (& mut self)", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::set_key", "name": "set_key", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Sets the key. On Windows this modifies both `inner.key` and `display_key`.", "documentation": "Sets the key. On Windows this modifies both `inner.key` and `display_key`.", "signature": "pub fn set_key (& mut self, key : String)", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::set_modifiers", "name": "set_modifiers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Sets the modifiers. On Windows this modifies both `inner.modifiers` and `display_modifiers`.", "documentation": "Sets the modifiers. On Windows this modifies both `inner.modifiers` and `display_modifiers`.", "signature": "pub fn set_modifiers (& mut self, modifiers : Modifiers)", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::KeybindingKeystroke::unparse", "name": "unparse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Produces a representation of this key that Parse can understand.", "documentation": "Produces a representation of this key that Parse can understand.", "signature": "pub fn unparse (& self) -> String", "cfg": [], "target": "KeybindingKeystroke" }, { "id": "gpui::platform::keystroke::Keystroke", "name": "Keystroke", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "A keystroke and associated metadata generated by the platform", "documentation": "A keystroke and associated metadata generated by the platform", "signature": "# [doc = \" A keystroke and associated metadata generated by the platform\"] # [derive (Clone, Debug, Eq, PartialEq, Default, Deserialize, Hash)] pub struct Keystroke { # [doc = \" the state of the modifier keys at the time the keystroke was generated\"] pub modifiers : Modifiers, # [doc = \" key is the character printed on the key that was pressed\"] # [doc = \" e.g. for option-s, key is \\\"s\\\"\"] # [doc = \" On layouts that do not have ascii keys (e.g. Thai)\"] # [doc = \" this will be the ASCII-equivalent character (q instead of ๆ),\"] # [doc = \" and the typed character will be present in key_char.\"] pub key : String, # [doc = \" key_char is the character that could have been typed when\"] # [doc = \" this binding was pressed.\"] # [doc = \" e.g. for s this is \\\"s\\\", for option-s \\\"ß\\\", and cmd-s None\"] pub key_char : Option, }", "cfg": [] }, { "id": "gpui::platform::keystroke::Keystroke::is_ime_in_progress", "name": "is_ime_in_progress", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns true if this keystroke left the ime system in an incomplete state.", "documentation": "Returns true if this keystroke left\nthe ime system in an incomplete state.", "signature": "pub fn is_ime_in_progress (& self) -> bool", "cfg": [], "target": "Keystroke" }, { "id": "gpui::platform::keystroke::Keystroke::parse", "name": "parse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "key syntax is: `[secondary-][ctrl-][alt-][shift-][cmd-][fn-]key[->key_char]` key_char syntax is only used for generating test events, secondary means \"cmd\" on macOS and \"ctrl\" on other platforms when matching a key with an key_char set will be matched without it.", "documentation": "key syntax is:\n`[secondary-][ctrl-][alt-][shift-][cmd-][fn-]key[->key_char]`\nkey_char syntax is only used for generating test events,\nsecondary means \"cmd\" on macOS and \"ctrl\" on other platforms\nwhen matching a key with an key_char set will be matched without it.", "signature": "pub fn parse (source : & str) -> std::result::Result", "cfg": [], "target": "Keystroke" }, { "id": "gpui::platform::keystroke::Keystroke::should_match", "name": "should_match", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "When matching a key we cannot know whether the user intended to type the key_char or the key itself. On some non-US keyboards keys we use in our bindings are behind option (for example `$` is typed `alt-ç` on a Czech keyboard), and on some keyboards the IME handler converts a sequence of keys into a specific character (for example `\"` is typed as `\" space` on a brazilian keyboard).", "documentation": "When matching a key we cannot know whether the user intended to type\nthe key_char or the key itself. On some non-US keyboards keys we use in our\nbindings are behind option (for example `$` is typed `alt-ç` on a Czech keyboard),\nand on some keyboards the IME handler converts a sequence of keys into a\nspecific character (for example `\"` is typed as `\" space` on a brazilian keyboard).\n\nThis method assumes that `self` was typed and `target' is in the keymap, and checks\nboth possibilities for self against the target.", "signature": "pub fn should_match (& self, target : & KeybindingKeystroke) -> bool", "cfg": [], "target": "Keystroke" }, { "id": "gpui::platform::keystroke::Keystroke::unparse", "name": "unparse", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Produces a representation of this key that Parse can understand.", "documentation": "Produces a representation of this key that Parse can understand.", "signature": "pub fn unparse (& self) -> String", "cfg": [], "target": "Keystroke" }, { "id": "gpui::platform::keystroke::Keystroke::with_simulated_ime", "name": "with_simulated_ime", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns a new keystroke with the key_char filled. This is used for dispatch_keystroke where we want users to be able to simulate typing \"space\", etc.", "documentation": "Returns a new keystroke with the key_char filled.\nThis is used for dispatch_keystroke where we want users to\nbe able to simulate typing \"space\", etc.", "signature": "pub fn with_simulated_ime (mut self) -> Self", "cfg": [], "target": "Keystroke" }, { "id": "gpui::platform::keystroke::Modifiers", "name": "Modifiers", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "The state of the modifier keys at some point in time", "documentation": "The state of the modifier keys at some point in time", "signature": "# [doc = \" The state of the modifier keys at some point in time\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Default, Serialize, Deserialize, Hash, JsonSchema)] pub struct Modifiers { # [doc = \" The control key\"] # [serde (default)] pub control : bool, # [doc = \" The alt key\"] # [doc = \" Sometimes also known as the 'meta' key\"] # [serde (default)] pub alt : bool, # [doc = \" The shift key\"] # [serde (default)] pub shift : bool, # [doc = \" The command key, on macos\"] # [doc = \" the windows key, on windows\"] # [doc = \" the super key, on linux\"] # [serde (default)] pub platform : bool, # [doc = \" The function key\"] # [serde (default)] pub function : bool, }", "cfg": [] }, { "id": "gpui::platform::keystroke::Modifiers::alt", "name": "alt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just alt.", "documentation": "Returns [`Modifiers`] with just alt.", "signature": "pub fn alt () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::command", "name": "command", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just the command key.", "documentation": "Returns [`Modifiers`] with just the command key.", "signature": "pub fn command () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::command_shift", "name": "command_shift", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with command + shift.", "documentation": "Returns [`Modifiers`] with command + shift.", "signature": "pub fn command_shift () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::control", "name": "control", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just control.", "documentation": "Returns [`Modifiers`] with just control.", "signature": "pub fn control () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::control_shift", "name": "control_shift", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with command + shift.", "documentation": "Returns [`Modifiers`] with command + shift.", "signature": "pub fn control_shift () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::function", "name": "function", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just function.", "documentation": "Returns [`Modifiers`] with just function.", "signature": "pub fn function () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::is_subset_of", "name": "is_subset_of", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Checks if this [`Modifiers`] is a subset of another [`Modifiers`].", "documentation": "Checks if this [`Modifiers`] is a subset of another [`Modifiers`].", "signature": "pub fn is_subset_of (& self, other : & Modifiers) -> bool", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::modified", "name": "modified", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns whether any modifier key is pressed.", "documentation": "Returns whether any modifier key is pressed.", "signature": "pub fn modified (& self) -> bool", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::none", "name": "none", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with no modifiers.", "documentation": "Returns [`Modifiers`] with no modifiers.", "signature": "pub fn none () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::number_of_modifiers", "name": "number_of_modifiers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns how many modifier keys are pressed.", "documentation": "Returns how many modifier keys are pressed.", "signature": "pub fn number_of_modifiers (& self) -> u8", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::secondary", "name": "secondary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Whether the semantically 'secondary' modifier key is pressed.", "documentation": "Whether the semantically 'secondary' modifier key is pressed.\n\nOn macOS, this is the command key.\nOn Linux and Windows, this is the control key.", "signature": "pub fn secondary (& self) -> bool", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::secondary_key", "name": "secondary_key", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "A Returns [`Modifiers`] with just the secondary key pressed.", "documentation": "A Returns [`Modifiers`] with just the secondary key pressed.", "signature": "pub fn secondary_key () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::shift", "name": "shift", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just shift.", "documentation": "Returns [`Modifiers`] with just shift.", "signature": "pub fn shift () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::super_key", "name": "super_key", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just the super key.", "documentation": "Returns [`Modifiers`] with just the super key.", "signature": "pub fn super_key () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::keystroke::Modifiers::windows", "name": "windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::keystroke", "path": "gpui::platform::keystroke", "source": "crates/gpui/src/platform/keystroke.rs", "summary": "Returns [`Modifiers`] with just the windows key.", "documentation": "Returns [`Modifiers`] with just the windows key.", "signature": "pub fn windows () -> Modifiers", "cfg": [], "target": "Modifiers" }, { "id": "gpui::platform::layer_shell::KeyboardInteractivity", "name": "KeyboardInteractivity", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::layer_shell", "path": "gpui::platform::layer_shell", "source": "crates/gpui/src/platform/layer_shell.rs", "summary": "Keyboard interactivity mode for the layer_shell surfaces.", "documentation": "Keyboard interactivity mode for the layer_shell surfaces.", "signature": "# [doc = \" Keyboard interactivity mode for the layer_shell surfaces.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum KeyboardInteractivity { # [doc = \" No keyboard inputs will be delivered to the surface and it won't be able to receive\"] # [doc = \" keyboard focus.\"] None, # [doc = \" The surface will receive exclusive keyboard focus as long as it is above the shell surface\"] # [doc = \" layer, and no other layer_shell surfaces are above it.\"] Exclusive, # [doc = \" The surface can be focused similarly to a normal window.\"] # [default] OnDemand, }", "cfg": [] }, { "id": "gpui::platform::layer_shell::Layer", "name": "Layer", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::layer_shell", "path": "gpui::platform::layer_shell", "source": "crates/gpui/src/platform/layer_shell.rs", "summary": "The layer the surface is rendered on. Multiple surfaces can share a layer, and ordering within a single layer is undefined.", "documentation": "The layer the surface is rendered on. Multiple surfaces can share a layer, and ordering within\na single layer is undefined.", "signature": "# [doc = \" The layer the surface is rendered on. Multiple surfaces can share a layer, and ordering within\"] # [doc = \" a single layer is undefined.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum Layer { # [doc = \" The background layer, typically used for wallpapers.\"] Background, # [doc = \" The bottom layer.\"] Bottom, # [doc = \" The top layer, typically used for fullscreen windows.\"] Top, # [doc = \" The overlay layer, used for surfaces that should always be on top.\"] # [default] Overlay, }", "cfg": [] }, { "id": "gpui::platform::layer_shell::LayerShellNotSupportedError", "name": "LayerShellNotSupportedError", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::layer_shell", "path": "gpui::platform::layer_shell", "source": "crates/gpui/src/platform/layer_shell.rs", "summary": "An error indicating that an action failed because the compositor doesn't support the required layer_shell protocol.", "documentation": "An error indicating that an action failed because the compositor doesn't support the required\nlayer_shell protocol.", "signature": "# [doc = \" An error indicating that an action failed because the compositor doesn't support the required\"] # [doc = \" layer_shell protocol.\"] # [derive (Debug, Error)] # [error (\"Compositor doesn't support zwlr_layer_shell_v1\")] pub struct LayerShellNotSupportedError;", "cfg": [] }, { "id": "gpui::platform::layer_shell::LayerShellOptions", "name": "LayerShellOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::layer_shell", "path": "gpui::platform::layer_shell", "source": "crates/gpui/src/platform/layer_shell.rs", "summary": "Options for creating a layer_shell window.", "documentation": "Options for creating a layer_shell window.", "signature": "# [doc = \" Options for creating a layer_shell window.\"] # [derive (Clone, Debug, Default, PartialEq, Eq)] pub struct LayerShellOptions { # [doc = \" The namespace for the surface, mostly used by compositors to apply rules, can not be\"] # [doc = \" changed after the surface is created.\"] pub namespace : String, # [doc = \" The layer the surface is rendered on.\"] pub layer : Layer, # [doc = \" The anchor point of the surface.\"] pub anchor : Anchor, # [doc = \" Requests that the compositor avoids occluding an area with other surfaces.\"] pub exclusive_zone : Option, # [doc = \" The anchor point of the exclusive zone, will be determined using the anchor if left\"] # [doc = \" unspecified.\"] pub exclusive_edge : Option, # [doc = \" Margins between the surface and its anchor point(s).\"] # [doc = \" Specified in CSS order: top, right, bottom, left.\"] pub margin : Option<(Pixels, Pixels, Pixels, Pixels)>, # [doc = \" How keyboard events should be delivered to the surface.\"] pub keyboard_interactivity : KeyboardInteractivity, }", "cfg": [] }, { "id": "gpui::platform::native_menu::NativeMenuError", "name": "NativeMenuError", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Native capability/refusal errors. Only `NotSupported` permits an automatic in-window fallback; cancellation failure can leave an old native menu open.", "documentation": "Native capability/refusal errors. Only `NotSupported` permits an automatic\nin-window fallback; cancellation failure can leave an old native menu open.", "signature": "# [doc = \" Native capability/refusal errors. Only `NotSupported` permits an automatic\"] # [doc = \" in-window fallback; cancellation failure can leave an old native menu open.\"] # [derive (Debug, thiserror::Error)] pub enum NativeMenuError { # [doc = \" This platform does not present application context menus natively.\"] # [error (transparent)] NotSupported (# [from] NativeMenuNotSupportedError), # [doc = \" The OS refused to end an existing tracking loop. Its command is already\"] # [doc = \" invalidated, but its UI must not be reported as closed.\"] # [error (\"native context-menu cancellation failed: {0}\")] CancellationFailed (String), }", "cfg": [] }, { "id": "gpui::platform::native_menu::NativeMenuSession", "name": "NativeMenuSession", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Awaitable native menu presentation. Retain `id()` for cancellation/revision checks and `effect_owner()` when installing an asynchronous completion callback. Re-enter that owner with `App::with_effect_owner` inside callbacks; awaiting a future does not grant ambient authority to its caller.", "documentation": "Awaitable native menu presentation. Retain `id()` for cancellation/revision\nchecks and `effect_owner()` when installing an asynchronous completion\ncallback. Re-enter that owner with `App::with_effect_owner` inside callbacks;\nawaiting a future does not grant ambient authority to its caller.", "signature": "# [doc = \" Awaitable native menu presentation. Retain `id()` for cancellation/revision\"] # [doc = \" checks and `effect_owner()` when installing an asynchronous completion\"] # [doc = \" callback. Re-enter that owner with `App::with_effect_owner` inside callbacks;\"] # [doc = \" awaiting a future does not grant ambient authority to its caller.\"] pub struct NativeMenuSession { pub (crate) id : NativeMenuSessionId, pub (crate) owner : Option, pub (crate) task : Task, }", "cfg": [] }, { "id": "gpui::platform::native_menu::NativeMenuSession::detach", "name": "detach", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Allows dispatch/completion to run without awaiting its result.", "documentation": "Allows dispatch/completion to run without awaiting its result.", "signature": "pub fn detach (self)", "cfg": [], "target": "NativeMenuSession" }, { "id": "gpui::platform::native_menu::NativeMenuSession::effect_owner", "name": "effect_owner", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Explicit effect authority captured at presentation, never from focus.", "documentation": "Explicit effect authority captured at presentation, never from focus.", "signature": "pub fn effect_owner (& self) -> Option", "cfg": [], "target": "NativeMenuSession" }, { "id": "gpui::platform::native_menu::NativeMenuSession::id", "name": "id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "The revision that `Window::cancel_context_menu` can invalidate.", "documentation": "The revision that `Window::cancel_context_menu` can invalidate.", "signature": "pub fn id (& self) -> NativeMenuSessionId", "cfg": [], "target": "NativeMenuSession" }, { "id": "gpui::platform::native_menu::NativeMenuSessionId", "name": "NativeMenuSessionId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Opaque identity for one native menu revision, unique across windows/owners.", "documentation": "Opaque identity for one native menu revision, unique across windows/owners.", "signature": "# [doc = \" Opaque identity for one native menu revision, unique across windows/owners.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq, Hash)] pub struct NativeMenuSessionId (u64);", "cfg": [] }, { "id": "gpui::platform::native_menu::PlatformNativeMenuOutcome", "name": "PlatformNativeMenuOutcome", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Backend result, distinct from unsupported presentation and transport loss.", "documentation": "Backend result, distinct from unsupported presentation and transport loss.", "signature": "# [doc = \" Backend result, distinct from unsupported presentation and transport loss.\"] pub enum PlatformNativeMenuOutcome { # [doc = \" An enabled native command was chosen.\"] Selected (Box), # [doc = \" Tracking ended without choosing a command.\"] Dismissed, # [doc = \" Tracking ended after the revision was invalidated.\"] Cancelled, # [doc = \" Presentation failed; this is not user dismissal.\"] Unavailable, }", "cfg": [] }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession", "name": "PlatformNativeMenuSession", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Shared foreground-only lifecycle gate for native backend implementations. Replacements invalidate the old gate and await `finished()` before entering another modal native loop. A cancelled pending presentation must still wait for its predecessor before finishing, preserving the replacement chain.", "documentation": "Shared foreground-only lifecycle gate for native backend implementations.\nReplacements invalidate the old gate and await `finished()` before entering\nanother modal native loop. A cancelled pending presentation must still wait\nfor its predecessor before finishing, preserving the replacement chain.", "signature": "# [doc = \" Shared foreground-only lifecycle gate for native backend implementations.\"] # [doc = \" Replacements invalidate the old gate and await `finished()` before entering\"] # [doc = \" another modal native loop. A cancelled pending presentation must still wait\"] # [doc = \" for its predecessor before finishing, preserving the replacement chain.\"] # [derive (Clone)] pub struct PlatformNativeMenuSession { id : NativeMenuSessionId, state : Rc, finished : Shared>, }", "cfg": [] }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession::complete", "name": "complete", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Called only after tracking exits, or before tracking when presentation is cancelled/unavailable. Repeated/late completion cannot send twice.", "documentation": "Called only after tracking exits, or before tracking when presentation\nis cancelled/unavailable. Repeated/late completion cannot send twice.", "signature": "pub fn complete (& self, outcome : PlatformNativeMenuOutcome)", "cfg": [], "target": "PlatformNativeMenuSession" }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession::finished", "name": "finished", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Waits until tracking has ended (or its backend has disappeared).", "documentation": "Waits until tracking has ended (or its backend has disappeared).", "signature": "pub async fn finished (& self)", "cfg": [], "target": "PlatformNativeMenuSession" }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession::id", "name": "id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "The identity to compare before calling a native cancellation API.", "documentation": "The identity to compare before calling a native cancellation API.", "signature": "pub fn id (& self) -> NativeMenuSessionId", "cfg": [], "target": "PlatformNativeMenuSession" }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession::invalidate", "name": "invalidate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Prevents any late command from this presentation from being delivered. This does not claim that its native UI has closed.", "documentation": "Prevents any late command from this presentation from being delivered.\nThis does not claim that its native UI has closed.", "signature": "pub fn invalidate (& self)", "cfg": [], "target": "PlatformNativeMenuSession" }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession::is_invalidated", "name": "is_invalidated", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Whether the presentation must not begin tracking or deliver a command.", "documentation": "Whether the presentation must not begin tracking or deliver a command.", "signature": "pub fn is_invalidated (& self) -> bool", "cfg": [], "target": "PlatformNativeMenuSession" }, { "id": "gpui::platform::native_menu::PlatformNativeMenuSession::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::native_menu", "path": "gpui::platform::native_menu", "source": "crates/gpui/src/platform/native_menu.rs", "summary": "Creates one tracking lifetime for the Window-issued identity.", "documentation": "Creates one tracking lifetime for the Window-issued identity.", "signature": "pub fn new (id : NativeMenuSessionId) -> (Self, oneshot::Receiver)", "cfg": [], "target": "PlatformNativeMenuSession" }, { "id": "gpui::platform::platform_view::PlatformViewHosting", "name": "PlatformViewHosting", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "The bookkeeping a platform layer needs while it hosts native views, kept apart from the native calls so attach, reposition, restack and detach sequencing can be tested without a window.", "documentation": "The bookkeeping a platform layer needs while it hosts native views, kept\napart from the native calls so attach, reposition, restack and detach\nsequencing can be tested without a window.\n\n`A` carries whatever the platform layer captured at attach time and must put\nback verbatim at detach: on Windows the child window's parent, window styles\nand window region.", "signature": "# [doc = \" The bookkeeping a platform layer needs while it hosts native views, kept\"] # [doc = \" apart from the native calls so attach, reposition, restack and detach\"] # [doc = \" sequencing can be tested without a window.\"] # [doc = \"\"] # [doc = \" `A` carries whatever the platform layer captured at attach time and must put\"] # [doc = \" back verbatim at detach: on Windows the child window's parent, window styles\"] # [doc = \" and window region.\"] pub struct PlatformViewHosting { # [doc = \" Hosted views in the stacking order last applied, bottom-most first.\"] hosted : Vec>, }", "cfg": [] }, { "id": "gpui::platform::platform_view::PlatformViewHosting::attach", "name": "attach", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Records a view as hosted, stacked above every view hosted so far.", "documentation": "Records a view as hosted, stacked above every view hosted so far.\n\nAttaching a view that is already hosted replaces what has to be restored\nfor it and forgets its applied frame, so the next placement is applied\nunconditionally.", "signature": "pub fn attach (& mut self, id : PlatformViewId, attributes : A)", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::attributes", "name": "attributes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Returns what the platform layer must restore for a hosted view.", "documentation": "Returns what the platform layer must restore for a hosted view.", "signature": "pub fn attributes (& self, id : PlatformViewId) -> Option<& A>", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Returns whether the given view is hosted.", "documentation": "Returns whether the given view is hosted.", "signature": "pub fn contains (& self, id : PlatformViewId) -> bool", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::detach", "name": "detach", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Forgets a hosted view, returning what the platform layer must restore.", "documentation": "Forgets a hosted view, returning what the platform layer must restore.", "signature": "pub fn detach (& mut self, id : PlatformViewId) -> Option", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::detach_all", "name": "detach_all", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Forgets every hosted view, bottom-most first.", "documentation": "Forgets every hosted view, bottom-most first.", "signature": "pub fn detach_all (& mut self) -> Vec<(PlatformViewId, A)>", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::ids", "name": "ids", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Returns the hosted views in the stacking order last applied, bottom-most first.", "documentation": "Returns the hosted views in the stacking order last applied, bottom-most\nfirst.", "signature": "pub fn ids (& self) -> Vec", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Returns true while no view is hosted.", "documentation": "Returns true while no view is hosted.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::place", "name": "place", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Records the frame a hosted view was laid out at, returning the physical rectangle to move it to, or `None` when it already sits there.", "documentation": "Records the frame a hosted view was laid out at, returning the physical\nrectangle to move it to, or `None` when it already sits there.", "signature": "pub fn place (& mut self, id : PlatformViewId, bounds : Bounds, scale_factor : f32,) -> Option>", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewHosting::restack", "name": "restack", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Adopts `order` — bottom-most first — as the stacking order, returning true when it differs from the order last applied and the platform layer therefore has to restack.", "documentation": "Adopts `order` — bottom-most first — as the stacking order, returning\ntrue when it differs from the order last applied and the platform layer\ntherefore has to restack.\n\nIds that are not hosted are ignored, and hosted views the frame did not\nmention keep their relative order beneath the ordered ones.", "signature": "pub fn restack (& mut self, order : & [PlatformViewId]) -> bool", "cfg": [], "target": "PlatformViewHosting" }, { "id": "gpui::platform::platform_view::PlatformViewId", "name": "PlatformViewId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "The stable identity of a hosted platform view.", "documentation": "The stable identity of a hosted platform view.\n\nTwo handles referring to the same native view compare equal.", "signature": "# [doc = \" The stable identity of a hosted platform view.\"] # [doc = \"\"] # [doc = \" Two handles referring to the same native view compare equal.\"] # [derive (Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] pub struct PlatformViewId (usize);", "cfg": [] }, { "id": "gpui::platform::platform_view::PlatformViewId::as_usize", "name": "as_usize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Returns the identity as an opaque integer, useful for logging and for platform layers that key their own bookkeeping by view identity.", "documentation": "Returns the identity as an opaque integer, useful for logging and for\nplatform layers that key their own bookkeeping by view identity.", "signature": "pub fn as_usize (self) -> usize", "cfg": [], "target": "PlatformViewId" }, { "id": "gpui::platform::platform_view::PlatformViewPlacement", "name": "PlatformViewPlacement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "A hosted view and the window-space bounds GPUI laid it out at.", "documentation": "A hosted view and the window-space bounds GPUI laid it out at.\n\nBounds use GPUI's window coordinate space: logical pixels with the origin at\nthe window's top-left corner and y growing downwards. They are already\nsnapped to the display's device-pixel grid.", "signature": "# [doc = \" A hosted view and the window-space bounds GPUI laid it out at.\"] # [doc = \"\"] # [doc = \" Bounds use GPUI's window coordinate space: logical pixels with the origin at\"] # [doc = \" the window's top-left corner and y growing downwards. They are already\"] # [doc = \" snapped to the display's device-pixel grid.\"] # [derive (Clone, Debug)] pub struct PlatformViewPlacement { # [doc = \" The hosted view.\"] pub handle : PlatformViewHandle, # [doc = \" Where the view belongs within the window.\"] pub bounds : Bounds, }", "cfg": [] }, { "id": "gpui::platform::platform_view::PlatformViewPlacement::clip_bounds", "name": "clip_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "The visible part of [`bounds`](Self::bounds) after GPUI's nested content masks were applied.", "documentation": "The visible part of [`bounds`](Self::bounds) after GPUI's nested content\nmasks were applied.\n\nNative hosts keep the view at its full layout bounds and crop it to this\nrectangle. Resizing the view itself to this rectangle would change the\ncontent's layout instead of clipping it.", "signature": "pub fn clip_bounds (& self) -> Bounds", "cfg": [], "target": "PlatformViewPlacement" }, { "id": "gpui::platform::platform_view::PlatformViewPlacement::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Records a view's full layout rectangle and the visible rectangle left by clipping. The clip is constrained to the layout rectangle.", "documentation": "Records a view's full layout rectangle and the visible rectangle left by\nclipping. The clip is constrained to the layout rectangle.", "signature": "pub fn new (handle : PlatformViewHandle, bounds : Bounds, clip_bounds : Bounds,) -> Self", "cfg": [], "target": "PlatformViewPlacement" }, { "id": "gpui::platform::platform_view::PlatformViewUpdate", "name": "PlatformViewUpdate", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "The platform-view work owed by a single drawn frame.", "documentation": "The platform-view work owed by a single drawn frame.", "signature": "# [doc = \" The platform-view work owed by a single drawn frame.\"] # [derive (Clone, Debug, Default, PartialEq)] pub struct PlatformViewUpdate { # [doc = \" Views painted by this frame, in paint order, each at its current bounds.\"] # [doc = \" A view that was not hosted before is attached; one that already was is\"] # [doc = \" repositioned.\"] pub placements : Vec, # [doc = \" Views that were hosted by the previous frame but were not painted by this\"] # [doc = \" one, and so must be hidden and detached.\"] pub detached : Vec, }", "cfg": [] }, { "id": "gpui::platform::platform_view::PlatformViewUpdate::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Returns true when the frame asks for no platform-view work at all.", "documentation": "Returns true when the frame asks for no platform-view work at all.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "PlatformViewUpdate" }, { "id": "gpui::platform::platform_view::flip_bounds_origin_y", "name": "flip_bounds_origin_y", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Converts window-space bounds, whose origin is the window's top-left corner with y growing downwards, into the origin a bottom-left-origin coordinate system wants — the convention AppKit uses for a non-flipped `NSView`.", "documentation": "Converts window-space bounds, whose origin is the window's top-left corner\nwith y growing downwards, into the origin a bottom-left-origin coordinate\nsystem wants — the convention AppKit uses for a non-flipped `NSView`.\n\n`container_height` is the height of the view the hosted view is placed in.", "signature": "pub fn flip_bounds_origin_y (bounds : Bounds, container_height : Pixels) -> Point", "cfg": [] }, { "id": "gpui::platform::platform_view::platform_view_content_origin", "name": "platform_view_content_origin", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Places a full-size native view inside a clipped, non-flipped native container.", "documentation": "Places a full-size native view inside a clipped, non-flipped native\ncontainer.\n\nBoth inputs use GPUI's top-left-origin window coordinates. The returned\npoint uses the clip container's bottom-left-origin coordinates, as AppKit\ndoes for an ordinary `NSView`.", "signature": "pub fn platform_view_content_origin (bounds : Bounds, clip_bounds : Bounds,) -> Point", "cfg": [] }, { "id": "gpui::platform::platform_view::platform_view_physical_bounds", "name": "platform_view_physical_bounds", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Converts window-space bounds into the physical-pixel rectangle a platform layer positions a native view at.", "documentation": "Converts window-space bounds into the physical-pixel rectangle a platform\nlayer positions a native view at.\n\nWin32 and the other window systems that address windows in physical pixels\nneed this conversion; the size is clamped at zero so a degenerate layout\ncannot ask a native view for a negative extent.", "signature": "pub fn platform_view_physical_bounds (bounds : Bounds, scale_factor : f32,) -> Bounds", "cfg": [] }, { "id": "gpui::platform::platform_view::reexport-1", "name": "handle :: PlatformViewHandle", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "", "documentation": "", "signature": "pub use handle::PlatformViewHandle;", "cfg": [] }, { "id": "gpui::platform::platform_view::snap_platform_view_bounds", "name": "snap_platform_view_bounds", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform::platform_view", "path": "gpui::platform::platform_view", "source": "crates/gpui/src/platform/platform_view.rs", "summary": "Rounds window-space bounds onto the display's device-pixel grid, returning logical pixels again.", "documentation": "Rounds window-space bounds onto the display's device-pixel grid, returning\nlogical pixels again.\n\nNative views are positioned in logical points, so honoring the scale factor\nmeans landing on the same grid the renderer rasterizes GPUI content to;\notherwise a hosted view drifts by a fraction of a pixel against the GPUI\ncontent around it.", "signature": "pub fn snap_platform_view_bounds (bounds : Bounds, scale_factor : f32) -> Bounds", "cfg": [] }, { "id": "gpui::platform::popup::PopupAnchor", "name": "PopupAnchor", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::popup", "path": "gpui::platform::popup", "source": "crates/gpui/src/platform/popup.rs", "summary": "The point of the anchor rectangle that a popup is anchored to.", "documentation": "The point of the anchor rectangle that a popup is anchored to.", "signature": "# [doc = \" The point of the anchor rectangle that a popup is anchored to.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum PopupAnchor { # [doc = \" Anchor to the center of the anchor rectangle.\"] # [default] Center, # [doc = \" Anchor to the center of the top edge.\"] Top, # [doc = \" Anchor to the center of the bottom edge.\"] Bottom, # [doc = \" Anchor to the center of the left edge.\"] Left, # [doc = \" Anchor to the center of the right edge.\"] Right, # [doc = \" Anchor to the top-left corner.\"] TopLeft, # [doc = \" Anchor to the bottom-left corner.\"] BottomLeft, # [doc = \" Anchor to the top-right corner.\"] TopRight, # [doc = \" Anchor to the bottom-right corner.\"] BottomRight, }", "cfg": [] }, { "id": "gpui::platform::popup::PopupGravity", "name": "PopupGravity", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "platform::popup", "path": "gpui::platform::popup", "source": "crates/gpui/src/platform/popup.rs", "summary": "The direction in which a popup extends away from its anchor point.", "documentation": "The direction in which a popup extends away from its anchor point.\n\nFor instance, a gravity of [`PopupGravity::BottomRight`] places the popup below and to the\nright of the anchor point.", "signature": "# [doc = \" The direction in which a popup extends away from its anchor point.\"] # [doc = \"\"] # [doc = \" For instance, a gravity of [`PopupGravity::BottomRight`] places the popup below and to the\"] # [doc = \" right of the anchor point.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum PopupGravity { # [doc = \" The popup is centered over the anchor point.\"] # [default] Center, # [doc = \" The popup extends upwards from the anchor point.\"] Top, # [doc = \" The popup extends downwards from the anchor point.\"] Bottom, # [doc = \" The popup extends to the left of the anchor point.\"] Left, # [doc = \" The popup extends to the right of the anchor point.\"] Right, # [doc = \" The popup extends up and to the left of the anchor point.\"] TopLeft, # [doc = \" The popup extends down and to the left of the anchor point.\"] BottomLeft, # [doc = \" The popup extends up and to the right of the anchor point.\"] TopRight, # [doc = \" The popup extends down and to the right of the anchor point.\"] BottomRight, }", "cfg": [] }, { "id": "gpui::platform::popup::PopupNotSupportedError", "name": "PopupNotSupportedError", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::popup", "path": "gpui::platform::popup", "source": "crates/gpui/src/platform/popup.rs", "summary": "Returned when the current platform has no native popup implementation yet.", "documentation": "Returned when the current platform has no native popup implementation yet.\n\nNative popups are separate from gpui's in-window popovers, which are drawn as elements inside\nan existing window. A caller that wants a popup on every platform should treat this error as\na cue to fall back to that in-window rendering.", "signature": "# [doc = \" Returned when the current platform has no native popup implementation yet.\"] # [doc = \"\"] # [doc = \" Native popups are separate from gpui's in-window popovers, which are drawn as elements inside\"] # [doc = \" an existing window. A caller that wants a popup on every platform should treat this error as\"] # [doc = \" a cue to fall back to that in-window rendering.\"] # [derive (Debug, Error)] # [error (\"popups are not supported on this platform\")] pub struct PopupNotSupportedError;", "cfg": [] }, { "id": "gpui::platform::popup::PopupOptions", "name": "PopupOptions", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::popup", "path": "gpui::platform::popup", "source": "crates/gpui/src/platform/popup.rs", "summary": "Options for a parent-anchored popup window such as a menu, dropdown, context menu or tooltip.", "documentation": "Options for a parent-anchored popup window such as a menu, dropdown, context menu or tooltip.\n\nA popup is placed relative to an anchor rectangle on its parent window rather than at an\nabsolute screen position. The platform resolves the final position, so this works both on\nsystems where the compositor owns window placement (Wayland) and on platforms with absolute\ncoordinates.\n\nThe popup's size comes from [`WindowOptions::window_bounds`](crate::WindowOptions), whose\norigin is ignored. All coordinates are in logical pixels.", "signature": "# [doc = \" Options for a parent-anchored popup window such as a menu, dropdown, context menu or tooltip.\"] # [doc = \"\"] # [doc = \" A popup is placed relative to an anchor rectangle on its parent window rather than at an\"] # [doc = \" absolute screen position. The platform resolves the final position, so this works both on\"] # [doc = \" systems where the compositor owns window placement (Wayland) and on platforms with absolute\"] # [doc = \" coordinates.\"] # [doc = \"\"] # [doc = \" The popup's size comes from [`WindowOptions::window_bounds`](crate::WindowOptions), whose\"] # [doc = \" origin is ignored. All coordinates are in logical pixels.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct PopupOptions { # [doc = \" The window the popup is anchored to.\"] pub parent : AnyWindowHandle, # [doc = \" The rectangle the popup is positioned relative to, in the parent window's coordinate\"] # [doc = \" space (the same space element bounds are in). For example, a dropdown menu uses the\"] # [doc = \" bounds of the button that opened it.\"] pub anchor_rect : Bounds, # [doc = \" Which point of [`Self::anchor_rect`] the popup is anchored to.\"] pub anchor : PopupAnchor, # [doc = \" The direction in which the popup extends away from the anchor point. A dropdown that\"] # [doc = \" drops below its button anchors to [`PopupAnchor::BottomLeft`] with a gravity of\"] # [doc = \" [`PopupGravity::BottomRight`] so it grows down and to the right.\"] pub gravity : PopupGravity, # [doc = \" How the platform may adjust the popup if the requested placement would put it off-screen.\"] pub constraint_adjustment : PopupConstraintAdjustment, # [doc = \" An additional offset applied to the popup after anchoring.\"] pub offset : Point, # [doc = \" Whether the popup should take an explicit input grab.\"] # [doc = \"\"] # [doc = \" Grabbing popups behave like menus: they take keyboard focus and are dismissed when the\"] # [doc = \" user clicks outside of them or presses a dismissing key. Use it for menus and comboboxes,\"] # [doc = \" not for tooltips or other passive popups.\"] # [doc = \"\"] # [doc = \" A grab must be requested while the triggering input is still active, in practice the\"] # [doc = \" press of the mouse button that opens the popup. Open grabbing popups from a mouse-down\"] # [doc = \" handler rather than a click handler, otherwise the grab is refused.\"] # [doc = \"\"] # [doc = \" Automatic dismissal only covers input aimed at other applications. A click elsewhere in\"] # [doc = \" your own application still reaches it as usual, so closing the popup in that case is up\"] # [doc = \" to you. Nested grabbing popups must be closed in the reverse order they were opened.\"] pub grab : bool, }", "cfg": [] }, { "id": "gpui::platform::reexport-1", "name": "scheduler :: RunnableMeta", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub use scheduler::RunnableMeta;", "cfg": [] }, { "id": "gpui::platform::reexport-2", "name": "app_menu :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub use app_menu::*;", "cfg": [] }, { "id": "gpui::platform::reexport-3", "name": "keyboard :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub use keyboard::*;", "cfg": [] }, { "id": "gpui::platform::reexport-4", "name": "keystroke :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub use keystroke::*;", "cfg": [] }, { "id": "gpui::platform::reexport-5", "name": "native_menu :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub use native_menu::*;", "cfg": [] }, { "id": "gpui::platform::reexport-6", "name": "platform_view :: { PlatformViewHandle , PlatformViewHosting , PlatformViewId , PlatformViewPlacement , PlatformViewUpdate , flip_bounds_origin_y , platform_view_content_origin , platform_view_physical_bounds , snap_platform_view_bounds , }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "pub use platform_view::{ PlatformViewHandle, PlatformViewHosting, PlatformViewId, PlatformViewPlacement, PlatformViewUpdate, flip_bounds_origin_y, platform_view_content_origin, platform_view_physical_bounds, snap_platform_view_bounds, };", "cfg": [] }, { "id": "gpui::platform::reexport-7", "name": "test :: { TestDispatcher , TestScreenCaptureSource , TestScreenCaptureStream }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use test::{ TestDispatcher, TestScreenCaptureSource, TestScreenCaptureStream };", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::platform::reexport-8", "name": "threaded_dispatcher :: ThreadedDispatcher", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (test, feature = \"test-support\"))] pub use threaded_dispatcher::ThreadedDispatcher;", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ] }, { "id": "gpui::platform::reexport-9", "name": "visual_test :: VisualTestPlatform", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform", "path": "gpui::platform", "source": "crates/gpui/src/platform.rs", "summary": "", "documentation": "", "signature": "# [cfg (all (target_os = \"macos\", any (test, feature = \"test-support\")))] pub use visual_test::VisualTestPlatform;", "cfg": [ "cfg (all (target_os = \"macos\", any (test, feature = \"test-support\")))" ] }, { "id": "gpui::platform::scap_screen_capture::scap_screen_sources", "name": "scap_screen_sources", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "platform::scap_screen_capture", "path": "gpui::platform::scap_screen_capture", "source": "crates/gpui/src/platform/scap_screen_capture.rs", "summary": "Populates the receiver with the screens that can be captured.", "documentation": "Populates the receiver with the screens that can be captured.\n\n`scap_default_target_source` should be used instead on Wayland, since `scap_screen_sources`\nwon't return any results.", "signature": "pub fn scap_screen_sources (foreground_executor : & ForegroundExecutor,) -> oneshot::Receiver>>>", "cfg": [] }, { "id": "gpui::platform::test::dispatcher::TestDispatcher", "name": "TestDispatcher", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "TestDispatcher provides deterministic async execution for tests.", "documentation": "TestDispatcher provides deterministic async execution for tests.\n\nThis implementation delegates task scheduling to the scheduler crate's `TestScheduler`.\nAccess the scheduler directly via `scheduler()` for clock, rng, and parking control.", "signature": "# [doc = \" TestDispatcher provides deterministic async execution for tests.\"] # [doc = \"\"] # [doc = \" This implementation delegates task scheduling to the scheduler crate's `TestScheduler`.\"] # [doc = \" Access the scheduler directly via `scheduler()` for clock, rng, and parking control.\"] # [doc (hidden)] pub struct TestDispatcher { session_id : SessionId, scheduler : Arc, num_cpus_override : Arc, }", "cfg": [] }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::advance_clock", "name": "advance_clock", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn advance_clock (& self, by : Duration)", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::advance_clock_to_next_timer", "name": "advance_clock_to_next_timer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn advance_clock_to_next_timer (& self) -> bool", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::allow_parking", "name": "allow_parking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn allow_parking (& self)", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::drain_tasks", "name": "drain_tasks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn drain_tasks (& self)", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::forbid_parking", "name": "forbid_parking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn forbid_parking (& self)", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::from_scheduler", "name": "from_scheduler", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn from_scheduler (scheduler : Arc) -> Self", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn new (seed : u64) -> Self", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::num_cpus_override", "name": "num_cpus_override", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "Returns the overridden CPU count, or `None` if no override is set.", "documentation": "Returns the overridden CPU count, or `None` if no override is set.", "signature": "pub fn num_cpus_override (& self) -> Option", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::run_until_parked", "name": "run_until_parked", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn run_until_parked (& self)", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::scheduler", "name": "scheduler", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn scheduler (& self) -> & Arc", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::session_id", "name": "session_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn session_id (& self) -> SessionId", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::set_num_cpus", "name": "set_num_cpus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "Override the value returned by `BackgroundExecutor::num_cpus()` in tests. A value of 0 means no override (the default of 4 is used).", "documentation": "Override the value returned by `BackgroundExecutor::num_cpus()` in tests.\nA value of 0 means no override (the default of 4 is used).", "signature": "pub fn set_num_cpus (& self, count : usize)", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::simulate_random_delay", "name": "simulate_random_delay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_random_delay (& self) -> Yield", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::dispatcher::TestDispatcher::tick", "name": "tick", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::dispatcher", "path": "gpui::platform::test::dispatcher", "source": "crates/gpui/src/platform/test/dispatcher.rs", "summary": "", "documentation": "", "signature": "pub fn tick (& self, background_only : bool) -> bool", "cfg": [], "target": "TestDispatcher" }, { "id": "gpui::platform::test::display::TestDisplay::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::display", "path": "gpui::platform::test::display", "source": "crates/gpui/src/platform/test/display.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "TestDisplay" }, { "id": "gpui::platform::test::platform::TestPlatform::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::platform", "path": "gpui::platform::test::platform", "source": "crates/gpui/src/platform/test/platform.rs", "summary": "", "documentation": "", "signature": "pub fn new (executor : BackgroundExecutor, foreground_executor : ForegroundExecutor) -> Rc", "cfg": [], "target": "TestPlatform" }, { "id": "gpui::platform::test::platform::TestPlatform::with_platform", "name": "with_platform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::platform", "path": "gpui::platform::test::platform", "source": "crates/gpui/src/platform/test/platform.rs", "summary": "", "documentation": "", "signature": "pub fn with_platform (executor : BackgroundExecutor, foreground_executor : ForegroundExecutor, text_system : Arc, headless_renderer_factory : Option Option>>,>,) -> Rc", "cfg": [], "target": "TestPlatform" }, { "id": "gpui::platform::test::platform::TestPlatform::with_text_system", "name": "with_text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::platform", "path": "gpui::platform::test::platform", "source": "crates/gpui/src/platform/test/platform.rs", "summary": "", "documentation": "", "signature": "pub fn with_text_system (executor : BackgroundExecutor, foreground_executor : ForegroundExecutor, text_system : Arc,) -> Rc", "cfg": [], "target": "TestPlatform" }, { "id": "gpui::platform::test::platform::TestScreenCaptureSource", "name": "TestScreenCaptureSource", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::test::platform", "path": "gpui::platform::test::platform", "source": "crates/gpui/src/platform/test/platform.rs", "summary": "A fake screen capture source, used for testing.", "documentation": "A fake screen capture source, used for testing.", "signature": "# [derive (Clone)] # [doc = \" A fake screen capture source, used for testing.\"] pub struct TestScreenCaptureSource { }", "cfg": [] }, { "id": "gpui::platform::test::platform::TestScreenCaptureSource::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::platform", "path": "gpui::platform::test::platform", "source": "crates/gpui/src/platform/test/platform.rs", "summary": "Create a fake screen capture source, for testing.", "documentation": "Create a fake screen capture source, for testing.", "signature": "pub fn new () -> Self", "cfg": [], "target": "TestScreenCaptureSource" }, { "id": "gpui::platform::test::platform::TestScreenCaptureStream", "name": "TestScreenCaptureStream", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::test::platform", "path": "gpui::platform::test::platform", "source": "crates/gpui/src/platform/test/platform.rs", "summary": "A fake screen capture stream, used for testing.", "documentation": "A fake screen capture stream, used for testing.", "signature": "# [doc = \" A fake screen capture stream, used for testing.\"] pub struct TestScreenCaptureStream { }", "cfg": [] }, { "id": "gpui::platform::test::reexport-1", "name": "dispatcher :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform::test", "path": "gpui::platform::test", "source": "crates/gpui/src/platform/test.rs", "summary": "", "documentation": "", "signature": "pub use dispatcher::*;", "cfg": [] }, { "id": "gpui::platform::test::reexport-2", "name": "platform :: { TestScreenCaptureSource , TestScreenCaptureStream }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "platform::test", "path": "gpui::platform::test", "source": "crates/gpui/src/platform/test.rs", "summary": "", "documentation": "", "signature": "pub use platform::{ TestScreenCaptureSource, TestScreenCaptureStream };", "cfg": [] }, { "id": "gpui::platform::test::window::TestAtlas::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "TestAtlas" }, { "id": "gpui::platform::test::window::TestWindow", "name": "TestWindow", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone)] pub struct TestWindow (pub (crate) Rc>);", "cfg": [] }, { "id": "gpui::platform::test::window::TestWindow::external_drag_files", "name": "external_drag_files", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn external_drag_files (& self) -> Vec<(PathBuf, bool)>", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::set_scene_overlay_supported", "name": "set_scene_overlay_supported", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "Simulates a platform that can or cannot lift a scene into an overlay plane, like the neighbouring drag result this is a capability a test declares rather than a value the crate reads back.", "documentation": "Simulates a platform that can or cannot lift a scene into an overlay\nplane, like the neighbouring drag result this is a capability a test\ndeclares rather than a value the crate reads back.", "signature": "pub fn set_scene_overlay_supported (& self, supported : bool)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::set_start_external_drag_result", "name": "set_start_external_drag_result", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn set_start_external_drag_result (& self, result : bool)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::set_subpixel_rendering_supported", "name": "set_subpixel_rendering_supported", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "Simulates a platform that renders text with or without subpixel coverage.", "documentation": "Simulates a platform that renders text with or without subpixel\ncoverage.", "signature": "pub fn set_subpixel_rendering_supported (& self, supported : bool)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::simulate_a11y_activation", "name": "simulate_a11y_activation", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_a11y_activation (& self)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::simulate_appearance_change", "name": "simulate_appearance_change", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_appearance_change (& self, appearance : WindowAppearance)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::simulate_input", "name": "simulate_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_input (& mut self, event : PlatformInput) -> bool", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::simulate_request_frame", "name": "simulate_request_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_request_frame (& self, options : RequestFrameOptions)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::simulate_resize", "name": "simulate_resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_resize (& mut self, size : Size)", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::test::window::TestWindow::simulate_window_control_hit_test", "name": "simulate_window_control_hit_test", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::test::window", "path": "gpui::platform::test::window", "source": "crates/gpui/src/platform/test/window.rs", "summary": "", "documentation": "", "signature": "pub fn simulate_window_control_hit_test (& self, position : Point,) -> Option", "cfg": [], "target": "TestWindow" }, { "id": "gpui::platform::threaded_dispatcher::ThreadedDispatcher", "name": "ThreadedDispatcher", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::threaded_dispatcher", "path": "gpui::platform::threaded_dispatcher", "source": "crates/gpui/src/platform/threaded_dispatcher.rs", "summary": "A multithreaded [`PlatformDispatcher`] for tests and benchmarks.", "documentation": "A multithreaded [`PlatformDispatcher`] for tests and benchmarks.\n\nBackground tasks run in parallel on a pool of worker threads and timers fire\nin real time on a dedicated timer thread, mirroring the production\ndispatchers (see `LinuxDispatcher`). Main-thread tasks are queued until the\ncreating thread drains them via [`Self::run_until_idle`], since there is no\nplatform run loop pumping them.\n\nUnlike [`TestDispatcher`](crate::TestDispatcher), which runs everything on a\nsingle thread with a virtual clock, work dispatched through this dispatcher\nexecutes with production concurrency.", "signature": "# [doc = \" A multithreaded [`PlatformDispatcher`] for tests and benchmarks.\"] # [doc = \"\"] # [doc = \" Background tasks run in parallel on a pool of worker threads and timers fire\"] # [doc = \" in real time on a dedicated timer thread, mirroring the production\"] # [doc = \" dispatchers (see `LinuxDispatcher`). Main-thread tasks are queued until the\"] # [doc = \" creating thread drains them via [`Self::run_until_idle`], since there is no\"] # [doc = \" platform run loop pumping them.\"] # [doc = \"\"] # [doc = \" Unlike [`TestDispatcher`](crate::TestDispatcher), which runs everything on a\"] # [doc = \" single thread with a virtual clock, work dispatched through this dispatcher\"] # [doc = \" executes with production concurrency.\"] pub struct ThreadedDispatcher { background_sender : PriorityQueueSender, main_sender : PriorityQueueSender, main_receiver : Mutex>, timers : Arc, idle : Arc, main_thread_id : thread::ThreadId, }", "cfg": [] }, { "id": "gpui::platform::threaded_dispatcher::ThreadedDispatcher::cancel_pending_timers", "name": "cancel_pending_timers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::threaded_dispatcher", "path": "gpui::platform::threaded_dispatcher", "source": "crates/gpui/src/platform/threaded_dispatcher.rs", "summary": "Cancels all pending timers so timers armed by one workload can't fire during a later workload sharing this process-lifetime dispatcher.", "documentation": "Cancels all pending timers so timers armed by one workload can't fire\nduring a later workload sharing this process-lifetime dispatcher.\n\nDropping a timer runnable drops its completion sender, waking the task\nawaiting the timer. Call [`Self::run_until_idle`] after this method to\ndrain any work that cancellation unblocks.", "signature": "pub fn cancel_pending_timers (& self) -> usize", "cfg": [], "target": "ThreadedDispatcher" }, { "id": "gpui::platform::threaded_dispatcher::ThreadedDispatcher::debug_state", "name": "debug_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::threaded_dispatcher", "path": "gpui::platform::threaded_dispatcher", "source": "crates/gpui/src/platform/threaded_dispatcher.rs", "summary": "Describes the dispatcher's idle-tracking state, for diagnosing workloads that fail to reach quiescence.", "documentation": "Describes the dispatcher's idle-tracking state, for diagnosing\nworkloads that fail to reach quiescence.", "signature": "pub fn debug_state (& self) -> String", "cfg": [], "target": "ThreadedDispatcher" }, { "id": "gpui::platform::threaded_dispatcher::ThreadedDispatcher::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::threaded_dispatcher", "path": "gpui::platform::threaded_dispatcher", "source": "crates/gpui/src/platform/threaded_dispatcher.rs", "summary": "Creates a dispatcher whose main thread is the calling thread.", "documentation": "Creates a dispatcher whose main thread is the calling thread.\n\nWorker and timer threads live for the lifetime of the process; the\ndispatcher is expected to be created once and reused.", "signature": "pub fn new () -> Self", "cfg": [], "target": "ThreadedDispatcher" }, { "id": "gpui::platform::threaded_dispatcher::ThreadedDispatcher::run_ready_main_tasks", "name": "run_ready_main_tasks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::threaded_dispatcher", "path": "gpui::platform::threaded_dispatcher", "source": "crates/gpui/src/platform/threaded_dispatcher.rs", "summary": "Runs all main-thread tasks that are queued right now, without waiting for background work or timers to finish.", "documentation": "Runs all main-thread tasks that are queued right now, without waiting for\nbackground work or timers to finish.", "signature": "pub fn run_ready_main_tasks (& self) -> bool", "cfg": [], "target": "ThreadedDispatcher" }, { "id": "gpui::platform::threaded_dispatcher::ThreadedDispatcher::run_until_idle", "name": "run_until_idle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::threaded_dispatcher", "path": "gpui::platform::threaded_dispatcher", "source": "crates/gpui/src/platform/threaded_dispatcher.rs", "summary": "Runs queued main thread tasks and waits until no background or timer work is queued, running, or already due.", "documentation": "Runs queued main thread tasks and waits until no background or timer\nwork is queued, running, or already due.\n\nTimers that haven't reached their due time yet are *not* waited for:\nthe dispatcher runs in real time and cannot skip ahead like the\n`TestDispatcher`'s virtual clock, so waiting on a future timer would\nblock for its full real duration. Tasks sleeping on such timers are\nconsidered idle. Must be called on the thread that created this\ndispatcher.", "signature": "pub fn run_until_idle (& self)", "cfg": [], "target": "ThreadedDispatcher" }, { "id": "gpui::platform::visual_test::VisualTestPlatform", "name": "VisualTestPlatform", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform::visual_test", "path": "gpui::platform::visual_test", "source": "crates/gpui/src/platform/visual_test.rs", "summary": "A platform that combines real Mac rendering with controllable TestDispatcher.", "documentation": "A platform that combines real Mac rendering with controllable TestDispatcher.\n\nThis allows visual tests to:\n- Render real UI via Metal for accurate screenshots\n- Control task scheduling deterministically via TestDispatcher\n- Advance simulated time for testing time-based behaviors (tooltips, animations, etc.)", "signature": "# [doc = \" A platform that combines real Mac rendering with controllable TestDispatcher.\"] # [doc = \"\"] # [doc = \" This allows visual tests to:\"] # [doc = \" - Render real UI via Metal for accurate screenshots\"] # [doc = \" - Control task scheduling deterministically via TestDispatcher\"] # [doc = \" - Advance simulated time for testing time-based behaviors (tooltips, animations, etc.)\"] pub struct VisualTestPlatform { dispatcher : TestDispatcher, background_executor : BackgroundExecutor, foreground_executor : ForegroundExecutor, platform : Rc, clipboard : Mutex>, find_pasteboard : Mutex>, }", "cfg": [] }, { "id": "gpui::platform::visual_test::VisualTestPlatform::dispatcher", "name": "dispatcher", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::visual_test", "path": "gpui::platform::visual_test", "source": "crates/gpui/src/platform/visual_test.rs", "summary": "Returns a reference to the TestDispatcher for controlling task scheduling and time.", "documentation": "Returns a reference to the TestDispatcher for controlling task scheduling and time.", "signature": "pub fn dispatcher (& self) -> & TestDispatcher", "cfg": [], "target": "VisualTestPlatform" }, { "id": "gpui::platform::visual_test::VisualTestPlatform::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform::visual_test", "path": "gpui::platform::visual_test", "source": "crates/gpui/src/platform/visual_test.rs", "summary": "Creates a new VisualTestPlatform with the given random seed.", "documentation": "Creates a new VisualTestPlatform with the given random seed.\n\nThe seed is used for deterministic random number generation in the TestDispatcher.", "signature": "pub fn new (platform : Rc, seed : u64) -> Self", "cfg": [], "target": "VisualTestPlatform" }, { "id": "gpui::platform_scheduler::PlatformScheduler", "name": "PlatformScheduler", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "platform_scheduler", "path": "gpui::platform_scheduler", "source": "crates/gpui/src/platform_scheduler.rs", "summary": "A production implementation of [`Scheduler`] that wraps a [`PlatformDispatcher`].", "documentation": "A production implementation of [`Scheduler`] that wraps a [`PlatformDispatcher`].\n\nThis allows GPUI to use the scheduler crate's executor types with the platform's\nnative dispatch mechanisms (e.g., Grand Central Dispatch on macOS).", "signature": "# [doc = \" A production implementation of [`Scheduler`] that wraps a [`PlatformDispatcher`].\"] # [doc = \"\"] # [doc = \" This allows GPUI to use the scheduler crate's executor types with the platform's\"] # [doc = \" native dispatch mechanisms (e.g., Grand Central Dispatch on macOS).\"] pub struct PlatformScheduler { dispatcher : Arc, clock : Arc, next_session_id : AtomicU16, }", "cfg": [] }, { "id": "gpui::platform_scheduler::PlatformScheduler::foreground_executor", "name": "foreground_executor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform_scheduler", "path": "gpui::platform_scheduler", "source": "crates/gpui/src/platform_scheduler.rs", "summary": "", "documentation": "", "signature": "pub fn foreground_executor (self : & Arc) -> LocalExecutor", "cfg": [], "target": "PlatformScheduler" }, { "id": "gpui::platform_scheduler::PlatformScheduler::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "platform_scheduler", "path": "gpui::platform_scheduler", "source": "crates/gpui/src/platform_scheduler.rs", "summary": "", "documentation": "", "signature": "pub fn new (dispatcher : Arc) -> Self", "cfg": [], "target": "PlatformScheduler" }, { "id": "gpui::prelude::reexport-1", "name": "crate :: { AppContext as _ , BorrowAppContext , Context , Element , InteractiveElement , IntoElement , ParentElement , Refineable , Render , RenderOnce , StatefulInteractiveElement , Styled , StyledImage , TaskExt as _ , VisualContext , util :: FluentBuilder , }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "prelude", "path": "gpui::prelude", "source": "crates/gpui/src/prelude.rs", "summary": "", "documentation": "", "signature": "pub use crate::{ AppContext as _, BorrowAppContext, Context, Element, InteractiveElement, IntoElement, ParentElement, Refineable, Render, RenderOnce, StatefulInteractiveElement, Styled, StyledImage, TaskExt as _, VisualContext, util::FluentBuilder, };", "cfg": [] }, { "id": "gpui::profiler::ActiveTiming", "name": "ActiveTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Debug, Copy, Clone)] pub struct ActiveTiming { pub location : & 'static core::panic::Location<'static>, pub spawned : SpawnTime, pub start : Instant, }", "cfg": [] }, { "id": "gpui::profiler::FrameStats", "name": "FrameStats", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Deterministic structural work performed while drawing one window frame.", "documentation": "Deterministic structural work performed while drawing one window frame.\n\nUnlike [`FrameTiming`], these counters do not depend on machine speed. They\nare always collected so tests and diagnostics can enforce that work stays\nproportional to the viewport rather than to the size of a caller's data\nset. Allocation accounting is optional because it is only available when\nGPUI is built with test support.", "signature": "# [doc = \" Deterministic structural work performed while drawing one window frame.\"] # [doc = \"\"] # [doc = \" Unlike [`FrameTiming`], these counters do not depend on machine speed. They\"] # [doc = \" are always collected so tests and diagnostics can enforce that work stays\"] # [doc = \" proportional to the viewport rather than to the size of a caller's data\"] # [doc = \" set. Allocation accounting is optional because it is only available when\"] # [doc = \" GPUI is built with test support.\"] # [derive (Debug, Copy, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] pub struct FrameStats { # [doc = \" Monotonically increasing frame number for this window.\"] pub frame_index : u64, # [doc = \" Reactive view entities whose [`crate::Render::render`] method ran.\"] pub entity_renders : u64, # [doc = \" Element request-layout calls.\"] pub request_layout_calls : u64, # [doc = \" Element prepaint calls.\"] pub prepaint_calls : u64, # [doc = \" Element paint calls.\"] pub paint_calls : u64, # [doc = \" Invalidations coalesced into this frame.\"] pub invalidations : u64, # [doc = \" Product semantic nodes published while this frame was painted.\"] pub semantic_nodes : u64, # [doc = \" Native platform-view placements retained by the completed frame.\"] pub platform_view_placements : u64, # [doc = \" Growth in the retained element-arena capacity during this frame.\"] # [doc = \"\"] # [doc = \" `None` means the active build does not include allocator accounting.\"] pub allocator_delta_bytes : Option, }", "cfg": [] }, { "id": "gpui::profiler::FrameSubmissionTiming", "name": "FrameSubmissionTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Timing for one newly drawn frame submitted to the platform.", "documentation": "Timing for one newly drawn frame submitted to the platform.\n\n`submission_end` is sampled when the synchronous platform draw call\nreturns. It proves that GPUI handed the frame to the platform renderer; it\ndoes not claim that a compositor or display has presented the frame.", "signature": "# [doc = \" Timing for one newly drawn frame submitted to the platform.\"] # [doc = \"\"] # [doc = \" `submission_end` is sampled when the synchronous platform draw call\"] # [doc = \" returns. It proves that GPUI handed the frame to the platform renderer; it\"] # [doc = \" does not claim that a compositor or display has presented the frame.\"] # [derive (Debug, Copy, Clone)] pub struct FrameSubmissionTiming { # [doc = \" The draw whose scene was submitted.\"] pub frame : FrameTiming, # [doc = \" When platform submission began.\"] pub submission_start : Instant, # [doc = \" When the platform draw call returned.\"] pub submission_end : Instant, # [doc = \" The first input that invalidated work included in this submission, if\"] # [doc = \" one was observed while tracing was active.\"] pub first_input_at : Option, # [doc = \" Number of invalidating top-level input events coalesced into this\"] # [doc = \" submission.\"] pub input_events : u64, }", "cfg": [] }, { "id": "gpui::profiler::FrameSubmissionTiming::dirty_to_submission_duration", "name": "dirty_to_submission_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Time from the first observed invalidation until platform submission returned.", "documentation": "Time from the first observed invalidation until platform submission\nreturned.", "signature": "pub fn dirty_to_submission_duration (& self) -> Option", "cfg": [], "target": "FrameSubmissionTiming" }, { "id": "gpui::profiler::FrameSubmissionTiming::draw_to_submission_duration", "name": "draw_to_submission_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Time from the draw start until platform submission returned.", "documentation": "Time from the draw start until platform submission returned.", "signature": "pub fn draw_to_submission_duration (& self) -> Duration", "cfg": [], "target": "FrameSubmissionTiming" }, { "id": "gpui::profiler::FrameSubmissionTiming::input_to_submission_duration", "name": "input_to_submission_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Time from the first coalesced input until platform submission returned.", "documentation": "Time from the first coalesced input until platform submission returned.", "signature": "pub fn input_to_submission_duration (& self) -> Option", "cfg": [], "target": "FrameSubmissionTiming" }, { "id": "gpui::profiler::FrameSubmissionTiming::submission_duration", "name": "submission_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Time spent in the platform submission call.", "documentation": "Time spent in the platform submission call.", "signature": "pub fn submission_duration (& self) -> Duration", "cfg": [], "target": "FrameSubmissionTiming" }, { "id": "gpui::profiler::FrameSubmissionTimingCollector", "name": "FrameSubmissionTimingCollector", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Drains platform-submission timings observed after this collector was created. Each sample belongs to a newly drawn frame; requests that resubmit unchanged scene contents are not included.", "documentation": "Drains platform-submission timings observed after this collector was\ncreated. Each sample belongs to a newly drawn frame; requests that resubmit\nunchanged scene contents are not included.", "signature": "# [doc = \" Drains platform-submission timings observed after this collector was\"] # [doc = \" created. Each sample belongs to a newly drawn frame; requests that resubmit\"] # [doc = \" unchanged scene contents are not included.\"] pub struct FrameSubmissionTimingCollector { cursor : u64, }", "cfg": [] }, { "id": "gpui::profiler::FrameSubmissionTimingCollector::collect_unseen", "name": "collect_unseen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Returns newly observed frame submissions. If the shared ring wrapped since the previous poll, evicted entries are lost.", "documentation": "Returns newly observed frame submissions. If the shared ring wrapped\nsince the previous poll, evicted entries are lost.", "signature": "pub fn collect_unseen (& mut self) -> Vec", "cfg": [], "target": "FrameSubmissionTimingCollector" }, { "id": "gpui::profiler::FrameSubmissionTimingCollector::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Creates a collector that only sees submissions recorded from this point on. Hold a [`FrameTraceLease`] for the collector's lifetime.", "documentation": "Creates a collector that only sees submissions recorded from this point\non. Hold a [`FrameTraceLease`] for the collector's lifetime.", "signature": "pub fn new () -> Self", "cfg": [], "target": "FrameSubmissionTimingCollector" }, { "id": "gpui::profiler::FrameTiming", "name": "FrameTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Timing for a single drawn window frame.", "documentation": "Timing for a single drawn window frame.", "signature": "# [doc = \" Timing for a single drawn window frame.\"] # [derive (Debug, Copy, Clone)] pub struct FrameTiming { # [doc = \" The window that was drawn.\"] pub window_id : WindowId, # [doc = \" When the frame first became dirty (its first invalidation). `None` if\"] # [doc = \" frame tracing was not yet enabled when the invalidation occurred.\"] pub dirty_at : Option, # [doc = \" Number of invalidations coalesced into this frame.\"] pub invalidations : u64, # [doc = \" When `Window::draw` started.\"] pub draw_start : Instant, # [doc = \" When `Window::draw` finished.\"] pub draw_end : Instant, }", "cfg": [] }, { "id": "gpui::profiler::FrameTiming::dirty_to_draw_duration", "name": "dirty_to_draw_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Time from the frame's first invalidation to the end of its draw, if the first invalidation was observed.", "documentation": "Time from the frame's first invalidation to the end of its draw, if the\nfirst invalidation was observed.", "signature": "pub fn dirty_to_draw_duration (& self) -> Option", "cfg": [], "target": "FrameTiming" }, { "id": "gpui::profiler::FrameTiming::draw_duration", "name": "draw_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Time spent inside `Window::draw`.", "documentation": "Time spent inside `Window::draw`.", "signature": "pub fn draw_duration (& self) -> Duration", "cfg": [], "target": "FrameTiming" }, { "id": "gpui::profiler::FrameTimingCollector", "name": "FrameTimingCollector", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Drains frame timings recorded after this collector was created, tracking a cursor so each call to [`Self::collect_unseen`] returns only new entries.", "documentation": "Drains frame timings recorded after this collector was created, tracking a\ncursor so each call to [`Self::collect_unseen`] returns only new entries.", "signature": "# [doc = \" Drains frame timings recorded after this collector was created, tracking a\"] # [doc = \" cursor so each call to [`Self::collect_unseen`] returns only new entries.\"] pub struct FrameTimingCollector { cursor : u64, }", "cfg": [] }, { "id": "gpui::profiler::FrameTimingCollector::collect_unseen", "name": "collect_unseen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Returns frame timings recorded since the previous call (or since the collector was created). If the ring buffer wrapped around since the previous poll, the evicted entries are lost.", "documentation": "Returns frame timings recorded since the previous call (or since the\ncollector was created). If the ring buffer wrapped around since the\nprevious poll, the evicted entries are lost.", "signature": "pub fn collect_unseen (& mut self) -> Vec", "cfg": [], "target": "FrameTimingCollector" }, { "id": "gpui::profiler::FrameTimingCollector::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Creates a collector that only sees frames recorded from this point on.", "documentation": "Creates a collector that only sees frames recorded from this point on.", "signature": "pub fn new () -> Self", "cfg": [], "target": "FrameTimingCollector" }, { "id": "gpui::profiler::FrameTimingMonitor", "name": "FrameTimingMonitor", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Observes existing submitted frames for one window and keeps a bounded history.", "documentation": "Observes existing submitted frames for one window and keeps a bounded\nhistory.\n\nThe monitor owns a [`FrameTraceLease`] but never refreshes the window. A\nhost chooses when to call [`Self::collect`] and whether its workload should\nproduce another frame, so displaying diagnostics does not silently create\na continuous redraw loop.", "signature": "# [doc = \" Observes existing submitted frames for one window and keeps a bounded\"] # [doc = \" history.\"] # [doc = \"\"] # [doc = \" The monitor owns a [`FrameTraceLease`] but never refreshes the window. A\"] # [doc = \" host chooses when to call [`Self::collect`] and whether its workload should\"] # [doc = \" produce another frame, so displaying diagnostics does not silently create\"] # [doc = \" a continuous redraw loop.\"] pub struct FrameTimingMonitor { window_id : WindowId, capacity : usize, frame_budget : Duration, samples : VecDeque, collector : FrameSubmissionTimingCollector, _lease : FrameTraceLease, }", "cfg": [] }, { "id": "gpui::profiler::FrameTimingMonitor::collect", "name": "collect", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Collects newly submitted frames, discarding frames from other windows, and returns the current summary once two target-window submissions exist.", "documentation": "Collects newly submitted frames, discarding frames from other windows,\nand returns the current summary once two target-window submissions\nexist.", "signature": "pub fn collect (& mut self) -> Option", "cfg": [], "target": "FrameTimingMonitor" }, { "id": "gpui::profiler::FrameTimingMonitor::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Creates a monitor for `window_id`. A zero capacity retains one sample, although a summary is unavailable until two submissions are observed.", "documentation": "Creates a monitor for `window_id`. A zero capacity retains one sample,\nalthough a summary is unavailable until two submissions are observed.", "signature": "pub fn new (window_id : WindowId, capacity : usize, frame_budget : Duration) -> Self", "cfg": [], "target": "FrameTimingMonitor" }, { "id": "gpui::profiler::FrameTimingMonitor::sample_count", "name": "sample_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Number of currently retained target-window submissions.", "documentation": "Number of currently retained target-window submissions.", "signature": "pub fn sample_count (& self) -> usize", "cfg": [], "target": "FrameTimingMonitor" }, { "id": "gpui::profiler::FrameTimingMonitor::summary", "name": "summary", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Summarizes the retained samples without consuming them.", "documentation": "Summarizes the retained samples without consuming them.", "signature": "pub fn summary (& self) -> Option", "cfg": [], "target": "FrameTimingMonitor" }, { "id": "gpui::profiler::FrameTimingMonitor::window_id", "name": "window_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "The only window whose draws this monitor retains.", "documentation": "The only window whose draws this monitor retains.", "signature": "pub fn window_id (& self) -> WindowId", "cfg": [], "target": "FrameTimingMonitor" }, { "id": "gpui::profiler::FrameTimingSummary", "name": "FrameTimingSummary", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "A bounded, per-window summary of observed submitted-frame work.", "documentation": "A bounded, per-window summary of observed submitted-frame work.", "signature": "# [doc = \" A bounded, per-window summary of observed submitted-frame work.\"] # [derive (Debug, Clone, PartialEq)] pub struct FrameTimingSummary { # [doc = \" Number of retained target-window submissions represented by this\"] # [doc = \" summary.\"] pub sample_count : usize, # [doc = \" Newly drawn submissions per second, computed from their completion\"] # [doc = \" timestamps rather than from the monitor's polling cadence.\"] pub frames_per_second : f64, # [doc = \" Caller-supplied threshold used to classify draw-budget overage.\"] pub frame_budget : Duration, # [doc = \" Arithmetic mean of retained `Window::draw` durations.\"] pub mean_draw_duration : Duration, # [doc = \" Nearest-rank 95th percentile of retained draw durations.\"] pub p95_draw_duration : Duration, # [doc = \" Fraction of retained draws whose own duration exceeded `frame_budget`.\"] # [doc = \" This is draw-budget overage, not a claim about display drops.\"] pub over_budget_fraction : f64, # [doc = \" Arithmetic mean of invalidations coalesced into each retained draw.\"] pub mean_invalidations : f64, # [doc = \" Mean first-dirty-to-draw-end latency for samples whose first\"] # [doc = \" invalidation was observed after tracing began.\"] pub mean_dirty_to_draw_duration : Option, # [doc = \" Arithmetic mean of time spent in the synchronous platform submission\"] # [doc = \" call. This is not compositor or display presentation time.\"] pub mean_submission_duration : Duration, # [doc = \" Mean first-dirty-to-submission-end latency for samples whose first\"] # [doc = \" invalidation was observed after tracing began.\"] pub mean_dirty_to_submission_duration : Option, # [doc = \" Mean first-input-to-submission-end latency for submitted frames caused\"] # [doc = \" by input observed after tracing began.\"] pub mean_input_to_submission_duration : Option, # [doc = \" Arithmetic mean of invalidating top-level input events coalesced into a\"] # [doc = \" submitted frame.\"] pub mean_input_events : f64, # [doc = \" Draw durations in retained timestamp order, for caller-owned plots.\"] pub draw_durations : Vec, # [doc = \" Platform submission-call durations in retained timestamp order, for\"] # [doc = \" caller-owned plots.\"] pub submission_durations : Vec, }", "cfg": [] }, { "id": "gpui::profiler::FrameTraceLease", "name": "FrameTraceLease", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "A reference-counted owner of frame timing collection.", "documentation": "A reference-counted owner of frame timing collection.\n\nAcquire a lease before creating a [`FrameTimingCollector`]. Dropping one\nlease cannot disable tracing requested manually or by another consumer.\nA lease records existing application redraws; it never schedules frames.", "signature": "# [doc = \" A reference-counted owner of frame timing collection.\"] # [doc = \"\"] # [doc = \" Acquire a lease before creating a [`FrameTimingCollector`]. Dropping one\"] # [doc = \" lease cannot disable tracing requested manually or by another consumer.\"] # [doc = \" A lease records existing application redraws; it never schedules frames.\"] # [derive (Debug)] pub struct FrameTraceLease { active : bool, }", "cfg": [] }, { "id": "gpui::profiler::FrameTraceLease::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Acquires one independent owner of frame timing collection.", "documentation": "Acquires one independent owner of frame timing collection.", "signature": "pub fn new () -> Self", "cfg": [], "target": "FrameTraceLease" }, { "id": "gpui::profiler::GLOBAL_THREAD_TIMINGS", "name": "GLOBAL_THREAD_TIMINGS", "kind": "static", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub static GLOBAL_THREAD_TIMINGS: spin::Mutex>", "cfg": [] }, { "id": "gpui::profiler::GlobalThreadTimings", "name": "GlobalThreadTimings", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct GlobalThreadTimings { pub thread_id : ThreadId, pub timings : std::sync::Weak, }", "cfg": [] }, { "id": "gpui::profiler::GuardedTaskTimings", "name": "GuardedTaskTimings", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub type GuardedTaskTimings = spin::Mutex;", "cfg": [] }, { "id": "gpui::profiler::ProfilingCollector", "name": "ProfilingCollector", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Tracks which timing events have already been seen so that callers can request only unseen events.", "documentation": "Tracks which timing events have already been seen so that callers can request only unseen events.", "signature": "# [doc = \" Tracks which timing events have already been seen so that callers can request only unseen events.\"] # [doc (hidden)] pub struct ProfilingCollector { startup_time : Instant, cursors : HashMap, }", "cfg": [] }, { "id": "gpui::profiler::ProfilingCollector::collect_unseen", "name": "collect_unseen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn collect_unseen (& mut self, all_timings : Vec,) -> Vec", "cfg": [], "target": "ProfilingCollector" }, { "id": "gpui::profiler::ProfilingCollector::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn new (startup_time : Instant) -> Self", "cfg": [], "target": "ProfilingCollector" }, { "id": "gpui::profiler::ProfilingCollector::reset", "name": "reset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn reset (& mut self)", "cfg": [], "target": "ProfilingCollector" }, { "id": "gpui::profiler::ProfilingCollector::startup_time", "name": "startup_time", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn startup_time (& self) -> Instant", "cfg": [], "target": "ProfilingCollector" }, { "id": "gpui::profiler::SerializedLocation", "name": "SerializedLocation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Serializable variant of [`core::panic::Location`]", "documentation": "Serializable variant of [`core::panic::Location`]", "signature": "# [doc = \" Serializable variant of [`core::panic::Location`]\"] # [derive (Debug, Clone, Serialize, Deserialize)] pub struct SerializedLocation { # [doc = \" Name of the source file\"] pub file : SharedString, # [doc = \" Line in the source file\"] pub line : u32, # [doc = \" Column in the source file\"] pub column : u32, }", "cfg": [] }, { "id": "gpui::profiler::SerializedTaskTiming", "name": "SerializedTaskTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Serializable variant of [`TaskTiming`]", "documentation": "Serializable variant of [`TaskTiming`]", "signature": "# [doc = \" Serializable variant of [`TaskTiming`]\"] # [derive (Debug, Clone, Serialize, Deserialize)] pub struct SerializedTaskTiming { # [doc = \" Location of the timing\"] pub location : SerializedLocation, # [doc = \" Time at which the measurement was reported in nanoseconds\"] pub start : u128, # [doc = \" Duration of the measurement in nanoseconds\"] pub duration : u128, }", "cfg": [] }, { "id": "gpui::profiler::SerializedTaskTiming::convert", "name": "convert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Convert an array of [`TaskTiming`] into their serializable format", "documentation": "Convert an array of [`TaskTiming`] into their serializable format\n\n# Params\n\n`anchor` - [`Instant`] that should be earlier than all timings to use as base anchor", "signature": "pub fn convert (anchor : Instant, timings : & [TaskTiming]) -> Vec", "cfg": [], "target": "SerializedTaskTiming" }, { "id": "gpui::profiler::SerializedTaskTiming::from", "name": "from", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "`anchor` - [`Instant`] that should be earlier than all timings to use as base anchor", "documentation": "`anchor` - [`Instant`] that should be earlier than all timings to use as base anchor", "signature": "pub fn from (anchor : Instant, timing : TaskTiming) -> SerializedTaskTiming", "cfg": [], "target": "SerializedTaskTiming" }, { "id": "gpui::profiler::SerializedThreadTaskTimings", "name": "SerializedThreadTaskTimings", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Serializable variant of [`ThreadTaskTimings`]", "documentation": "Serializable variant of [`ThreadTaskTimings`]", "signature": "# [doc = \" Serializable variant of [`ThreadTaskTimings`]\"] # [derive (Debug, Clone, Serialize, Deserialize)] pub struct SerializedThreadTaskTimings { # [doc = \" Thread name\"] pub thread_name : Option, # [doc = \" Hash of the thread id\"] pub thread_id : u64, # [doc = \" Timing records for this thread\"] pub timings : Vec, }", "cfg": [] }, { "id": "gpui::profiler::SerializedThreadTaskTimings::convert", "name": "convert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Convert [`ThreadTaskTimings`] into their serializable format", "documentation": "Convert [`ThreadTaskTimings`] into their serializable format\n\n# Params\n\n`anchor` - [`Instant`] that should be earlier than all timings to use as base anchor", "signature": "pub fn convert (anchor : Instant, timings : ThreadTaskTimings) -> SerializedThreadTaskTimings", "cfg": [], "target": "SerializedThreadTaskTimings" }, { "id": "gpui::profiler::TaskStatistics", "name": "TaskStatistics", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Debug, Clone)] pub struct TaskStatistics { pub poll_time_to_beat : Duration, pub runtime_to_beat : Duration, pub longest_poll_times : [TaskTiming; 5], pub longest_runtimes : [TaskTiming; 5], }", "cfg": [] }, { "id": "gpui::profiler::TaskTiming", "name": "TaskTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Copy, Clone)] pub struct TaskTiming { pub location : & 'static core::panic::Location<'static>, pub spawned : SpawnTime, pub start : Instant, pub end : YieldTime, }", "cfg": [] }, { "id": "gpui::profiler::TaskTiming::placeholder", "name": "placeholder", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "A task timing with a duration of zero. Any task will replace this in history.", "documentation": "A task timing with a duration of zero. Any task will replace this in history.", "signature": "pub fn placeholder () -> Self", "cfg": [], "target": "TaskTiming" }, { "id": "gpui::profiler::TaskTiming::poll_duration", "name": "poll_duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn poll_duration (& self) -> Duration", "cfg": [], "target": "TaskTiming" }, { "id": "gpui::profiler::ThreadTaskStatistics", "name": "ThreadTaskStatistics", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Debug)] pub struct ThreadTaskStatistics { pub thread_name : Option, pub thread_id : ThreadId, pub stats : TaskStatistics, }", "cfg": [] }, { "id": "gpui::profiler::ThreadTaskStatistics::collect_and_reset", "name": "collect_and_reset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn collect_and_reset (timings : Vec<(ThreadId, Arc)>, include_running : TasksIncluded,) -> Vec", "cfg": [], "target": "ThreadTaskStatistics" }, { "id": "gpui::profiler::ThreadTaskTimings", "name": "ThreadTaskTimings", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Debug, Clone)] pub struct ThreadTaskTimings { pub thread_name : Option, pub thread_id : ThreadId, pub timings : Vec, pub stats : TaskStatistics, pub total_pushed : u64, }", "cfg": [] }, { "id": "gpui::profiler::ThreadTaskTimings::collect", "name": "collect", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Convert upgraded per-thread timings into their structured format.", "documentation": "Convert upgraded per-thread timings into their structured format.", "signature": "pub fn collect (timings : Vec<(ThreadId, Arc)>, included : TasksIncluded,) -> Vec", "cfg": [], "target": "ThreadTaskTimings" }, { "id": "gpui::profiler::ThreadTimings", "name": "ThreadTimings", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct ThreadTimings { pub thread_name : Option, pub thread_id : ThreadId, pub timings : TaskTimings, pub running : Option, pub stats : TaskStatistics, pub total_pushed : u64, }", "cfg": [] }, { "id": "gpui::profiler::ThreadTimings::get_thread_task_timings", "name": "get_thread_task_timings", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn get_thread_task_timings (& self, includes : TasksIncluded) -> ThreadTaskTimings", "cfg": [], "target": "ThreadTimings" }, { "id": "gpui::profiler::ThreadTimings::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn new (thread_name : Option, thread_id : ThreadId) -> Self", "cfg": [], "target": "ThreadTimings" }, { "id": "gpui::profiler::ThreadTimings::save_task_timing", "name": "save_task_timing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn save_task_timing (& mut self, _ : YieldTime)", "cfg": [ "cfg (not (feature = \"profiler\"))" ], "target": "ThreadTimings" }, { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn save_task_timing (& mut self, ended : YieldTime)", "cfg": [ "cfg (feature = \"profiler\")" ], "target": "ThreadTimings" } ] }, { "id": "gpui::profiler::ThreadTimings::update_running_task", "name": "update_running_task", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn update_running_task (& mut self, _ : SpawnTime, _ : & 'static std::panic::Location<'_>)", "cfg": [ "cfg (not (feature = \"profiler\"))" ], "target": "ThreadTimings" }, { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn update_running_task (& mut self, spawned : SpawnTime, location : & 'static std::panic::Location<'_>,)", "cfg": [ "cfg (feature = \"profiler\")" ], "target": "ThreadTimings" } ] }, { "id": "gpui::profiler::ThreadTimingsDelta", "name": "ThreadTimingsDelta", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Debug, Clone)] pub struct ThreadTimingsDelta { # [doc = \" Hashed thread id\"] pub thread_id : u64, # [doc = \" Thread name, if known\"] pub thread_name : Option, # [doc = \" New timings since the last call. If the circular buffer wrapped around\"] # [doc = \" since the previous poll, some entries may have been lost.\"] pub new_timings : Vec, }", "cfg": [] }, { "id": "gpui::profiler::YieldTime", "name": "YieldTime", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Debug, Copy, Clone)] pub struct YieldTime (pub Instant);", "cfg": [] }, { "id": "gpui::profiler::actions::ActionStatistics", "name": "ActionStatistics", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] # [derive (Clone)] pub struct ActionStatistics { runtime_to_beat : Duration, longest_runtimes : heapless::Vec, running : Option<(& 'static str, Instant)>, }", "cfg": [] }, { "id": "gpui::profiler::actions::ActionStatistics::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "", "documentation": "", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "ActionStatistics" }, { "id": "gpui::profiler::actions::ActionStatistics::longest_runtimes", "name": "longest_runtimes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "", "documentation": "", "signature": "pub fn longest_runtimes (& self, include_running : bool) -> impl Iterator", "cfg": [], "target": "ActionStatistics" }, { "id": "gpui::profiler::actions::ActionStatistics::save_action_timing", "name": "save_action_timing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler/actions.rs", "documentation": "", "signature": "pub fn save_action_timing (& mut self)", "cfg": [ "cfg (feature = \"profiler\")" ], "target": "ActionStatistics" }, { "source": "crates/gpui/src/profiler/actions.rs", "documentation": "", "signature": "pub fn save_action_timing (& mut self)", "cfg": [ "cfg (not (feature = \"profiler\"))" ], "target": "ActionStatistics" } ] }, { "id": "gpui::profiler::actions::ActionStatistics::take", "name": "take", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "", "documentation": "", "signature": "pub fn take (& mut self) -> Self", "cfg": [], "target": "ActionStatistics" }, { "id": "gpui::profiler::actions::ActionStatistics::update_running_action", "name": "update_running_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler/actions.rs", "documentation": "", "signature": "pub fn update_running_action (& mut self, _action : & 'static str, _started : Instant)", "cfg": [ "cfg (not (feature = \"profiler\"))" ], "target": "ActionStatistics" }, { "source": "crates/gpui/src/profiler/actions.rs", "documentation": "", "signature": "pub fn update_running_action (& mut self, action : & 'static str, started : Instant)", "cfg": [ "cfg (feature = \"profiler\")" ], "target": "ActionStatistics" } ] }, { "id": "gpui::profiler::actions::ActionTiming", "name": "ActionTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "UNSTABLE only for use in the profiler and zed-reliability", "documentation": "UNSTABLE only for use in the profiler and zed-reliability", "signature": "# [doc (hidden)] # [doc = \" UNSTABLE only for use in the profiler and zed-reliability\"] # [derive (Copy, Clone)] pub struct ActionTiming { pub name : & 'static str, pub start : Instant, pub end : Instant, }", "cfg": [] }, { "id": "gpui::profiler::actions::ActionTiming::duration", "name": "duration", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "", "documentation": "", "signature": "pub fn duration (& self) -> Duration", "cfg": [], "target": "ActionTiming" }, { "id": "gpui::profiler::actions::ActionTiming::runtime", "name": "runtime", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "source": "crates/gpui/src/profiler/actions.rs", "summary": "", "documentation": "", "signature": "pub fn runtime (& self) -> Duration", "cfg": [], "target": "ActionTiming" }, { "id": "gpui::profiler::actions::take_action_stats", "name": "take_action_stats", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler::actions", "path": "gpui::profiler::actions", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler/actions.rs", "documentation": "", "signature": "pub fn take_action_stats () -> ActionStatistics", "cfg": [ "cfg (feature = \"profiler\")" ] }, { "source": "crates/gpui/src/profiler/actions.rs", "documentation": "", "signature": "pub fn take_action_stats () -> ActionStatistics", "cfg": [ "cfg (not (feature = \"profiler\"))" ] } ] }, { "id": "gpui::profiler::frame_trace_enabled", "name": "frame_trace_enabled", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Returns whether frame timing collection is enabled.", "documentation": "Returns whether frame timing collection is enabled.", "signature": "pub fn frame_trace_enabled () -> bool", "cfg": [] }, { "id": "gpui::profiler::get_all_timings", "name": "get_all_timings", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn get_all_timings (_included : gpui::TasksIncluded) -> Vec", "cfg": [ "cfg (not (feature = \"profiler\"))" ] }, { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn get_all_timings (included : gpui::TasksIncluded) -> Vec", "cfg": [ "cfg (feature = \"profiler\")" ] } ] }, { "id": "gpui::profiler::get_current_thread_task_timings", "name": "get_current_thread_task_timings", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn get_current_thread_task_timings (include_running : TasksIncluded) -> ThreadTaskTimings", "cfg": [] }, { "id": "gpui::profiler::get_current_thread_timings", "name": "get_current_thread_timings", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn get_current_thread_timings (_included : TasksIncluded) -> gpui::ThreadTaskTimings", "cfg": [ "cfg (not (feature = \"profiler\"))" ] }, { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn get_current_thread_timings (included : TasksIncluded) -> gpui::ThreadTaskTimings", "cfg": [ "cfg (feature = \"profiler\")" ] } ] }, { "id": "gpui::profiler::record_frame_timing", "name": "record_frame_timing", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Records the timing of a drawn window frame.", "documentation": "Records the timing of a drawn window frame.\n\nNo-op unless frame tracing is enabled via [`set_frame_trace_enabled`].", "signature": "pub fn record_frame_timing (timing : FrameTiming)", "cfg": [] }, { "id": "gpui::profiler::reexport-1", "name": "actions :: { ActionStatistics , ActionTiming , take_action_stats }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub use actions::{ ActionStatistics, ActionTiming, take_action_stats };", "cfg": [] }, { "id": "gpui::profiler::save_task_timing", "name": "save_task_timing", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn save_task_timing ()", "cfg": [] }, { "id": "gpui::profiler::set_frame_trace_enabled", "name": "set_frame_trace_enabled", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Enables or disables the manual owner of frame timing collection at runtime.", "documentation": "Enables or disables the manual owner of frame timing collection at runtime.\n\nCollection remains enabled while any [`FrameTraceLease`] exists. When the\nfinal owner releases tracing, buffered timings are cleared so stale data is\nnot reported after a later re-enable. Returns false if the manual owner's\nvalue was unchanged.", "signature": "pub fn set_frame_trace_enabled (enabled : bool) -> bool", "cfg": [] }, { "id": "gpui::profiler::set_trace_enabled", "name": "set_trace_enabled", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Enables or disables task timing trace collection at runtime.", "documentation": "Enables or disables task timing trace collection at runtime.\n\nWhen transitioning from enabled to disabled, `add_task_timing` becomes a\ncheaper since only cheap statistics are gathered. The existing per-thread\nbuffers for traces are cleared so stale data isn't reported after a later\nre-enable. Calls with the current value are a no-op.", "signature": "pub fn set_trace_enabled (enabled : bool) -> bool", "cfg": [] }, { "id": "gpui::profiler::take_all_stats", "name": "take_all_stats", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "summary": "", "declarations": [ { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn take_all_stats (_included : TasksIncluded) -> Vec", "cfg": [ "cfg (not (feature = \"profiler\"))" ] }, { "source": "crates/gpui/src/profiler.rs", "documentation": "", "signature": "pub fn take_all_stats (included : TasksIncluded) -> Vec", "cfg": [ "cfg (feature = \"profiler\")" ] } ] }, { "id": "gpui::profiler::trace_enabled", "name": "trace_enabled", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "Returns whether task timing tracing is enabled.", "documentation": "Returns whether task timing tracing is enabled.", "signature": "pub fn trace_enabled () -> bool", "cfg": [] }, { "id": "gpui::profiler::update_running_task", "name": "update_running_task", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "profiler", "path": "gpui::profiler", "source": "crates/gpui/src/profiler.rs", "summary": "", "documentation": "", "signature": "pub fn update_running_task (spawned : SpawnTime, location : & 'static std::panic::Location<'_>)", "cfg": [] }, { "id": "gpui::queue::Iter", "name": "Iter", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct Iter (PriorityQueueReceiver);", "cfg": [] }, { "id": "gpui::queue::PriorityQueueReceiver", "name": "PriorityQueueReceiver", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct PriorityQueueReceiver { state : Arc>, rand : SmallRng, disconnected : bool, }", "cfg": [] }, { "id": "gpui::queue::PriorityQueueReceiver::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "Returns whether the queue currently contains no elements.", "documentation": "Returns whether the queue currently contains no elements.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueReceiver::iter", "name": "iter", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "Returns an iterator over the elements of the queue this iterator will wait for new elements if the queue is empty.", "documentation": "Returns an iterator over the elements of the queue\nthis iterator will wait for new elements if the queue is empty.", "signature": "pub fn iter (self) -> Iter", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueReceiver::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> (PriorityQueueSender, Self)", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueReceiver::pop", "name": "pop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "Pops an element from the priority queue blocking if necessary.", "documentation": "Pops an element from the priority queue blocking if necessary.\n\nThis method is best suited if you only intend to pop one element, for better performance\non large queues see [`Self::iter``]\n\n# Errors\n\nIf the sender was dropped", "signature": "pub fn pop (& mut self) -> Result", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueReceiver::spin_try_pop", "name": "spin_try_pop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "pub fn spin_try_pop (& mut self) -> Result, RecvError>", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueReceiver::try_iter", "name": "try_iter", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "Returns an iterator over the elements of the queue this iterator will end when all elements have been consumed and will not wait for new ones.", "documentation": "Returns an iterator over the elements of the queue\nthis iterator will end when all elements have been consumed and will not wait for new ones.", "signature": "pub fn try_iter (self) -> TryIter", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueReceiver::try_pop", "name": "try_pop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "Tries to pop one element from the priority queue without blocking.", "documentation": "Tries to pop one element from the priority queue without blocking.\n\nThis will early return if there are no elements in the queue.\n\nThis method is best suited if you only intend to pop one element, for better performance\non large queues see [`Self::try_iter`]\n\n# Errors\n\nIf the sender was dropped", "signature": "pub fn try_pop (& mut self) -> Result, RecvError>", "cfg": [], "target": "PriorityQueueReceiver" }, { "id": "gpui::queue::PriorityQueueSender", "name": "PriorityQueueSender", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct PriorityQueueSender { state : Arc>, }", "cfg": [] }, { "id": "gpui::queue::PriorityQueueSender::send", "name": "send", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "pub fn send (& self, priority : Priority, item : T) -> Result<(), SendError>", "cfg": [], "target": "PriorityQueueSender" }, { "id": "gpui::queue::PriorityQueueSender::spin_send", "name": "spin_send", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "pub fn spin_send (& self, priority : Priority, item : T) -> Result<(), SendError>", "cfg": [], "target": "PriorityQueueSender" }, { "id": "gpui::queue::RecvError", "name": "RecvError", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug)] # [doc (hidden)] pub struct RecvError;", "cfg": [] }, { "id": "gpui::queue::SendError", "name": "SendError", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct SendError (pub T);", "cfg": [] }, { "id": "gpui::queue::TryIter", "name": "TryIter", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "queue", "path": "gpui::queue", "source": "crates/gpui/src/queue.rs", "summary": "", "documentation": "", "signature": "# [doc (hidden)] pub struct TryIter { receiver : PriorityQueueReceiver, ended : bool, }", "cfg": [] }, { "id": "gpui::renderer_timing::GpuExecutionTime", "name": "GpuExecutionTime", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "renderer_timing", "path": "gpui::renderer_timing", "source": "crates/gpui/src/renderer_timing.rs", "summary": "GPU clock evidence, never a CPU completion or pixel-readback duration.", "documentation": "GPU clock evidence, never a CPU completion or pixel-readback duration.", "signature": "# [doc = \" GPU clock evidence, never a CPU completion or pixel-readback duration.\"] # [derive (Clone, Debug)] pub enum GpuExecutionTime { # [doc = \" This adapter/API cannot provide usable execution timestamps.\"] Unsupported (String), # [doc = \" Elapsed GPU time between commands bracketing the scene's render commands.\"] Measured (Duration), }", "cfg": [] }, { "id": "gpui::renderer_timing::GpuExecutionTime::from_timestamps", "name": "from_timestamps", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "renderer_timing", "path": "gpui::renderer_timing", "source": "crates/gpui/src/renderer_timing.rs", "summary": "Validate a completed submission's timestamps. Callers must supply fresh, submission-owned storage, not a cached result from an earlier frame.", "documentation": "Validate a completed submission's timestamps. Callers must supply fresh,\nsubmission-owned storage, not a cached result from an earlier frame.", "signature": "pub fn from_timestamps (start : f64, end : f64, seconds_per_tick : f64) -> anyhow::Result", "cfg": [], "target": "GpuExecutionTime" }, { "id": "gpui::renderer_timing::RendererFrameTiming", "name": "RendererFrameTiming", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "renderer_timing", "path": "gpui::renderer_timing", "source": "crates/gpui/src/renderer_timing.rs", "summary": "One synchronously measured headless render attempt. IDs increase per renderer; a failed attempt returns an error, never the previous attempt's measurement.", "documentation": "One synchronously measured headless render attempt. IDs increase per renderer;\na failed attempt returns an error, never the previous attempt's measurement.", "signature": "# [doc = \" One synchronously measured headless render attempt. IDs increase per renderer;\"] # [doc = \" a failed attempt returns an error, never the previous attempt's measurement.\"] # [derive (Clone, Debug)] pub struct RendererFrameTiming { # [doc = \" Monotonically increasing measurement attempt ID, local to this renderer.\"] pub submission_id : u64, # [doc = \" CPU target preparation, encoding and submission; not GPU time.\"] pub cpu_encode_submit : Duration, # [doc = \" CPU wall time from submit returning until completion is observed. Includes\"] # [doc = \" scheduling/poll overhead; not GPU execution and not presentation latency.\"] pub submit_to_completion : Duration, # [doc = \" Execution-clock evidence or an explicit unsupported capability reason.\"] pub gpu_execution : GpuExecutionTime, # [doc = \" GPU query resolve/copy, mapping and CPU extraction after render completion.\"] # [doc = \" Absent when no timestamp query readback is performed.\"] pub timestamp_readback : Option, }", "cfg": [] }, { "id": "gpui::scene::BackdropGlass", "name": "BackdropGlass", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "A within-window glass surface: the renderer snapshots everything painted below this order, optionally derives a blurred source, and paints it back through the surface's shape and material. See [`crate::Window::paint_backdrop_glass`].", "documentation": "A within-window glass surface: the renderer snapshots everything painted\nbelow this order, optionally derives a blurred source, and paints it back\nthrough the surface's shape and material. See\n[`crate::Window::paint_backdrop_glass`].", "signature": "# [doc = \" A within-window glass surface: the renderer snapshots everything painted\"] # [doc = \" below this order, optionally derives a blurred source, and paints it back\"] # [doc = \" through the surface's shape and material. See\"] # [doc = \" [`crate::Window::paint_backdrop_glass`].\"] # [derive (Debug, Copy, Clone)] # [repr (C)] # [expect (missing_docs)] pub struct BackdropGlass { pub order : DrawOrder, # [doc = \" The region the surface occupies. With more than one lobe this is the\"] # [doc = \" union's bounding box, which is what the renderer rasterizes and what\"] # [doc = \" clips the blur; the shape inside it comes from `lobes`.\"] pub bounds : Bounds, pub content_mask : ContentMask, # [doc = \" The rounding used when `lobe_count` is 0.\"] pub corner_radii : Corners, pub material : GlassMaterial, # [doc = \" The length is written out rather than named so that the C header\"] # [doc = \" generated for the Metal shaders carries a literal bound, which needs no\"] # [doc = \" integer typedef and no include. [`MAX_GLASS_LOBES`] is asserted equal\"] # [doc = \" to it below, so the two cannot drift.\"] pub lobes : [GlassLobe; 8], # [doc = \" How many entries of `lobes` are real. Zero means the surface is the\"] # [doc = \" single rounded rect named by `bounds` and `corner_radii`.\"] pub lobe_count : u32, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::BackdropGlass::gaussian_pass_count", "name": "gaussian_pass_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "How many separable gaussian passes this surface's blur needs, or `None` when it needs more than [`MAX_GLASS_GAUSSIAN_PASSES`] and the renderer should leave the backdrop unblurred rather than spend an unbounded amount of the frame on it.", "documentation": "How many separable gaussian passes this surface's blur needs, or\n`None` when it needs more than [`MAX_GLASS_GAUSSIAN_PASSES`] and the\nrenderer should leave the backdrop unblurred rather than spend an\nunbounded amount of the frame on it.\n\nA renderer that hands the blur to the platform (Metal, through\n`MPSImageGaussianBlur`) has no use for this. The two that convolve it\nthemselves both do, and they share this rather than each deriving it,\nbecause the number is a property of the shader's tap budget and the\ntwo shaders have the same one.", "signature": "pub fn gaussian_pass_count (& self) -> Option", "cfg": [], "target": "BackdropGlass" }, { "id": "gpui::scene::BackdropGlass::optical_bevel", "name": "optical_bevel", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Geometrically admissible depth of the optical profile, in device pixels. A rounded corner's inward parallel curves collapse at its radius. Extending the dome past that point leaves a nonzero slope at the arc centre, concentrating directional highlights into a pointed wedge. Bound the entire profile (refraction and lighting together), not its brightness, so it is flat before any rounded arc collapses. One depth across the union avoids seams between lobes or unequal corner radii. Square corners retain their intentional incident-face crease.", "documentation": "Geometrically admissible depth of the optical profile, in device pixels.\nA rounded corner's inward parallel curves collapse at its radius.\nExtending the dome past that point leaves a nonzero slope at the arc\ncentre, concentrating directional highlights into a pointed wedge.\nBound the entire profile (refraction and lighting together), not its\nbrightness, so it is flat before any rounded arc collapses. One depth\nacross the union avoids seams between lobes or unequal corner radii.\nSquare corners retain their intentional incident-face crease.", "signature": "pub fn optical_bevel (& self) -> ScaledPixels", "cfg": [], "target": "BackdropGlass" }, { "id": "gpui::scene::BackdropGlass::optical_thickness", "name": "optical_thickness", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Maximum height of the elliptical edge profile, shared by upload and sampling bounds. Its analytic derivative defines the Snell and lighting normal. The profile joins a flat interior before a corner collapses.", "documentation": "Maximum height of the elliptical edge profile, shared by upload and\nsampling bounds. Its analytic derivative defines the Snell and lighting\nnormal. The profile joins a flat interior before a corner collapses.", "signature": "pub fn optical_thickness (& self) -> ScaledPixels", "cfg": [], "target": "BackdropGlass" }, { "id": "gpui::scene::BackdropGlass::probe_sample_points", "name": "probe_sample_points", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Where this surface's luminance probe samples its sharp or blurred optical source: the centre of the surface and the four quarter points, in device pixels, each clamped inside a `width` by `height` texture.", "documentation": "Where this surface's luminance probe samples its sharp or blurred\noptical source: the centre of the surface and the four quarter points,\nin device pixels, each clamped inside a `width` by `height` texture.\n\nFive points rather than one because a probe summarises the whole\nsurface: for frost the blur has already averaged each point's\nneighbourhood, while for clear glass the cross keeps one bright stripe\nunder the centre from speaking for the corners. Every renderer copies\nexactly these texels, which is what makes one probe value mean the same\nthing on each of them.", "signature": "pub fn probe_sample_points (& self, width : f32, height : f32,) -> [[f32; 2]; LUMINANCE_PROBE_SAMPLES]", "cfg": [], "target": "BackdropGlass" }, { "id": "gpui::scene::BackdropGlass::render_region", "name": "render_region", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The clipped output and conservative scratch region for this surface.", "documentation": "The clipped output and conservative scratch region for this surface.\n\n`gaussian_passes` is the number of same-variance passes the backend\nwill apply. A platform Gaussian is one pass; a clear surface is zero.\nThe Gaussian support is three standard deviations per pass. For a\nnormally incident ray entering index n, Snell's law bounds the ray's\nlateral slope by sqrt(n² - 1), including at a grazing surface normal.\nUse the largest channel index and maximum optical-plane distance, plus\none pixel for bilinear filtering. No shader displacement cap is needed.\nBoth regions are rounded outwards and clamped to `viewport`.\nWhen the material requests a valid luminance probe, `sampling` also\nretains each probe texel and its blur dependencies even when the\ncontent mask clips that point out of `visible`.", "signature": "pub fn render_region (& self, gaussian_passes : u32, viewport : Size,) -> Option", "cfg": [], "target": "BackdropGlass" }, { "id": "gpui::scene::BackdropGlass::shape", "name": "shape", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The lobes that make up the shape, which is the explicit list when there is one and the surface's own rounded rect when there is not.", "documentation": "The lobes that make up the shape, which is the explicit list when\nthere is one and the surface's own rounded rect when there is not.\n\nCallers that evaluate the shape must go through this rather than\nreading `lobes` directly, so that the single-lobe case cannot drift\naway from the many-lobe case.", "signature": "pub fn shape (& self) -> ([GlassLobe; MAX_GLASS_LOBES], usize)", "cfg": [], "target": "BackdropGlass" }, { "id": "gpui::scene::BackdropRenderRegion", "name": "BackdropRenderRegion", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Integral device-pixel regions a backdrop renderer must preserve.", "documentation": "Integral device-pixel regions a backdrop renderer must preserve.\n\n`visible` is the surface clipped by its content mask. `sampling` expands\nthat region by every blur pass's finite Gaussian support and the material's\nmaximum refracted displacement, and preserves any requested probe samples.\nA renderer may leave pixels outside `sampling` untouched in scratch\ntextures because neither a fragment in `visible` nor a probe can read them.", "signature": "# [doc = \" Integral device-pixel regions a backdrop renderer must preserve.\"] # [doc = \"\"] # [doc = \" `visible` is the surface clipped by its content mask. `sampling` expands\"] # [doc = \" that region by every blur pass's finite Gaussian support and the material's\"] # [doc = \" maximum refracted displacement, and preserves any requested probe samples.\"] # [doc = \" A renderer may leave pixels outside `sampling` untouched in scratch\"] # [doc = \" textures because neither a fragment in `visible` nor a probe can read them.\"] # [derive (Copy, Clone, Debug, Eq, PartialEq)] pub struct BackdropRenderRegion { # [doc = \" The integral pixels where the surface can produce fragments.\"] pub visible : Bounds, # [doc = \" The integral pixels that can contribute to those fragments.\"] pub sampling : Bounds, }", "cfg": [] }, { "id": "gpui::scene::BorderStyle", "name": "BorderStyle", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The style of a border.", "documentation": "The style of a border.", "signature": "# [doc = \" The style of a border.\"] # [derive (Default, Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)] # [repr (C)] pub enum BorderStyle { # [doc = \" A solid border.\"] # [default] Solid = 0, # [doc = \" A dashed border.\"] Dashed = 1, }", "cfg": [] }, { "id": "gpui::scene::DrawOrder", "name": "DrawOrder", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [expect (missing_docs)] pub type DrawOrder = u32;", "cfg": [] }, { "id": "gpui::scene::GlassEdge", "name": "GlassEdge", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Which edge a glass surface fades from, for a scroll-edge or similar ramp.", "documentation": "Which edge a glass surface fades from, for a scroll-edge or similar ramp.", "signature": "# [doc = \" Which edge a glass surface fades from, for a scroll-edge or similar ramp.\"] # [derive (Debug, Copy, Clone, Default, PartialEq, Eq)] # [repr (u32)] pub enum GlassEdge { # [doc = \" No fade; the surface applies its optics uniformly.\"] # [default] None = 0, # [doc = \" Full optics at the top edge, fading toward the bottom of the band.\"] Top = 1, # [doc = \" Full optics at the bottom edge, fading toward the top of the band.\"] Bottom = 2, # [doc = \" Full optics at the left edge, fading toward the right of the band.\"] Left = 3, # [doc = \" Full optics at the right edge, fading toward the left of the band.\"] Right = 4, }", "cfg": [] }, { "id": "gpui::scene::GlassEdge::as_f32", "name": "as_f32", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The GPU-facing discriminant, as a float so the material struct stays one packed run of 32-bit words.", "documentation": "The GPU-facing discriminant, as a float so the material struct stays\none packed run of 32-bit words.", "signature": "pub fn as_f32 (self) -> f32", "cfg": [], "target": "GlassEdge" }, { "id": "gpui::scene::GlassField", "name": "GlassField", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The shape of a glass surface at a point: how far outside it the point is, and which way the surface falls away from there.", "documentation": "The shape of a glass surface at a point: how far outside it the point is,\nand which way the surface falls away from there.", "signature": "# [doc = \" The shape of a glass surface at a point: how far outside it the point is,\"] # [doc = \" and which way the surface falls away from there.\"] # [derive (Debug, Copy, Clone, PartialEq)] pub struct GlassField { # [doc = \" Signed distance to the surface's edge, negative inside.\"] pub distance : f32, # [doc = \" The analytic distance derivative, not normalized. Preserve its magnitude\"] # [doc = \" when deriving the height-field normal across a union. At a lobe's medial\"] # [doc = \" axis choose an actual incident face, not their fictitious bisector.\"] # [doc = \" Zero for an empty field or cancelling smooth-union derivatives.\"] pub gradient : Point, }", "cfg": [] }, { "id": "gpui::scene::GlassLength", "name": "GlassLength", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "A length carried by a glass surface, in whichever pixel unit the surface is expressed in.", "documentation": "A length carried by a glass surface, in whichever pixel unit the surface\nis expressed in.\n\n[`GlassMaterial`] and [`GlassLobe`] are parameterised over their unit for\nthe same reason [`Bounds`] is: a caller states a surface in logical pixels\nand [`crate::Window::paint_backdrop_glass`] scales it, so the two are\ndifferent types and the conversion is the one operation that turns one\ninto the other. This trait is what lets the shared arithmetic be written\nonce instead of twice.", "signature": "# [doc = \" A length carried by a glass surface, in whichever pixel unit the surface\"] # [doc = \" is expressed in.\"] # [doc = \"\"] # [doc = \" [`GlassMaterial`] and [`GlassLobe`] are parameterised over their unit for\"] # [doc = \" the same reason [`Bounds`] is: a caller states a surface in logical pixels\"] # [doc = \" and [`crate::Window::paint_backdrop_glass`] scales it, so the two are\"] # [doc = \" different types and the conversion is the one operation that turns one\"] # [doc = \" into the other. This trait is what lets the shared arithmetic be written\"] # [doc = \" once instead of twice.\"] pub trait GlassLength : Copy + Default + std::fmt::Debug + PartialEq { # [doc = \" The length as a bare pixel count.\"] fn raw (self) -> f32; # [doc = \" A length of this unit from a bare pixel count.\"] fn from_raw (raw : f32) -> Self; }", "cfg": [] }, { "id": "gpui::scene::GlassLobe", "name": "GlassLobe", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "One rounded rectangle of a glass surface's shape.", "documentation": "One rounded rectangle of a glass surface's shape.\n\nA surface with a single lobe is an ordinary rounded rect. Several lobes\nare combined by a smooth minimum, so two that come within\n[`GlassMaterial::smoothing`] of each other join into one body instead of\noverlapping as two outlines.", "signature": "# [doc = \" One rounded rectangle of a glass surface's shape.\"] # [doc = \"\"] # [doc = \" A surface with a single lobe is an ordinary rounded rect. Several lobes\"] # [doc = \" are combined by a smooth minimum, so two that come within\"] # [doc = \" [`GlassMaterial::smoothing`] of each other join into one body instead of\"] # [doc = \" overlapping as two outlines.\"] # [derive (Debug, Copy, Clone, Default, PartialEq)] # [repr (C)] # [expect (missing_docs)] pub struct GlassLobe

{ pub bounds : Bounds

, pub corner_radii : Corners

, }", "cfg": [] }, { "id": "gpui::scene::GlassLobe::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The same lobe in device pixels.", "documentation": "The same lobe in device pixels.", "signature": "pub fn scale (self, factor : f32) -> GlassLobe", "cfg": [], "target": "GlassLobe" }, { "id": "gpui::scene::GlassMaterial", "name": "GlassMaterial", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The complete optical response of a glass surface.", "documentation": "The complete optical response of a glass surface.\n\nBlur is scattering, not a prerequisite for glass. [`GlassMaterial::clear`]\nsnapshots the sharp backdrop and leaves it unchanged; callers independently\nadd refraction, dispersion, transmission, an optical lift, or edge light.\n[`GlassMaterial::frosted`] adds only scattering. Refraction samples that\nscattered source throughout the surface, including the rim. The retained\nsharp snapshot restores the original backdrop only under an explicit edge mask.", "signature": "# [doc = \" The complete optical response of a glass surface.\"] # [doc = \"\"] # [doc = \" Blur is scattering, not a prerequisite for glass. [`GlassMaterial::clear`]\"] # [doc = \" snapshots the sharp backdrop and leaves it unchanged; callers independently\"] # [doc = \" add refraction, dispersion, transmission, an optical lift, or edge light.\"] # [doc = \" [`GlassMaterial::frosted`] adds only scattering. Refraction samples that\"] # [doc = \" scattered source throughout the surface, including the rim. The retained\"] # [doc = \" sharp snapshot restores the original backdrop only under an explicit edge mask.\"] # [derive (Debug, Copy, Clone, PartialEq)] # [repr (C)] pub struct GlassMaterial

{ # [doc = \" Gaussian sigma applied to the backdrop snapshot. Zero keeps the source\"] # [doc = \" sharp while still allowing every other optical field to act on it.\"] pub blur_radius : P, # [doc = \" How far in from the edge the bevel that bends the backdrop reaches.\"] # [doc = \" Zero leaves the backdrop flat however large the other fields are,\"] # [doc = \" because there is no slope for them to act on.\"] # [doc = \" Renderers bound this requested depth by the shape's rounded-corner\"] # [doc = \" reach; see [`BackdropGlass::optical_bevel`].\"] pub bevel : P, # [doc = \" Signed multiplier of the surface thickness. Zero flattens the surface;\"] # [doc = \" positive values describe a convex face, negative values a concave face.\"] # [doc = \" This scales both the height and its derivative, including lighting.\"] pub refraction : f32, # [doc = \" Maximum profile height before applying `refraction`. Zero follows the\"] # [doc = \" geometrically bounded bevel. Explicit heights do not widen the bevel.\"] pub thickness : P, # [doc = \" Dielectric index relative to air, sanitized to 1..=2.5. One removes\"] # [doc = \" refraction and Fresnel reflection. Clear constructors use 1.5.\"] pub refractive_index : f32, # [doc = \" Effective distance below the profile base to the sampled optical plane.\"] # [doc = \" The refracted ray propagates through this distance in the same medium:\"] # [doc = \" this is not an air gap behind a second dielectric interface. Screen-space\"] # [doc = \" glass has no scene depth, hidden geometry or multi-bounce ray tracing.\"] pub backdrop_depth : P, # [doc = \" Fractional variation of `refractive_index - 1` for red and blue.\"] # [doc = \" Zero uses the same Snell ray for all channels, not a post-sample fringe.\"] pub dispersion : f32, # [doc = \" Strength of the Fresnel-weighted directional environment reflection,\"] # [doc = \" 0 for none. Reflection and transmission share the profile's normal.\"] pub specular : f32, # [doc = \" Multiplicative transmission applied after sampling. One preserves the\"] # [doc = \" backdrop; values above one model the measured light gain of clear glass.\"] pub transmission_gain : f32, # [doc = \" Saturation of the sampled backdrop, including the refracted rim, before\"] # [doc = \" transmission gain. One preserves colour, zero uses Rec. 709 luminance.\"] # [doc = \" Values above one intensify colour; negative results are clamped to zero.\"] pub saturation : f32, # [doc = \" Straight-alpha source-over material colour after saturation and\"] # [doc = \" transmission gain, before optical lift and edge light. RGB and alpha\"] # [doc = \" are independently clamped to 0..=1; non-finite channels become zero.\"] # [doc = \" Neutral washes and caller tints cover the refracted rim and fused\"] # [doc = \" bridges, unlike a foreground element fill.\"] pub wash : Rgba, # [doc = \" A colour added after transmission, as `rgb * alpha`. This is not\"] # [doc = \" source-over tint: it lifts the light already passing through the glass.\"] pub optical_lift : Rgba, # [doc = \" Width of the consistently lit edge in pixels. Zero paints no hairline.\"] pub hairline : P, # [doc = \" Where the light is, in radians clockwise from straight up.\"] pub light_angle : f32, # [doc = \" How tight the specular lobe is. Larger is a smaller, harder highlight.\"] pub specular_sharpness : f32, # [doc = \" How far apart two lobes may be and still join. Zero makes the union a\"] # [doc = \" plain minimum, so lobes meet at a crease.\"] pub smoothing : P, # [doc = \" Opaque [`crate::LuminanceProbeLease::id`], or [`NO_LUMINANCE_PROBE`].\"] # [doc = \" The u32 carries a generation and physical slot; retain its lease and\"] # [doc = \" never substitute the decoded slot when querying the cache.\"] # [doc = \"\"] # [doc = \" A probed surface has the mean luminance of its optical source reported\"] # [doc = \" back through [`crate::Window::backdrop_luminance`], one frame later.\"] # [doc = \" That source is sharp for clear glass and blurred for frosted glass. See\"] # [doc = \" that method for what the delay means for a caller.\"] pub probe : u32, # [doc = \" Which edge a linear mask fades from. Zero is none; 1 top, 2 bottom,\"] # [doc = \" 3 left, 4 right. Stored as a float so the GPU struct stays one packed\"] # [doc = \" run of 32-bit words.\"] pub edge_mask_edge : f32, # [doc = \" How far that fade reaches from the named edge, in the surface's unit.\"] # [doc = \" Zero disables the mask even when [`Self::edge_mask_edge`] is set.\"] pub edge_mask_band : P, }", "cfg": [] }, { "id": "gpui::scene::GlassMaterial::bends_light", "name": "bends_light", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Whether the backdrop sample is displaced at all.", "documentation": "Whether the backdrop sample is displaced at all.", "signature": "pub fn bends_light (& self) -> bool", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::GlassMaterial::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Preserve the sharp backdrop and apply no optics.", "documentation": "Preserve the sharp backdrop and apply no optics.\n\nThis is a function rather than a constant because the zero length\ndepends on the unit; every field in it is nevertheless fixed.", "signature": "pub fn clear () -> Self", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::GlassMaterial::frosted", "name": "frosted", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Blur the backdrop and apply no other optics.", "documentation": "Blur the backdrop and apply no other optics.", "signature": "pub fn frosted (blur_radius : P) -> Self", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::GlassMaterial::is_flat", "name": "is_flat", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Whether this material asks the renderer for anything beyond passing through its sharp or blurred source unchanged.", "documentation": "Whether this material asks the renderer for anything beyond passing\nthrough its sharp or blurred source unchanged.", "signature": "pub fn is_flat (& self) -> bool", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::GlassMaterial::needs_backdrop", "name": "needs_backdrop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Whether a renderer must snapshot the framebuffer for this material. A clear refractive surface returns true even though its blur is zero.", "documentation": "Whether a renderer must snapshot the framebuffer for this material.\nA clear refractive surface returns true even though its blur is zero.", "signature": "pub fn needs_backdrop (& self) -> bool", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::GlassMaterial::sanitized", "name": "sanitized", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Replaces every field that a renderer could not act on with one it can: non-finite values become zero, and negative values that have no meaning below zero are clamped there. A caller that computed a material from an animation gets a legible surface rather than a hole.", "documentation": "Replaces every field that a renderer could not act on with one it can:\nnon-finite values become zero, and negative values that have no\nmeaning below zero are clamped there. A caller that computed a\nmaterial from an animation gets a legible surface rather than a hole.", "signature": "pub fn sanitized (mut self) -> Self", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::GlassMaterial::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The same material in device pixels. Only its lengths change: every other field is a ratio, an angle or a slot index, and means the same thing at any scale.", "documentation": "The same material in device pixels. Only its lengths change: every\nother field is a ratio, an angle or a slot index, and means the same\nthing at any scale.", "signature": "pub fn scale (self, factor : f32) -> GlassMaterial", "cfg": [], "target": "GlassMaterial" }, { "id": "gpui::scene::GlassMaterial::with_edge_mask", "name": "with_edge_mask", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Fade this surface from `edge` over `band`, mixing the optical result back into the undisplaced sharp snapshot so the inner side of the ramp is the content itself.", "documentation": "Fade this surface from `edge` over `band`, mixing the optical result\nback into the undisplaced sharp snapshot so the inner side of the\nramp is the content itself.", "signature": "pub fn with_edge_mask (mut self, edge : GlassEdge, band : P) -> Self", "cfg": [], "target": "GlassMaterial

" }, { "id": "gpui::scene::LUMINANCE_PROBE_SAMPLES", "name": "LUMINANCE_PROBE_SAMPLES", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "How many points of the sharp or blurred backdrop one probe averages.", "documentation": "How many points of the sharp or blurred backdrop one probe averages.", "signature": "pub const LUMINANCE_PROBE_SAMPLES: usize", "cfg": [] }, { "id": "gpui::scene::MAX_BACKDROP_GLASS_SURFACES_PER_FRAME", "name": "MAX_BACKDROP_GLASS_SURFACES_PER_FRAME", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The most backdrop-glass surfaces a scene admits in one frame.", "documentation": "The most backdrop-glass surfaces a scene admits in one frame.\n\nEvery admitted surface snapshots the full framebuffer before compositing\nits optics, even when its blur spends no Gaussian passes. Bounding surfaces\nseparately from the Gaussian budget therefore bounds that fixed work on\nMetal, DirectX, native WGPU, and browser WGPU alike. Admission follows\npaint order. Valid intents past the limit remain replayable and callers may\nsupply an ordinary-fill fallback through\n[`crate::Window::paint_backdrop_glass_with_fallback`].", "signature": "pub const MAX_BACKDROP_GLASS_SURFACES_PER_FRAME: usize", "cfg": [] }, { "id": "gpui::scene::MAX_GLASS_GAUSSIAN_PASSES", "name": "MAX_GLASS_GAUSSIAN_PASSES", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The most gaussian passes one glass surface may be given.", "documentation": "The most gaussian passes one glass surface may be given.", "signature": "pub const MAX_GLASS_GAUSSIAN_PASSES: u32", "cfg": [] }, { "id": "gpui::scene::MAX_GLASS_LOBES", "name": "MAX_GLASS_LOBES", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "How many rounded rectangles one glass surface may be made of.", "documentation": "How many rounded rectangles one glass surface may be made of.\n\nThe shape is evaluated per fragment and per hit test, so the count is\nbounded rather than allocated: a loop a shader can unroll is the reason\nthis is a fixed array inside the instance rather than a second buffer.", "signature": "pub const MAX_GLASS_LOBES: usize", "cfg": [] }, { "id": "gpui::scene::MAX_GLASS_SIGMA_PER_PASS", "name": "MAX_GLASS_SIGMA_PER_PASS", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The largest standard deviation one separable gaussian pass can carry.", "documentation": "The largest standard deviation one separable gaussian pass can carry.\n\nThe shaders take 64 taps either side of centre and a gaussian is spent by\nthree standard deviations, so a pass wider than this is sampling a kernel\nit has already run out of room for. Wider blurs are split into several\npasses, whose variances add.", "signature": "pub const MAX_GLASS_SIGMA_PER_PASS: f32", "cfg": [] }, { "id": "gpui::scene::MAX_LUMINANCE_PROBES", "name": "MAX_LUMINANCE_PROBES", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "How many luminance probe slots a window carries.", "documentation": "How many luminance probe slots a window carries.\n\nA probe is a slot a glass surface fills each frame and a caller reads a\nframe later, so the count bounds the readback buffer every renderer keeps,\nthe same way [`MAX_GLASS_LOBES`] bounds the instance.", "signature": "pub const MAX_LUMINANCE_PROBES: usize", "cfg": [] }, { "id": "gpui::scene::MonochromeSprite", "name": "MonochromeSprite", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Copy, Clone, Debug)] # [repr (C)] # [expect (missing_docs)] pub struct MonochromeSprite { pub order : DrawOrder, pub pad : u32, pub bounds : Bounds, pub content_mask : ContentMask, pub color : Hsla, pub tile : AtlasTile, pub transformation : TransformationMatrix, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::NO_LUMINANCE_PROBE", "name": "NO_LUMINANCE_PROBE", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The value of [`GlassMaterial::probe`] that asks for no luminance probe.", "documentation": "The value of [`GlassMaterial::probe`] that asks for no luminance probe.", "signature": "pub const NO_LUMINANCE_PROBE: u32", "cfg": [] }, { "id": "gpui::scene::PaddedBool32", "name": "PaddedBool32", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "A boolean stored as a `u32` so that GPU-facing structs contain no compiler-inserted padding bytes, which would be undefined behavior to reinterpret as `&[u8]` when writing instance buffers. Guaranteed to be `0` or `1` by construction; shaders read it as a `u32`/`uint`.", "documentation": "A boolean stored as a `u32` so that GPU-facing structs contain no\ncompiler-inserted padding bytes, which would be undefined behavior to\nreinterpret as `&[u8]` when writing instance buffers. Guaranteed to be\n`0` or `1` by construction; shaders read it as a `u32`/`uint`.", "signature": "# [doc = \" A boolean stored as a `u32` so that GPU-facing structs contain no\"] # [doc = \" compiler-inserted padding bytes, which would be undefined behavior to\"] # [doc = \" reinterpret as `&[u8]` when writing instance buffers. Guaranteed to be\"] # [doc = \" `0` or `1` by construction; shaders read it as a `u32`/`uint`.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] # [repr (transparent)] pub struct PaddedBool32 (u32);", "cfg": [] }, { "id": "gpui::scene::PaintSurface", "name": "PaintSurface", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Debug)] # [allow (missing_docs)] pub struct PaintSurface { pub order : DrawOrder, pub bounds : Bounds, pub content_mask : ContentMask, pub clip_id : crate::ClipId, # [cfg (target_os = \"macos\")] pub image_buffer : core_video::pixel_buffer::CVPixelBuffer, }", "cfg": [] }, { "id": "gpui::scene::Path", "name": "Path", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "A line made up of a series of vertices and control points.", "documentation": "A line made up of a series of vertices and control points.", "signature": "# [doc = \" A line made up of a series of vertices and control points.\"] # [derive (Clone, Debug)] # [expect (missing_docs)] pub struct Path

{ pub id : PathId, pub order : DrawOrder, pub bounds : Bounds

, pub content_mask : ContentMask

, pub vertices : Vec>, pub color : Background, pub clip_id : crate::ClipId, start : Point

, current : Point

, contour_count : usize, }", "cfg": [] }, { "id": "gpui::scene::Path::clipped_bounds", "name": "clipped_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn clipped_bounds (& self) -> Bounds", "cfg": [], "target": "Path" }, { "id": "gpui::scene::Path::curve_to", "name": "curve_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Draw a curve from the current point to the given point, using the given control point.", "documentation": "Draw a curve from the current point to the given point, using the given control point.", "signature": "pub fn curve_to (& mut self, to : Point, ctrl : Point)", "cfg": [], "target": "Path" }, { "id": "gpui::scene::Path::line_to", "name": "line_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Draw a straight line from the current point to the given point.", "documentation": "Draw a straight line from the current point to the given point.", "signature": "pub fn line_to (& mut self, to : Point)", "cfg": [], "target": "Path" }, { "id": "gpui::scene::Path::move_to", "name": "move_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Move the start, current point to the given point.", "documentation": "Move the start, current point to the given point.", "signature": "pub fn move_to (& mut self, to : Point)", "cfg": [], "target": "Path" }, { "id": "gpui::scene::Path::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Create a new path with the given starting point.", "documentation": "Create a new path with the given starting point.", "signature": "pub fn new (start : Point) -> Self", "cfg": [], "target": "Path" }, { "id": "gpui::scene::Path::push_triangle", "name": "push_triangle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Push a triangle to the Path.", "documentation": "Push a triangle to the Path.", "signature": "pub fn push_triangle (& mut self, xy : (Point, Point, Point), st : (Point, Point, Point),)", "cfg": [], "target": "Path" }, { "id": "gpui::scene::Path::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Scale this path by the given factor.", "documentation": "Scale this path by the given factor.", "signature": "pub fn scale (& self, factor : f32) -> Path", "cfg": [], "target": "Path" }, { "id": "gpui::scene::PathId", "name": "PathId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Copy, Clone, Debug, PartialEq, Eq, Hash)] # [expect (missing_docs)] pub struct PathId (pub usize);", "cfg": [] }, { "id": "gpui::scene::PathVertex", "name": "PathVertex", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Debug)] # [repr (C)] # [expect (missing_docs)] pub struct PathVertex

{ pub xy_position : Point

, pub st_position : Point, pub content_mask : ContentMask

, }", "cfg": [] }, { "id": "gpui::scene::PathVertex::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn scale (& self, factor : f32) -> PathVertex", "cfg": [], "target": "PathVertex" }, { "id": "gpui::scene::PathVertex_ScaledPixels", "name": "PathVertex_ScaledPixels", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [allow (non_camel_case_types, unused)] # [expect (missing_docs)] pub type PathVertex_ScaledPixels = PathVertex;", "cfg": [] }, { "id": "gpui::scene::PolychromeSprite", "name": "PolychromeSprite", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Copy, Clone, Debug)] # [repr (C)] # [expect (missing_docs)] pub struct PolychromeSprite { pub order : DrawOrder, pub blend_mode : SpriteBlendMode, pub color_mode : SpriteColorMode, pub sample_inset : PaddedBool32, pub bounds : Bounds, pub content_mask : ContentMask, pub corner_radii : Corners, pub tile : AtlasTile, pub transformation : TransformationMatrix, pub tint : Hsla, pub opacity : f32, pub pad : u32, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::Primitive", "name": "Primitive", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone)] # [expect (missing_docs)] pub enum Primitive { Shadow (Shadow), Quad (Quad), Path (Path), Underline (Underline), MonochromeSprite (MonochromeSprite), SubpixelSprite (SubpixelSprite), PolychromeSprite (PolychromeSprite), Surface (PaintSurface), }", "cfg": [] }, { "id": "gpui::scene::Primitive::bounds", "name": "bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn bounds (& self) -> & Bounds", "cfg": [], "target": "Primitive" }, { "id": "gpui::scene::Primitive::clip_id", "name": "clip_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Rounded subtree clip in the owning scene.", "documentation": "Rounded subtree clip in the owning scene.", "signature": "pub fn clip_id (& self) -> crate::ClipId", "cfg": [], "target": "Primitive" }, { "id": "gpui::scene::Primitive::content_mask", "name": "content_mask", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn content_mask (& self) -> & ContentMask", "cfg": [], "target": "Primitive" }, { "id": "gpui::scene::PrimitiveBatch", "name": "PrimitiveBatch", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug)] # [cfg_attr (all (any (target_os = \"linux\", target_os = \"freebsd\"), not (any (feature = \"x11\", feature = \"wayland\"))), allow (dead_code))] # [allow (missing_docs)] pub enum PrimitiveBatch { Shadows (Range), Quads (Range), Paths (Range), Underlines (Range), MonochromeSprites { texture_id : AtlasTextureId, range : Range, }, # [cfg_attr (target_os = \"macos\", allow (dead_code))] SubpixelSprites { texture_id : AtlasTextureId, range : Range, }, PolychromeSprites { texture_id : AtlasTextureId, blend_mode : SpriteBlendMode, range : Range, }, Surfaces (Range), }", "cfg": [] }, { "id": "gpui::scene::PrimitiveBatch::label", "name": "label", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn label (& self) -> String", "cfg": [], "target": "PrimitiveBatch" }, { "id": "gpui::scene::Quad", "name": "Quad", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Default, Debug, Copy, Clone)] # [repr (C)] # [expect (missing_docs)] pub struct Quad { pub order : DrawOrder, pub border_style : BorderStyle, pub bounds : Bounds, pub content_mask : ContentMask, pub background : Background, pub border_color : Hsla, pub corner_radii : Corners, pub border_widths : Edges, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::Scene", "name": "Scene", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Default)] # [expect (missing_docs)] pub struct Scene { pub (crate) paint_operations : Vec, pub (crate) paint_epoch : std::sync::Arc<()>, pub (crate) paint_leases : Vec<(Range, crate::AtlasLease)>, # [doc = \" Rounded subtree geometry, separate from rectangular culling and optical\"] # [doc = \" capture bounds. Indices belong to this scene and expire on `clear`.\"] pub clip_nodes : crate::ClipNodes, active_clip : crate::ClipId, visual_transform : TransformationMatrix, primitive_bounds : BoundsTree, layer_stack : Vec<(DrawOrder, Bounds)>, # [cfg (test)] recording_work : std::cell::Cell, pub shadows : Vec, pub quads : Vec, pub paths : Vec>, pub underlines : Vec, pub monochrome_sprites : Vec, pub subpixel_sprites : Vec, pub polychrome_sprites : Vec, pub surfaces : Vec, # [doc = \" Glass surfaces — deliberately outside the primitive batch stream so\"] # [doc = \" renderers can snapshot the framebuffer at each surface's order.\"] pub backdrop_glass : Vec, }", "cfg": [] }, { "id": "gpui::scene::Scene::batches", "name": "batches", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn batches (& self) -> impl Iterator + '_", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::finish", "name": "finish", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn finish (& mut self)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::insert_backdrop_glass", "name": "insert_backdrop_glass", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn insert_backdrop_glass (& mut self, glass : BackdropGlass)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::insert_primitive", "name": "insert_primitive", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn insert_primitive (& mut self, primitive : impl Into)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Returns whether the scene contains no drawable primitives.", "documentation": "Returns whether the scene contains no drawable primitives.\n\nA scene may have paint operations that only open and close empty layers,\nso `len() == 0` is not equivalent to having no visible/input-relevant\noverlay content.", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::paint_resources_valid", "name": "paint_resources_valid", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Renderer submission must refuse a scene whose frozen resources reset after replay. No renderer may resolve its stale atlas coordinates.", "documentation": "Renderer submission must refuse a scene whose frozen resources reset\nafter replay. No renderer may resolve its stale atlas coordinates.", "signature": "pub fn paint_resources_valid (& self) -> bool", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::pop_layer", "name": "pop_layer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn pop_layer (& mut self)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::push_layer", "name": "push_layer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn push_layer (& mut self, bounds : Bounds)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::replay", "name": "replay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "pub fn replay (& mut self, range : Range, prev_scene : & Scene)", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::with_clip_chain", "name": "with_clip_chain", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Paint a scope using a value-typed clip chain in window coordinates. Rectangular culling and backdrop sampling remain independent of this chain.", "documentation": "Paint a scope using a value-typed clip chain in window coordinates.\nRectangular culling and backdrop sampling remain independent of this chain.", "signature": "pub fn with_clip_chain (& mut self, chain : & crate::ClipChain, scale : f32, paint : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Scene::with_visual_transform", "name": "with_visual_transform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Applies a complete inherited visual transform to subsequent emission. Geometry is baked before culling/batching; replay is already transformed.", "documentation": "Applies a complete inherited visual transform to subsequent emission.\nGeometry is baked before culling/batching; replay is already transformed.", "signature": "pub fn with_visual_transform (& mut self, transform : crate::VisualTransform, device_scale : f32, paint : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Scene" }, { "id": "gpui::scene::Shadow", "name": "Shadow", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Copy, Clone)] # [repr (C)] # [expect (missing_docs)] pub struct Shadow { pub order : DrawOrder, pub blur_radius : ScaledPixels, pub bounds : Bounds, pub corner_radii : Corners, pub content_mask : ContentMask, pub color : Hsla, pub element_bounds : Bounds, pub element_corner_radii : Corners, # [doc = \" 0 = drop shadow (rendered outside the element), 1 = inset shadow (rendered inside).\"] pub inset : u32, # [doc = \" 1 = cut the element's own rounded shape out of the shadow, so it reads\"] # [doc = \" as a ring rather than painting under the element. Only consulted for a\"] # [doc = \" drop shadow; an inset shadow is already clipped to the element.\"] pub outer_only : u32, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::SpriteBlendMode", "name": "SpriteBlendMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The fixed-function compositing equation used for a sprite batch.", "documentation": "The fixed-function compositing equation used for a sprite batch.\n\nBlending is selected per batch rather than per fragment so all renderer\nbackends use the same hardware equation. Source-over is appropriate for\npictures and portraits, additive for emitted light, and screen for soft\nglows that should retain detail in the backdrop.", "signature": "# [doc = \" The fixed-function compositing equation used for a sprite batch.\"] # [doc = \"\"] # [doc = \" Blending is selected per batch rather than per fragment so all renderer\"] # [doc = \" backends use the same hardware equation. Source-over is appropriate for\"] # [doc = \" pictures and portraits, additive for emitted light, and screen for soft\"] # [doc = \" glows that should retain detail in the backdrop.\"] # [derive (Copy, Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd)] # [repr (C)] pub enum SpriteBlendMode { # [doc = \" Ordinary source-over alpha compositing.\"] # [default] Normal = 0, # [doc = \" Adds source light without attenuating the destination color.\"] Additive = 1, # [doc = \" Lightens using `source + destination × (1 - source)`.\"] Screen = 2, }", "cfg": [] }, { "id": "gpui::scene::SpriteColorMode", "name": "SpriteColorMode", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "How a sprite sample becomes visible color.", "documentation": "How a sprite sample becomes visible color.", "signature": "# [doc = \" How a sprite sample becomes visible color.\"] # [derive (Copy, Clone, Debug, Default, Eq, PartialEq)] # [repr (C)] pub enum SpriteColorMode { # [doc = \" Preserve all sampled color channels and alpha.\"] # [default] Color = 0, # [doc = \" Convert sampled RGB to luminance while preserving sampled alpha.\"] Grayscale = 1, # [doc = \" Use sampled alpha as a mask for [`SpriteInstance::tint`].\"] AlphaMask = 2, }", "cfg": [] }, { "id": "gpui::scene::SpriteInstance", "name": "SpriteInstance", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "One independently transformed image sample in a composited sprite batch.", "documentation": "One independently transformed image sample in a composited sprite batch.\n\n`source` is a half-open pixel rectangle in the selected image frame. The\nrenderer narrows atlas UVs without creating another texture or cache entry.\nA sprite is paint-only: source-alpha holes and rounded corners do not invent\nhitboxes or accessibility nodes for the caller.", "signature": "# [doc = \" One independently transformed image sample in a composited sprite batch.\"] # [doc = \"\"] # [doc = \" `source` is a half-open pixel rectangle in the selected image frame. The\"] # [doc = \" renderer narrows atlas UVs without creating another texture or cache entry.\"] # [doc = \" A sprite is paint-only: source-alpha holes and rounded corners do not invent\"] # [doc = \" hitboxes or accessibility nodes for the caller.\"] # [derive (Copy, Clone, Debug, PartialEq)] pub struct SpriteInstance { # [doc = \" Destination bounds before [`SpriteTransform`] is applied.\"] pub destination : Bounds, # [doc = \" Half-open source rectangle in physical pixels of the image frame.\"] pub source : Bounds, # [doc = \" Destination-local transform around the destination center.\"] pub transform : SpriteTransform, # [doc = \" Rounded destination mask, transformed together with the destination.\"] pub corner_radii : Corners, # [doc = \" Additional opacity, clamped to `0.0..=1.0` while painting.\"] pub opacity : f32, # [doc = \" Sample-to-color conversion.\"] pub color_mode : SpriteColorMode, # [doc = \" Fixed-function batch compositing equation.\"] pub blend_mode : SpriteBlendMode, # [doc = \" Color used by [`SpriteColorMode::AlphaMask`].\"] pub tint : Hsla, }", "cfg": [] }, { "id": "gpui::scene::SpriteInstance::blend_mode", "name": "blend_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the fixed-function batch compositing equation.", "documentation": "Sets the fixed-function batch compositing equation.", "signature": "pub fn blend_mode (mut self, blend_mode : SpriteBlendMode) -> Self", "cfg": [], "target": "SpriteInstance" }, { "id": "gpui::scene::SpriteInstance::color_mode", "name": "color_mode", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the sample-to-color conversion and mask tint.", "documentation": "Sets the sample-to-color conversion and mask tint.", "signature": "pub fn color_mode (mut self, color_mode : SpriteColorMode, tint : Hsla) -> Self", "cfg": [], "target": "SpriteInstance" }, { "id": "gpui::scene::SpriteInstance::corner_radii", "name": "corner_radii", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the rounded destination mask.", "documentation": "Sets the rounded destination mask.", "signature": "pub fn corner_radii (mut self, corner_radii : Corners) -> Self", "cfg": [], "target": "SpriteInstance" }, { "id": "gpui::scene::SpriteInstance::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Creates a normal, opaque color sprite from an explicit source rectangle.", "documentation": "Creates a normal, opaque color sprite from an explicit source rectangle.", "signature": "pub fn new (destination : Bounds, source : Bounds) -> Self", "cfg": [], "target": "SpriteInstance" }, { "id": "gpui::scene::SpriteInstance::opacity", "name": "opacity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets additional sprite opacity.", "documentation": "Sets additional sprite opacity.", "signature": "pub fn opacity (mut self, opacity : f32) -> Self", "cfg": [], "target": "SpriteInstance" }, { "id": "gpui::scene::SpriteInstance::transform", "name": "transform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the destination-local transform.", "documentation": "Sets the destination-local transform.", "signature": "pub fn transform (mut self, transform : SpriteTransform) -> Self", "cfg": [], "target": "SpriteInstance" }, { "id": "gpui::scene::SpriteTransform", "name": "SpriteTransform", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "A destination-local sprite transform applied around the destination center.", "documentation": "A destination-local sprite transform applied around the destination center.", "signature": "# [doc = \" A destination-local sprite transform applied around the destination center.\"] # [derive (Copy, Clone, Debug, PartialEq)] pub struct SpriteTransform { # [doc = \" Non-uniform scale around the destination center.\"] pub scale : Size, # [doc = \" Clockwise rotation around the destination center.\"] pub rotation : Radians, # [doc = \" Logical-pixel translation applied after scale and rotation.\"] pub translation : Point, }", "cfg": [] }, { "id": "gpui::scene::SpriteTransform::identity", "name": "identity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Returns the identity transform.", "documentation": "Returns the identity transform.", "signature": "pub fn identity () -> Self", "cfg": [], "target": "SpriteTransform" }, { "id": "gpui::scene::SpriteTransform::rotate", "name": "rotate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the clockwise rotation around the destination center.", "documentation": "Sets the clockwise rotation around the destination center.", "signature": "pub fn rotate (mut self, rotation : Radians) -> Self", "cfg": [], "target": "SpriteTransform" }, { "id": "gpui::scene::SpriteTransform::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the scale around the destination center.", "documentation": "Sets the scale around the destination center.", "signature": "pub fn scale (mut self, scale : Size) -> Self", "cfg": [], "target": "SpriteTransform" }, { "id": "gpui::scene::SpriteTransform::translate", "name": "translate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Sets the logical-pixel translation after scale and rotation.", "documentation": "Sets the logical-pixel translation after scale and rotation.", "signature": "pub fn translate (mut self, translation : Point) -> Self", "cfg": [], "target": "SpriteTransform" }, { "id": "gpui::scene::SubpixelSprite", "name": "SubpixelSprite", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Copy, Clone, Debug)] # [repr (C)] # [expect (missing_docs)] pub struct SubpixelSprite { pub order : DrawOrder, pub pad : u32, pub bounds : Bounds, pub content_mask : ContentMask, pub color : Hsla, pub tile : AtlasTile, pub transformation : TransformationMatrix, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::TransformationMatrix", "name": "TransformationMatrix", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "A data type representing a 2 dimensional transformation that can be applied to an element.", "documentation": "A data type representing a 2 dimensional transformation that can be applied to an element.", "signature": "# [doc = \" A data type representing a 2 dimensional transformation that can be applied to an element.\"] # [derive (Debug, Clone, Copy, PartialEq)] # [repr (C)] pub struct TransformationMatrix { # [doc = \" 2x2 matrix containing rotation and scale,\"] # [doc = \" stored row-major\"] pub rotation_scale : [[f32; 2]; 2], # [doc = \" translation vector\"] pub translation : [f32; 2], }", "cfg": [] }, { "id": "gpui::scene::TransformationMatrix::apply", "name": "apply", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Apply transformation to a point, mainly useful for debugging", "documentation": "Apply transformation to a point, mainly useful for debugging", "signature": "pub fn apply (& self, point : Point) -> Point", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::TransformationMatrix::compose", "name": "compose", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Perform matrix multiplication with another transformation to produce a new transformation that is the result of applying both transformations: first, `other`, then `self`.", "documentation": "Perform matrix multiplication with another transformation\nto produce a new transformation that is the result of\napplying both transformations: first, `other`, then `self`.", "signature": "pub fn compose (self, other : TransformationMatrix) -> TransformationMatrix", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::TransformationMatrix::rotate", "name": "rotate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Clockwise rotation in radians around the origin", "documentation": "Clockwise rotation in radians around the origin", "signature": "pub fn rotate (self, angle : Radians) -> Self", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::TransformationMatrix::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Scale around the origin", "documentation": "Scale around the origin", "signature": "pub fn scale (self, size : Size) -> Self", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::TransformationMatrix::transform_bounds", "name": "transform_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Returns the axis-aligned device-pixel bounds that contain a transformed rectangle.", "documentation": "Returns the axis-aligned device-pixel bounds that contain a transformed rectangle.", "signature": "pub fn transform_bounds (& self, bounds : Bounds) -> Bounds", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::TransformationMatrix::translate", "name": "translate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Move the origin by a given point", "documentation": "Move the origin by a given point", "signature": "pub fn translate (mut self, point : Point) -> Self", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::TransformationMatrix::unit", "name": "unit", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The unit matrix, has no effect.", "documentation": "The unit matrix, has no effect.", "signature": "pub fn unit () -> Self", "cfg": [], "target": "TransformationMatrix" }, { "id": "gpui::scene::Underline", "name": "Underline", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Copy, Clone)] # [repr (C)] # [expect (missing_docs)] pub struct Underline { pub order : DrawOrder, pub pad : u32, pub bounds : Bounds, pub content_mask : ContentMask, pub color : Hsla, pub thickness : ScaledPixels, pub wavy : PaddedBool32, pub clip_id : crate::ClipId, }", "cfg": [] }, { "id": "gpui::scene::glass_edge_mask", "name": "glass_edge_mask", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "How strongly a surface's optics apply at `point`, given a linear edge mask.", "documentation": "How strongly a surface's optics apply at `point`, given a linear edge mask.\n\n1 keeps the optical result; 0 restores the undisplaced sharp snapshot.\nThe three shaders implement this same ramp.", "signature": "pub fn glass_edge_mask (point : Point, bounds : Bounds, edge : f32, band : f32) -> f32", "cfg": [] }, { "id": "gpui::scene::glass_field", "name": "glass_field", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The distance to the union of `lobes` and the direction it increases in.", "documentation": "The distance to the union of `lobes` and the direction it increases in.\n\nMirrors the three shaders' analytic rounded-rect and smooth-min gradients.\nA stencil across a medial-axis crease invents a bisector normal and hence\na specular ridge. Choose one incident face at ties instead. A bevel wider\nthan its corner radius still has a real crease; this does not smooth it or\nchange the silhouette. For a smooth union, blend derivatives by h/2 (the\nderivative of the polynomial correction). Do not normalize away the union's\nslope attenuation; the final three-dimensional surface normal is normalized.", "signature": "pub fn glass_field (at : Point, lobes : & [GlassLobe], smoothing : f32) -> GlassField", "cfg": [] }, { "id": "gpui::scene::glass_lobe_sdf", "name": "glass_lobe_sdf", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "Signed distance from `point` to one lobe, negative inside.", "documentation": "Signed distance from `point` to one lobe, negative inside.\n\nThis mirrors `quad_sdf` in the shaders exactly, including the unrounded\nfast path, because the two must not disagree about where an edge is.", "signature": "pub fn glass_lobe_sdf (point : Point, lobe : & GlassLobe) -> f32", "cfg": [] }, { "id": "gpui::scene::glass_smooth_min", "name": "glass_smooth_min", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The polynomial smooth minimum, which is what makes two lobes join into one body rather than cross as two outlines.", "documentation": "The polynomial smooth minimum, which is what makes two lobes join into one\nbody rather than cross as two outlines.\n\n`smoothing` of zero is an ordinary minimum, so a caller that wants a crease\ngets one without a second code path.", "signature": "pub fn glass_smooth_min (a : f32, b : f32, smoothing : f32) -> f32", "cfg": [] }, { "id": "gpui::scene::probe_sample_luminance", "name": "probe_sample_luminance", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "scene", "path": "gpui::scene", "source": "crates/gpui/src/scene.rs", "summary": "The relative luminance of one probe sample, from encoded channel values in `0..=1`.", "documentation": "The relative luminance of one probe sample, from encoded channel values in\n`0..=1`.\n\nThe weights are Rec. 709. The values are the encoded bytes the framebuffer\nholds rather than linearized light, which every renderer shares, so a probe\nmeans the same thing on each of them: a perceptual reading, not a photometric\none.", "signature": "pub fn probe_sample_luminance (red : f32, green : f32, blue : f32) -> f32", "cfg": [] }, { "id": "gpui::shared_uri::SharedUri", "name": "SharedUri", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "shared_uri", "path": "gpui::shared_uri", "source": "crates/gpui/src/shared_uri.rs", "summary": "A [`SharedString`] containing a URI.", "documentation": "A [`SharedString`] containing a URI.", "signature": "# [doc = \" A [`SharedString`] containing a URI.\"] # [derive (Deref, DerefMut, Default, PartialEq, Eq, Hash, Clone)] pub struct SharedUri (SharedString);", "cfg": [] }, { "id": "gpui::spring::AnimationPhase", "name": "AnimationPhase", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "A potentially overshooting coordinate within an animation.", "documentation": "A potentially overshooting coordinate within an animation.\n\nPhases are not restricted to 0..1. Multi-stage animations can assign each\nstage its own coordinate and interpolate over ranges such as 1..=2.", "signature": "# [doc = \" A potentially overshooting coordinate within an animation.\"] # [doc = \"\"] # [doc = \" Phases are not restricted to 0..1. Multi-stage animations can assign each\"] # [doc = \" stage its own coordinate and interpolate over ranges such as 1..=2.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, PartialOrd)] pub struct AnimationPhase (# [doc = \" The unbounded phase coordinate.\"] pub f32,);", "cfg": [] }, { "id": "gpui::spring::AnimationPhase::clamp", "name": "clamp", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Restricts this phase to the bounds of a range.", "documentation": "Restricts this phase to the bounds of a range.", "signature": "pub fn clamp (self, range : RangeInclusive) -> Self", "cfg": [], "target": "AnimationPhase" }, { "id": "gpui::spring::AnimationPhase::interpolate", "name": "interpolate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Interpolates between values using 0 and 1 as their phase coordinates.", "documentation": "Interpolates between values using 0 and 1 as their phase coordinates.", "signature": "pub fn interpolate (self, from : T, to : T) -> T", "cfg": [], "target": "AnimationPhase" }, { "id": "gpui::spring::AnimationPhase::interpolate_between", "name": "interpolate_between", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Interpolates between values assigned to arbitrary phase coordinates.", "documentation": "Interpolates between values assigned to arbitrary phase coordinates.", "signature": "pub fn interpolate_between (self, range : RangeInclusive, from : T, to : T,) -> T", "cfg": [], "target": "AnimationPhase" }, { "id": "gpui::spring::AnimationPhase::interpolate_between_clamped", "name": "interpolate_between_clamped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Interpolates over arbitrary phase coordinates without extrapolating.", "documentation": "Interpolates over arbitrary phase coordinates without extrapolating.", "signature": "pub fn interpolate_between_clamped (self, range : RangeInclusive, from : T, to : T,) -> T", "cfg": [], "target": "AnimationPhase" }, { "id": "gpui::spring::AnimationPhase::interpolate_clamped", "name": "interpolate_clamped", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Interpolates between values without extrapolating beyond 0 and 1.", "documentation": "Interpolates between values without extrapolating beyond 0 and 1.", "signature": "pub fn interpolate_clamped (self, from : T, to : T) -> T", "cfg": [], "target": "AnimationPhase" }, { "id": "gpui::spring::Interpolate", "name": "Interpolate", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "A value that supports linear interpolation and extrapolation.", "documentation": "A value that supports linear interpolation and extrapolation.", "signature": "# [doc = \" A value that supports linear interpolation and extrapolation.\"] pub trait Interpolate : Sized { # [doc = \" Resolves the value at `phase`, where 0 is `from` and 1 is `to`.\"] fn interpolate (from : Self, to : Self, phase : f32) -> Self; }", "cfg": [] }, { "id": "gpui::spring::SpringAnimation", "name": "SpringAnimation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "A stateful spring animation targeting a value or projected path.", "documentation": "A stateful spring animation targeting a value or projected path.", "signature": "# [doc = \" A stateful spring animation targeting a value or projected path.\"] # [derive (Clone, Debug)] pub struct SpringAnimation { pub (crate) config : SpringConfig, pub (crate) target : T, pub (crate) epsilon : f32, pub (crate) initial : Option, pub (crate) playback : SpringPlayback, }", "cfg": [] }, { "id": "gpui::spring::SpringAnimation::from", "name": "from", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Sets the coordinate used when this element has no prior spring state.", "documentation": "Sets the coordinate used when this element has no prior spring state.", "signature": "pub fn from (mut self, initial : T) -> Self", "cfg": [], "target": "SpringAnimation" }, { "id": "gpui::spring::SpringAnimation::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Creates a spring animation builder.", "documentation": "Creates a spring animation builder.", "signature": "pub fn new (config : SpringConfig) -> Self", "cfg": [], "target": "SpringAnimation<()>" }, { "id": "gpui::spring::SpringAnimation::playback", "name": "playback", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Sets how the spring advances or resolves its current value.", "documentation": "Sets how the spring advances or resolves its current value.", "signature": "pub fn playback (mut self, playback : SpringPlayback) -> Self", "cfg": [], "target": "SpringAnimation" }, { "id": "gpui::spring::SpringAnimation::to", "name": "to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Sets the value or path targeted by this spring.", "documentation": "Sets the value or path targeted by this spring.", "signature": "pub fn to (self, target : T) -> SpringAnimation", "cfg": [], "target": "SpringAnimation<()>" }, { "id": "gpui::spring::SpringAnimation::with_epsilon", "name": "with_epsilon", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Sets the settling tolerance in the target's scalar coordinate space.", "documentation": "Sets the settling tolerance in the target's scalar coordinate space.", "signature": "pub fn with_epsilon (mut self, epsilon : f32) -> Self", "cfg": [], "target": "SpringAnimation" }, { "id": "gpui::spring::SpringConfig", "name": "SpringConfig", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "The physical parameters of a damped harmonic oscillator.", "documentation": "The physical parameters of a damped harmonic oscillator.\n\n`stiffness` and `mass` must be finite and positive. `damping` must be finite\nand non-negative.", "signature": "# [doc = \" The physical parameters of a damped harmonic oscillator.\"] # [doc = \"\"] # [doc = \" `stiffness` and `mass` must be finite and positive. `damping` must be finite\"] # [doc = \" and non-negative.\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct SpringConfig { # [doc = \" The spring stiffness, conventionally written as $k$.\"] pub stiffness : f32, # [doc = \" The viscous damping coefficient, conventionally written as $c$.\"] pub damping : f32, # [doc = \" The moving mass, conventionally written as $m$.\"] pub mass : f32, }", "cfg": [] }, { "id": "gpui::spring::SpringConfig::canonical", "name": "canonical", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Returns the natural angular frequency and damping ratio $(\\omega_0, \\zeta)$.", "documentation": "Returns the natural angular frequency and damping ratio $(\\omega_0, \\zeta)$.", "signature": "pub fn canonical (& self) -> (f32, f32)", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringConfig::is_settled", "name": "is_settled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Tests both displacement and velocity against a positional tolerance.", "documentation": "Tests both displacement and velocity against a positional tolerance.\n\nVelocity is compared with `epsilon * natural_frequency`, giving it the\ncorresponding animated-units-per-second scale.", "signature": "pub fn is_settled (& self, state : SpringState, target : f32, epsilon : f32) -> bool", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringConfig::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Creates a spring from its physical parameters.", "documentation": "Creates a spring from its physical parameters.", "signature": "pub const fn new (stiffness : f32, damping : f32, mass : f32) -> Self", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringConfig::propagator", "name": "propagator", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Returns the exact state-transition matrix for a constant target.", "documentation": "Returns the exact state-transition matrix for a constant target.\n\nMaterializing this matrix is useful when many springs share the same\nconfiguration and frame delta. A matrix must not be reused when the\nframe delta changes.", "signature": "pub fn propagator (& self, delta_time : f32) -> [[f32; 2]; 2]", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringConfig::settle_time", "name": "settle_time", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Returns a conservative time after which the spring remains settled.", "documentation": "Returns a conservative time after which the spring remains settled.\n\nAn undamped spring has no finite settling time and returns\n[`Duration::MAX`].", "signature": "pub fn settle_time (& self, state : SpringState, target : f32, epsilon : f32) -> Duration", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringConfig::step", "name": "step", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Advances a spring toward a target that remains fixed for `delta_time`.", "documentation": "Advances a spring toward a target that remains fixed for `delta_time`.\n\nThis analytic step is independent of frame rate and preserves velocity,\nallowing an interrupted spring to be retargeted without restarting it.", "signature": "pub fn step (& self, state : SpringState, target : f32, delta_time : f32) -> SpringState", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringConfig::step_ramp", "name": "step_ramp", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Advances a spring toward a target moving at a constant velocity.", "documentation": "Advances a spring toward a target moving at a constant velocity.\n\nA first-order hold avoids the frame-rate-dependent lag introduced by\ntreating a dragged target as stationary between frames.", "signature": "pub fn step_ramp (& self, state : SpringState, target : f32, target_velocity : f32, delta_time : f32,) -> SpringState", "cfg": [], "target": "SpringConfig" }, { "id": "gpui::spring::SpringPlayback", "name": "SpringPlayback", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Controls how a spring advances and resolves its presentation value.", "documentation": "Controls how a spring advances and resolves its presentation value.", "signature": "# [doc = \" Controls how a spring advances and resolves its presentation value.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub enum SpringPlayback { # [doc = \" Advances toward the latest target, preserving velocity across retargets.\"] # [default] Running, # [doc = \" Holds the current position and velocity until playback resumes.\"] Paused, # [doc = \" Holds the current position and discards velocity.\"] Stopped, # [doc = \" Snaps to the latest target and discards velocity.\"] Completed, # [doc = \" Returns to the initial value and discards velocity.\"] Cancelled, }", "cfg": [] }, { "id": "gpui::spring::SpringState", "name": "SpringState", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "The instantaneous position and velocity of a spring.", "documentation": "The instantaneous position and velocity of a spring.", "signature": "# [doc = \" The instantaneous position and velocity of a spring.\"] # [derive (Clone, Copy, Debug, Default, PartialEq)] pub struct SpringState { # [doc = \" The current value in the animated unit.\"] pub position : f32, # [doc = \" The current value's change per second.\"] pub velocity : f32, }", "cfg": [] }, { "id": "gpui::spring::SpringTarget", "name": "SpringTarget", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "A value that can be targeted by a one-dimensional spring.", "documentation": "A value that can be targeted by a one-dimensional spring.\n\nImplementations may project the spring coordinate into a richer output,\nallowing a discrete state or a path through a multidimensional value to be\ndriven by one spring.", "signature": "# [doc = \" A value that can be targeted by a one-dimensional spring.\"] # [doc = \"\"] # [doc = \" Implementations may project the spring coordinate into a richer output,\"] # [doc = \" allowing a discrete state or a path through a multidimensional value to be\"] # [doc = \" driven by one spring.\"] pub trait SpringTarget : 'static { # [doc = \" The value supplied to the spring animator.\"] type Output; # [doc = \" Returns the target in the spring's coordinate space.\"] fn target (& self) -> f32; # [doc = \" Projects a spring coordinate into the animated output.\"] fn resolve (& self, value : f32) -> Self::Output; }", "cfg": [] }, { "id": "gpui::spring::sampled_easing", "name": "sampled_easing", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "spring", "path": "gpui::spring", "source": "crates/gpui/src/spring.rs", "summary": "Adapts a spring starting at zero with no velocity to GPUI's duration-based easing API.", "documentation": "Adapts a spring starting at zero with no velocity to GPUI's duration-based easing API.\n\nThe returned easing can overshoot the normalized 0..1 output range. Retargeting\nthis duration-based form restarts the spring; use [`SpringConfig::step`] when\npreserving velocity matters.", "signature": "pub fn sampled_easing (config : SpringConfig, epsilon : f32) -> (Duration, impl Fn (f32) -> f32)", "cfg": [] }, { "id": "gpui::style::AlignContent", "name": "AlignContent", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Sets the distribution of space between and around content items For Flexbox it controls alignment in the cross axis For Grid it controls alignment in the block axis", "documentation": "Sets the distribution of space between and around content items\nFor Flexbox it controls alignment in the cross axis\nFor Grid it controls alignment in the block axis\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content)", "signature": "# [doc = \" Sets the distribution of space between and around content items\"] # [doc = \" For Flexbox it controls alignment in the cross axis\"] # [doc = \" For Grid it controls alignment in the block axis\"] # [doc = \"\"] # [doc = \" [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content)\"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Serialize, Deserialize, JsonSchema)] pub enum AlignContent { # [doc = \" Items are packed toward the start of the axis\"] Start, # [doc = \" Items are packed toward the end of the axis\"] End, # [doc = \" Items are packed towards the flex-relative start of the axis.\"] # [doc = \"\"] # [doc = \" For flex containers with flex_direction RowReverse or ColumnReverse this is equivalent\"] # [doc = \" to End. In all other cases it is equivalent to Start.\"] FlexStart, # [doc = \" Items are packed towards the flex-relative end of the axis.\"] # [doc = \"\"] # [doc = \" For flex containers with flex_direction RowReverse or ColumnReverse this is equivalent\"] # [doc = \" to Start. In all other cases it is equivalent to End.\"] FlexEnd, # [doc = \" Items are centered around the middle of the axis\"] Center, # [doc = \" Items are stretched to fill the container\"] Stretch, # [doc = \" The first and last items are aligned flush with the edges of the container (no gap)\"] # [doc = \" The gap between items is distributed evenly.\"] SpaceBetween, # [doc = \" The gap between the first and last items is exactly THE SAME as the gap between items.\"] # [doc = \" The gaps are distributed evenly\"] SpaceEvenly, # [doc = \" The gap between the first and last items is exactly HALF the gap between items.\"] # [doc = \" The gaps are distributed evenly in proportion to these ratios.\"] SpaceAround, }", "cfg": [] }, { "id": "gpui::style::AlignItems", "name": "AlignItems", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Used to control how child nodes are aligned. For Flexbox it controls alignment in the cross axis For Grid it controls alignment in the block axis", "documentation": "Used to control how child nodes are aligned.\nFor Flexbox it controls alignment in the cross axis\nFor Grid it controls alignment in the block axis\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)", "signature": "# [doc = \" Used to control how child nodes are aligned.\"] # [doc = \" For Flexbox it controls alignment in the cross axis\"] # [doc = \" For Grid it controls alignment in the block axis\"] # [doc = \"\"] # [doc = \" [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)\"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Serialize, Deserialize, JsonSchema)] pub enum AlignItems { # [doc = \" Items are packed toward the start of the axis\"] Start, # [doc = \" Items are packed toward the end of the axis\"] End, # [doc = \" Items are packed towards the flex-relative start of the axis.\"] # [doc = \"\"] # [doc = \" For flex containers with flex_direction RowReverse or ColumnReverse this is equivalent\"] # [doc = \" to End. In all other cases it is equivalent to Start.\"] FlexStart, # [doc = \" Items are packed towards the flex-relative end of the axis.\"] # [doc = \"\"] # [doc = \" For flex containers with flex_direction RowReverse or ColumnReverse this is equivalent\"] # [doc = \" to Start. In all other cases it is equivalent to End.\"] FlexEnd, # [doc = \" Items are packed along the center of the cross axis\"] Center, # [doc = \" Items are aligned such as their baselines align\"] Baseline, # [doc = \" Stretch to fill the container\"] Stretch, }", "cfg": [] }, { "id": "gpui::style::AlignSelf", "name": "AlignSelf", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Used to control how the specified nodes is aligned. Overrides the parent Node's `AlignItems` property. For Flexbox it controls alignment in the cross axis For Grid it controls alignment in the block axis", "documentation": "Used to control how the specified nodes is aligned.\nOverrides the parent Node's `AlignItems` property.\nFor Flexbox it controls alignment in the cross axis\nFor Grid it controls alignment in the block axis\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self)", "signature": "# [doc = \" Used to control how the specified nodes is aligned.\"] # [doc = \" Overrides the parent Node's `AlignItems` property.\"] # [doc = \" For Flexbox it controls alignment in the cross axis\"] # [doc = \" For Grid it controls alignment in the block axis\"] # [doc = \"\"] # [doc = \" [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self)\"] pub type AlignSelf = AlignItems;", "cfg": [] }, { "id": "gpui::style::BoxShadow", "name": "BoxShadow", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The possible values of the box-shadow property", "documentation": "The possible values of the box-shadow property", "signature": "# [doc = \" The possible values of the box-shadow property\"] # [derive (Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)] pub struct BoxShadow { # [doc = \" What color should the shadow have?\"] pub color : Hsla, # [doc = \" How should it be offset from its element?\"] pub offset : Point, # [doc = \" How much should the shadow be blurred?\"] pub blur_radius : Pixels, # [doc = \" How much should the shadow spread?\"] pub spread_radius : Pixels, # [doc = \" Whether the shadow is cast outward, outward-clipped, or inward.\"] pub style : ShadowStyle, }", "cfg": [] }, { "id": "gpui::style::BoxShadow::blur_radius", "name": "blur_radius", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Sets the shadow blur radius.", "documentation": "Sets the shadow blur radius.", "signature": "pub fn blur_radius (mut self, blur_radius : Pixels) -> Self", "cfg": [], "target": "BoxShadow" }, { "id": "gpui::style::BoxShadow::inset", "name": "inset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Marks the shadow as inset (drawn inside the element's bounds).", "documentation": "Marks the shadow as inset (drawn inside the element's bounds).", "signature": "pub fn inset (mut self) -> Self", "cfg": [], "target": "BoxShadow" }, { "id": "gpui::style::BoxShadow::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Creates a new [`BoxShadow`] with the given offset and color, matching the order of the CSS `box-shadow` property. Use the builder methods to set blur radius, spread radius, and inset.", "documentation": "Creates a new [`BoxShadow`] with the given offset and color, matching the order\nof the CSS `box-shadow` property. Use the builder methods to set blur radius,\nspread radius, and inset.", "signature": "pub fn new (offset_x : Pixels, offset_y : Pixels, color : Hsla) -> Self", "cfg": [], "target": "BoxShadow" }, { "id": "gpui::style::BoxShadow::ring", "name": "ring", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Cuts the element's own shape out of the shadow, so it reads as a ring whether or not the element it rings has a fill.", "documentation": "Cuts the element's own shape out of the shadow, so it reads as a ring\nwhether or not the element it rings has a fill.", "signature": "pub fn ring (mut self) -> Self", "cfg": [], "target": "BoxShadow" }, { "id": "gpui::style::BoxShadow::spread_radius", "name": "spread_radius", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Sets the shadow spread radius.", "documentation": "Sets the shadow spread radius.", "signature": "pub fn spread_radius (mut self, spread_radius : Pixels) -> Self", "cfg": [], "target": "BoxShadow" }, { "id": "gpui::style::DebugBelow", "name": "DebugBelow", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Use this struct for interfacing with the 'debug_below' styling from your own elements. If a parent element has this style set on it, then this struct will be set as a global in GPUI.", "documentation": "Use this struct for interfacing with the 'debug_below' styling from your own elements.\nIf a parent element has this style set on it, then this struct will be set as a global in\nGPUI.", "signature": "# [doc = \" Use this struct for interfacing with the 'debug_below' styling from your own elements.\"] # [doc = \" If a parent element has this style set on it, then this struct will be set as a global in\"] # [doc = \" GPUI.\"] # [cfg (debug_assertions)] pub struct DebugBelow;", "cfg": [ "cfg (debug_assertions)" ] }, { "id": "gpui::style::Display", "name": "Display", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Sets the layout used for the children of this node", "documentation": "Sets the layout used for the children of this node\n\nThe default values depends on on which feature flags are enabled. The order of precedence is: Flex, Grid, Block, None.", "signature": "# [doc = \" Sets the layout used for the children of this node\"] # [doc = \"\"] # [doc = \" The default values depends on on which feature flags are enabled. The order of precedence is: Flex, Grid, Block, None.\"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Default, Serialize, Deserialize, JsonSchema)] pub enum Display { # [doc = \" The children will follow the block layout algorithm\"] Block, # [doc = \" The children will follow the flexbox layout algorithm\"] # [default] Flex, # [doc = \" The children will follow the CSS Grid layout algorithm\"] Grid, # [doc = \" The children will not be laid out, and will follow absolute positioning\"] None, }", "cfg": [] }, { "id": "gpui::style::Fill", "name": "Fill", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The kinds of fill that can be applied to a shape.", "documentation": "The kinds of fill that can be applied to a shape.", "signature": "# [doc = \" The kinds of fill that can be applied to a shape.\"] # [derive (Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)] pub enum Fill { # [doc = \" A solid color fill.\"] Color (Background), }", "cfg": [] }, { "id": "gpui::style::Fill::color", "name": "color", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Unwrap this fill into a solid color, if it is one.", "documentation": "Unwrap this fill into a solid color, if it is one.\n\nIf the fill is not a solid color, this method returns `None`.", "signature": "pub fn color (& self) -> Option", "cfg": [], "target": "Fill" }, { "id": "gpui::style::FlexDirection", "name": "FlexDirection", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The direction of the flexbox layout main axis.", "documentation": "The direction of the flexbox layout main axis.\n\nThere are always two perpendicular layout axes: main (or primary) and cross (or secondary).\nAdding items will cause them to be positioned adjacent to each other along the main axis.\nBy varying this value throughout your tree, you can create complex axis-aligned layouts.\n\nItems are always aligned relative to the cross axis, and justified relative to the main axis.\n\nThe default behavior is [`FlexDirection::Row`].\n\n[Specification](https://www.w3.org/TR/css-flexbox-1/#flex-direction-property)", "signature": "# [doc = \" The direction of the flexbox layout main axis.\"] # [doc = \"\"] # [doc = \" There are always two perpendicular layout axes: main (or primary) and cross (or secondary).\"] # [doc = \" Adding items will cause them to be positioned adjacent to each other along the main axis.\"] # [doc = \" By varying this value throughout your tree, you can create complex axis-aligned layouts.\"] # [doc = \"\"] # [doc = \" Items are always aligned relative to the cross axis, and justified relative to the main axis.\"] # [doc = \"\"] # [doc = \" The default behavior is [`FlexDirection::Row`].\"] # [doc = \"\"] # [doc = \" [Specification](https://www.w3.org/TR/css-flexbox-1/#flex-direction-property)\"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Default, Serialize, Deserialize, JsonSchema)] pub enum FlexDirection { # [doc = \" Defines +x as the main axis\"] # [doc = \"\"] # [doc = \" Items will be added from left to right in a row.\"] # [default] Row, # [doc = \" Defines +y as the main axis\"] # [doc = \"\"] # [doc = \" Items will be added from top to bottom in a column.\"] Column, # [doc = \" Defines -x as the main axis\"] # [doc = \"\"] # [doc = \" Items will be added from right to left in a row.\"] RowReverse, # [doc = \" Defines -y as the main axis\"] # [doc = \"\"] # [doc = \" Items will be added from bottom to top in a column.\"] ColumnReverse, }", "cfg": [] }, { "id": "gpui::style::FlexWrap", "name": "FlexWrap", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Controls whether flex items are forced onto one line or can wrap onto multiple lines.", "documentation": "Controls whether flex items are forced onto one line or can wrap onto multiple lines.\n\nDefaults to [`FlexWrap::NoWrap`]\n\n[Specification](https://www.w3.org/TR/css-flexbox-1/#flex-wrap-property)", "signature": "# [doc = \" Controls whether flex items are forced onto one line or can wrap onto multiple lines.\"] # [doc = \"\"] # [doc = \" Defaults to [`FlexWrap::NoWrap`]\"] # [doc = \"\"] # [doc = \" [Specification](https://www.w3.org/TR/css-flexbox-1/#flex-wrap-property)\"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Default, Serialize, Deserialize, JsonSchema)] pub enum FlexWrap { # [doc = \" Items will not wrap and stay on a single line\"] # [default] NoWrap, # [doc = \" Items will wrap according to this item's [`FlexDirection`]\"] Wrap, # [doc = \" Items will wrap in the opposite direction to this item's [`FlexDirection`]\"] WrapReverse, }", "cfg": [] }, { "id": "gpui::style::GridTemplate", "name": "GridTemplate", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "A simplified representation of the grid-template-* value", "documentation": "A simplified representation of the grid-template-* value", "signature": "# [doc = \" A simplified representation of the grid-template-* value\"] # [derive (Copy, Clone, Refineable, PartialEq, Eq, PartialOrd, Ord, Debug, Default, JsonSchema, Serialize, Deserialize,)] pub struct GridTemplate { # [doc = \" How this template directive should be repeated\"] pub repeat : u16, # [doc = \" The minimum size in the repeat(<>, minmax(_, 1fr)) equation\"] pub min_size : GridTemplateMinSize, }", "cfg": [] }, { "id": "gpui::style::GridTemplateMinSize", "name": "GridTemplateMinSize", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The minimum size of a column or row in a grid layout", "documentation": "The minimum size of a column or row in a grid layout", "signature": "# [doc = \" The minimum size of a column or row in a grid layout\"] # [derive (Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Default, JsonSchema, Serialize, Deserialize,)] pub enum GridTemplateMinSize { # [doc = \" The column or row size may be 0\"] # [default] Zero, # [doc = \" The column or row size can be determined by the min content\"] MinContent, # [doc = \" The column or row size can be determined by the max content\"] MaxContent, }", "cfg": [] }, { "id": "gpui::style::HighlightStyle", "name": "HighlightStyle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "A highlight style to apply, similar to a `TextStyle` except for a single font, uniformly sized and spaced text.", "documentation": "A highlight style to apply, similar to a `TextStyle` except\nfor a single font, uniformly sized and spaced text.", "signature": "# [doc = \" A highlight style to apply, similar to a `TextStyle` except\"] # [doc = \" for a single font, uniformly sized and spaced text.\"] # [derive (Copy, Clone, Debug, Default, PartialEq)] pub struct HighlightStyle { # [doc = \" The color of the text\"] pub color : Option, # [doc = \" The font weight, e.g. bold\"] pub font_weight : Option, # [doc = \" The font style, e.g. italic\"] pub font_style : Option, # [doc = \" The background color of the text\"] pub background_color : Option, # [doc = \" A uniform corner radius for each painted fragment of the background.\"] pub background_radius : Option, # [doc = \" How far each painted fragment of the background reaches past the run's\"] # [doc = \" glyphs, horizontally, on each side.\"] # [doc = \"\"] # [doc = \" Decoration, so it grows the quad and moves nothing: the run keeps the\"] # [doc = \" advance width it was shaped to, the glyphs stay where they were laid\"] # [doc = \" out, and the text around them does not reflow. That is the whole reason\"] # [doc = \" this is here rather than in the layout — a marked word inside a\"] # [doc = \" sentence cannot pay for its own breathing room by pushing the sentence\"] # [doc = \" apart.\"] # [doc = \"\"] # [doc = \" Without it a background is painted exactly on the glyph advances, so a\"] # [doc = \" highlighted word is jammed against its own fill on both sides, and\"] # [doc = \" [`Self::background_radius`] makes it worse rather than better by\"] # [doc = \" rounding a corner into the first and last letter.\"] pub background_padding : Option, # [doc = \" The underline style of the text\"] pub underline : Option, # [doc = \" The underline style of the text\"] pub strikethrough : Option, # [doc = \" Similar to the CSS `opacity` property, this will cause the text to be less vibrant.\"] pub fade_out : Option, }", "cfg": [] }, { "id": "gpui::style::HighlightStyle::color", "name": "color", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Create a highlight style with just a color", "documentation": "Create a highlight style with just a color", "signature": "pub fn color (color : Hsla) -> Self", "cfg": [], "target": "HighlightStyle" }, { "id": "gpui::style::HighlightStyle::highlight", "name": "highlight", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Blend this highlight style with another. Non-continuous properties, like font_weight and font_style, are overwritten.", "documentation": "Blend this highlight style with another.\nNon-continuous properties, like font_weight and font_style, are overwritten.", "signature": "pub fn highlight (self, other : HighlightStyle) -> Self", "cfg": [], "target": "HighlightStyle" }, { "id": "gpui::style::JustifyContent", "name": "JustifyContent", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Sets the distribution of space between and around content items For Flexbox it controls alignment in the main axis For Grid it controls alignment in the inline axis", "documentation": "Sets the distribution of space between and around content items\nFor Flexbox it controls alignment in the main axis\nFor Grid it controls alignment in the inline axis\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content)", "signature": "# [doc = \" Sets the distribution of space between and around content items\"] # [doc = \" For Flexbox it controls alignment in the main axis\"] # [doc = \" For Grid it controls alignment in the inline axis\"] # [doc = \"\"] # [doc = \" [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content)\"] pub type JustifyContent = AlignContent;", "cfg": [] }, { "id": "gpui::style::JustifyItems", "name": "JustifyItems", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Used to control how child nodes are aligned. Does not apply to Flexbox, and will be ignored if specified on a flex container For Grid it controls alignment in the inline axis", "documentation": "Used to control how child nodes are aligned.\nDoes not apply to Flexbox, and will be ignored if specified on a flex container\nFor Grid it controls alignment in the inline axis\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items)", "signature": "# [doc = \" Used to control how child nodes are aligned.\"] # [doc = \" Does not apply to Flexbox, and will be ignored if specified on a flex container\"] # [doc = \" For Grid it controls alignment in the inline axis\"] # [doc = \"\"] # [doc = \" [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items)\"] pub type JustifyItems = AlignItems;", "cfg": [] }, { "id": "gpui::style::JustifySelf", "name": "JustifySelf", "kind": "type", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Used to control how the specified nodes is aligned. Overrides the parent Node's `JustifyItems` property. Does not apply to Flexbox, and will be ignored if specified on a flex child For Grid it controls alignment in the inline axis", "documentation": "Used to control how the specified nodes is aligned.\nOverrides the parent Node's `JustifyItems` property.\nDoes not apply to Flexbox, and will be ignored if specified on a flex child\nFor Grid it controls alignment in the inline axis\n\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self)", "signature": "# [doc = \" Used to control how the specified nodes is aligned.\"] # [doc = \" Overrides the parent Node's `JustifyItems` property.\"] # [doc = \" Does not apply to Flexbox, and will be ignored if specified on a flex child\"] # [doc = \" For Grid it controls alignment in the inline axis\"] # [doc = \"\"] # [doc = \" [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self)\"] pub type JustifySelf = AlignItems;", "cfg": [] }, { "id": "gpui::style::ObjectFit", "name": "ObjectFit", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "How to fit the image into the bounds of the element.", "documentation": "How to fit the image into the bounds of the element.", "signature": "# [doc = \" How to fit the image into the bounds of the element.\"] pub enum ObjectFit { # [doc = \" The image will be stretched to fill the bounds of the element.\"] Fill, # [doc = \" The image will be scaled to fit within the bounds of the element.\"] Contain, # [doc = \" The image will be scaled to cover the bounds of the element.\"] Cover, # [doc = \" The image will be scaled down to fit within the bounds of the element.\"] ScaleDown, # [doc = \" The image will maintain its original size.\"] None, }", "cfg": [] }, { "id": "gpui::style::ObjectFit::get_bounds", "name": "get_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Get the bounds of the image within the given bounds.", "documentation": "Get the bounds of the image within the given bounds.", "signature": "pub fn get_bounds (& self, bounds : Bounds, image_size : Size,) -> Bounds", "cfg": [], "target": "ObjectFit" }, { "id": "gpui::style::Overflow", "name": "Overflow", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "How children overflowing their container should affect layout", "documentation": "How children overflowing their container should affect layout\n\nIn CSS the primary effect of this property is to control whether contents of a parent container that overflow that container should\nbe displayed anyway, be clipped, or trigger the container to become a scroll container. However it also has secondary effects on layout,\nthe main ones being:\n\n- The automatic minimum size Flexbox/CSS Grid items with non-`Visible` overflow is `0` rather than being content based\n- `Overflow::Scroll` nodes have space in the layout reserved for a scrollbar (width controlled by the `scrollbar_width` property)\n\nIn Taffy, we only implement the layout related secondary effects as we are not concerned with drawing/painting. The amount of space reserved for\na scrollbar is controlled by the `scrollbar_width` property. If this is `0` then `Scroll` behaves identically to `Hidden`.\n\n", "signature": "# [doc = \" How children overflowing their container should affect layout\"] # [doc = \"\"] # [doc = \" In CSS the primary effect of this property is to control whether contents of a parent container that overflow that container should\"] # [doc = \" be displayed anyway, be clipped, or trigger the container to become a scroll container. However it also has secondary effects on layout,\"] # [doc = \" the main ones being:\"] # [doc = \"\"] # [doc = \" - The automatic minimum size Flexbox/CSS Grid items with non-`Visible` overflow is `0` rather than being content based\"] # [doc = \" - `Overflow::Scroll` nodes have space in the layout reserved for a scrollbar (width controlled by the `scrollbar_width` property)\"] # [doc = \"\"] # [doc = \" In Taffy, we only implement the layout related secondary effects as we are not concerned with drawing/painting. The amount of space reserved for\"] # [doc = \" a scrollbar is controlled by the `scrollbar_width` property. If this is `0` then `Scroll` behaves identically to `Hidden`.\"] # [doc = \"\"] # [doc = \" \"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Default, Serialize, Deserialize, JsonSchema)] pub enum Overflow { # [doc = \" The automatic minimum size of this node as a flexbox/grid item should be based on the size of its content.\"] # [doc = \" Content that overflows this node *should* contribute to the scroll region of its parent.\"] # [default] Visible, # [doc = \" The automatic minimum size of this node as a flexbox/grid item should be based on the size of its content.\"] # [doc = \" Content that overflows this node should *not* contribute to the scroll region of its parent.\"] Clip, # [doc = \" The automatic minimum size of this node as a flexbox/grid item should be `0`.\"] # [doc = \" Content that overflows this node should *not* contribute to the scroll region of its parent.\"] Hidden, # [doc = \" The automatic minimum size of this node as a flexbox/grid item should be `0`. Additionally, space should be reserved\"] # [doc = \" for a scrollbar. The amount of space reserved is controlled by the `scrollbar_width` property.\"] # [doc = \" Content that overflows this node should *not* contribute to the scroll region of its parent.\"] Scroll, }", "cfg": [] }, { "id": "gpui::style::Position", "name": "Position", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The positioning strategy for this item.", "documentation": "The positioning strategy for this item.\n\nThis controls both how the origin is determined for the [`Style::position`] field,\nand whether or not the item will be controlled by flexbox's layout algorithm.\n\nWARNING: this enum follows the behavior of [CSS's `position` property](https://developer.mozilla.org/en-US/docs/Web/CSS/position),\nwhich can be unintuitive.\n\n[`Position::Relative`] is the default value, in contrast to the default behavior in CSS.", "signature": "# [doc = \" The positioning strategy for this item.\"] # [doc = \"\"] # [doc = \" This controls both how the origin is determined for the [`Style::position`] field,\"] # [doc = \" and whether or not the item will be controlled by flexbox's layout algorithm.\"] # [doc = \"\"] # [doc = \" WARNING: this enum follows the behavior of [CSS's `position` property](https://developer.mozilla.org/en-US/docs/Web/CSS/position),\"] # [doc = \" which can be unintuitive.\"] # [doc = \"\"] # [doc = \" [`Position::Relative`] is the default value, in contrast to the default behavior in CSS.\"] # [derive (Copy, Clone, PartialEq, Eq, Debug, Default, Serialize, Deserialize, JsonSchema)] pub enum Position { # [doc = \" The offset is computed relative to the final position given by the layout algorithm.\"] # [doc = \" Offsets do not affect the position of any other items; they are effectively a correction factor applied at the end.\"] # [default] Relative, # [doc = \" The offset is computed relative to this item's closest positioned ancestor, if any.\"] # [doc = \" Otherwise, it is placed relative to the origin.\"] # [doc = \" No space is created for the item in the page layout, and its size will not be altered.\"] # [doc = \"\"] # [doc = \" WARNING: to opt-out of layouting entirely, you must use [`Display::None`] instead on your [`Style`] object.\"] Absolute, }", "cfg": [] }, { "id": "gpui::style::ShadowStyle", "name": "ShadowStyle", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "How a shadow is cast relative to the element that owns it.", "documentation": "How a shadow is cast relative to the element that owns it.\n\nThe three are genuinely different pictures, which is why this is not two\nbooleans: a shadow cannot be cast inward and clipped outward at once.", "signature": "# [doc = \" How a shadow is cast relative to the element that owns it.\"] # [doc = \"\"] # [doc = \" The three are genuinely different pictures, which is why this is not two\"] # [doc = \" booleans: a shadow cannot be cast inward and clipped outward at once.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)] pub enum ShadowStyle { # [doc = \" Cast outward, and painted under the element as well as around it.\"] # [doc = \"\"] # [doc = \" A translucent or empty element shows it, which is what lets a glow\"] # [doc = \" reach into the body of the thing casting it instead of stopping at its\"] # [doc = \" perimeter.\"] # [default] Drop, # [doc = \" Cast outward and clipped to outside the element's own rounded shape,\"] # [doc = \" the way CSS clips an outer `box-shadow` to the border box.\"] # [doc = \"\"] # [doc = \" This is what a halo wants. A `Drop` halo reads as a ring only because\"] # [doc = \" the element it rings happens to be opaque; on a transparent element the\"] # [doc = \" same shadow floods the element instead. A `Ring` reads as a ring\"] # [doc = \" whatever it is drawn on.\"] Ring, # [doc = \" Cast inward, inside the element's bounds.\"] Inset, }", "cfg": [] }, { "id": "gpui::style::ShadowStyle::is_inset", "name": "is_inset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Whether the shadow is drawn inside the element.", "documentation": "Whether the shadow is drawn inside the element.", "signature": "pub fn is_inset (self) -> bool", "cfg": [], "target": "ShadowStyle" }, { "id": "gpui::style::ShadowStyle::is_ring", "name": "is_ring", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Whether the element's own shape is cut out of the shadow.", "documentation": "Whether the element's own shape is cut out of the shadow.", "signature": "pub fn is_ring (self) -> bool", "cfg": [], "target": "ShadowStyle" }, { "id": "gpui::style::StrikethroughStyle", "name": "StrikethroughStyle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The properties that can be applied to a strikethrough.", "documentation": "The properties that can be applied to a strikethrough.", "signature": "# [doc = \" The properties that can be applied to a strikethrough.\"] # [derive (Refineable, Copy, Clone, Default, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema,)] pub struct StrikethroughStyle { # [doc = \" The thickness of the strikethrough.\"] pub thickness : Pixels, # [doc = \" The color of the strikethrough.\"] pub color : Option, }", "cfg": [] }, { "id": "gpui::style::Style", "name": "Style", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The CSS styling that can be applied to an element via the `Styled` trait", "documentation": "The CSS styling that can be applied to an element via the `Styled` trait", "signature": "# [doc = \" The CSS styling that can be applied to an element via the `Styled` trait\"] # [derive (Clone, Refineable, Debug)] # [refineable (Debug, PartialEq, Serialize, Deserialize, JsonSchema)] pub struct Style { # [doc = \" What layout strategy should be used?\"] pub display : Display, # [doc = \" Should the element be painted on screen?\"] pub visibility : Visibility, # [doc = \" How children overflowing their container should affect layout\"] # [refineable] pub overflow : Point, # [doc = \" How much space (in points) should be reserved for the scrollbars of `Overflow::Scroll` and `Overflow::Auto` nodes.\"] pub scrollbar_width : AbsoluteLength, # [doc = \" Whether both x and y axis should be scrollable at the same time.\"] pub allow_concurrent_scroll : bool, # [doc = \" Whether scrolling should be restricted to the input gesture's axis.\"] # [doc = \"\"] # [doc = \" Pixel-based scroll gestures are locked to their initially dominant axis. The lock may be\"] # [doc = \" released when the gesture changes direction strongly. Touch phases delimit gestures when\"] # [doc = \" available, with a timeout fallback for platforms that only emit moved events.\"] # [doc = \"\"] # [doc = \" This also prevents input from being remapped to another axis. For example, horizontal input\"] # [doc = \" will not scroll a container that only has vertical overflow enabled. Mouse wheel platforms\"] # [doc = \" typically report ordinary wheel input on the Y axis and Shift-modified input on the X axis.\"] # [doc = \"\"] # [doc = \" ## Motivation\"] # [doc = \"\"] # [doc = \" On the web when scrolling with the mouse wheel, scrolling up and down will always scroll the Y axis, even when\"] # [doc = \" the mouse is over a horizontally-scrollable element.\"] # [doc = \"\"] # [doc = \" The only way to scroll horizontally is to hold down `Shift` while scrolling, which then changes the scroll axis\"] # [doc = \" to the X axis.\"] # [doc = \"\"] # [doc = \" Currently, GPUI operates differently from the web in that it will scroll an element in either the X or Y axis\"] # [doc = \" when scrolling with just the mouse wheel. This causes problems when scrolling in a vertical list that contains\"] # [doc = \" horizontally-scrollable elements, as when you get to the horizontally-scrollable elements the scroll will be\"] # [doc = \" hijacked.\"] # [doc = \"\"] # [doc = \" Ideally we would match the web's behavior and not have a need for this, but right now we're adding this opt-in\"] # [doc = \" style property to limit the potential blast radius.\"] pub restrict_scroll_to_axis : bool, # [doc = \" What should the `position` value of this struct use as a base offset?\"] pub position : Position, # [doc = \" How should the position of this element be tweaked relative to the layout defined?\"] # [refineable] pub inset : Edges, # [doc = \" Sets the initial size of the item\"] # [refineable] pub size : Size, # [doc = \" Controls the minimum size of the item\"] # [refineable] pub min_size : Size, # [doc = \" Controls the maximum size of the item\"] # [refineable] pub max_size : Size, # [doc = \" Sets the preferred aspect ratio for the item. The ratio is calculated as width divided by height.\"] pub aspect_ratio : Option, # [doc = \" How large should the margin be on each side?\"] # [refineable] pub margin : Edges, # [doc = \" How large should the padding be on each side?\"] # [refineable] pub padding : Edges, # [doc = \" How large should the border be on each side?\"] # [refineable] pub border_widths : Edges, # [doc = \" How this node's children aligned in the cross/block axis?\"] pub align_items : Option, # [doc = \" How this node should be aligned in the cross/block axis. Falls back to the parents [`AlignItems`] if not set\"] pub align_self : Option, # [doc = \" How should content contained within this item be aligned in the cross/block axis\"] pub align_content : Option, # [doc = \" How should contained within this item be aligned in the main/inline axis\"] pub justify_content : Option, # [doc = \" How large should the gaps between items in a flex container be?\"] # [refineable] pub gap : Size, # [doc = \" Which direction does the main axis flow in?\"] pub flex_direction : FlexDirection, # [doc = \" Should elements wrap, or stay in a single line?\"] pub flex_wrap : FlexWrap, # [doc = \" Sets the initial main axis size of the item\"] pub flex_basis : Length, # [doc = \" The relative rate at which this item grows when it is expanding to fill space, 0.0 is the default value, and this value must be positive.\"] pub flex_grow : f32, # [doc = \" The relative rate at which this item shrinks when it is contracting to fit into space, 1.0 is the default value, and this value must be positive.\"] pub flex_shrink : f32, # [doc = \" The fill color of this element\"] pub background : Option, # [doc = \" The border color of this element\"] pub border_color : Option, # [doc = \" The border style of this element\"] pub border_style : BorderStyle, # [doc = \" The radius of the corners of this element\"] # [refineable] pub corner_radii : Corners, # [doc = \" Box shadow of the element\"] pub box_shadow : Vec, # [doc = \" The text style of this element\"] # [refineable] pub text : TextStyleRefinement, # [doc = \" The mouse cursor style shown when the mouse pointer is over an element.\"] pub mouse_cursor : Option, # [doc = \" The opacity of this element\"] pub opacity : Option, # [doc = \" The grid columns of this element\"] # [doc = \" Roughly equivalent to the Tailwind `grid-cols-`\"] pub grid_cols : Option, # [doc = \" The row span of this element\"] # [doc = \" Equivalent to the Tailwind `grid-rows-`\"] pub grid_rows : Option, # [doc = \" The grid location of this element\"] pub grid_location : Option, # [doc = \" Whether to draw a red debugging outline around this element\"] # [cfg (debug_assertions)] pub debug : bool, # [doc = \" Whether to draw a red debugging outline around this element and all of its conforming children\"] # [cfg (debug_assertions)] pub debug_below : bool, }", "cfg": [] }, { "id": "gpui::style::Style::has_opaque_background", "name": "has_opaque_background", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Returns true if the style is visible and the background is opaque.", "documentation": "Returns true if the style is visible and the background is opaque.", "signature": "pub fn has_opaque_background (& self) -> bool", "cfg": [], "target": "Style" }, { "id": "gpui::style::Style::overflow_mask", "name": "overflow_mask", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Get the content mask for this element style, based on the given bounds. If the element does not hide its overflow, this will return `None`.", "documentation": "Get the content mask for this element style, based on the given bounds.\nIf the element does not hide its overflow, this will return `None`.", "signature": "pub fn overflow_mask (& self, bounds : Bounds, rem_size : Pixels,) -> Option>", "cfg": [], "target": "Style" }, { "id": "gpui::style::Style::paint", "name": "paint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Paints the background of an element styled with this style.", "documentation": "Paints the background of an element styled with this style.", "signature": "pub fn paint (& self, bounds : Bounds, window : & mut Window, cx : & mut App, continuation : impl FnOnce (& mut Window, & mut App),)", "cfg": [], "target": "Style" }, { "id": "gpui::style::Style::text_style", "name": "text_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Get the text style in this element style.", "documentation": "Get the text style in this element style.", "signature": "pub fn text_style (& self) -> Option<& TextStyleRefinement>", "cfg": [], "target": "Style" }, { "id": "gpui::style::StyleRefinement::grid_location_mut", "name": "grid_location_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The grid location of this element", "documentation": "The grid location of this element", "signature": "pub fn grid_location_mut (& mut self) -> & mut GridLocation", "cfg": [], "target": "StyleRefinement" }, { "id": "gpui::style::TextAlign", "name": "TextAlign", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "How to align text within the element", "documentation": "How to align text within the element", "signature": "# [doc = \" How to align text within the element\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)] pub enum TextAlign { # [doc = \" Align the text to the left of the element\"] # [default] Left, # [doc = \" Center the text within the element\"] Center, # [doc = \" Align the text to the right of the element\"] Right, }", "cfg": [] }, { "id": "gpui::style::TextOverflow", "name": "TextOverflow", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "How to truncate text that overflows the width of the element", "documentation": "How to truncate text that overflows the width of the element", "signature": "# [doc = \" How to truncate text that overflows the width of the element\"] # [derive (Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)] pub enum TextOverflow { # [doc = \" Truncate the text at the end when it doesn't fit, and represent this truncation by\"] # [doc = \" displaying the provided string (e.g., \\\"very long te…\\\").\"] Truncate (SharedString), # [doc = \" Truncate the text at the start when it doesn't fit, and represent this truncation by\"] # [doc = \" displaying the provided string at the beginning (e.g., \\\"…ong text here\\\").\"] # [doc = \" Typically more adequate for file paths where the end is more important than the beginning.\"] TruncateStart (SharedString), # [doc = \" Truncate the text in the middle when it doesn't fit, preserving both the start and end\"] # [doc = \" of the string (e.g., \\\"long fi…name.rs\\\"). Useful for filenames where both the prefix\"] # [doc = \" and the extension are important context.\"] TruncateMiddle (SharedString), }", "cfg": [] }, { "id": "gpui::style::TextStyle", "name": "TextStyle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The properties that can be used to style text in GPUI", "documentation": "The properties that can be used to style text in GPUI", "signature": "# [doc = \" The properties that can be used to style text in GPUI\"] # [derive (Refineable, Clone, Debug, PartialEq)] # [refineable (Debug, PartialEq, Serialize, Deserialize, JsonSchema)] pub struct TextStyle { # [doc = \" The color of the text\"] pub color : Hsla, # [doc = \" The font family to use\"] pub font_family : SharedString, # [doc = \" The font features to use\"] pub font_features : FontFeatures, # [doc = \" The fallback fonts to use\"] pub font_fallbacks : Option, # [doc = \" The font size to use, in pixels or rems.\"] pub font_size : AbsoluteLength, # [doc = \" The line height to use, in pixels or fractions\"] pub line_height : DefiniteLength, # [doc = \" The font weight, e.g. bold\"] pub font_weight : FontWeight, # [doc = \" The font style, e.g. italic\"] pub font_style : FontStyle, # [doc = \" The background color of the text\"] pub background_color : Option, # [doc = \" The underline style of the text\"] pub underline : Option, # [doc = \" The strikethrough style of the text\"] pub strikethrough : Option, # [doc = \" How to handle whitespace in the text\"] pub white_space : WhiteSpace, # [doc = \" The text should be truncated if it overflows the width of the element\"] pub text_overflow : Option, # [doc = \" How the text should be aligned within the element\"] pub text_align : TextAlign, # [doc = \" The number of lines to display before truncating the text\"] pub line_clamp : Option, }", "cfg": [] }, { "id": "gpui::style::TextStyle::font", "name": "font", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Get the font configured for this text style.", "documentation": "Get the font configured for this text style.", "signature": "pub fn font (& self) -> Font", "cfg": [], "target": "TextStyle" }, { "id": "gpui::style::TextStyle::highlight", "name": "highlight", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Create a new text style with the given highlighting applied.", "documentation": "Create a new text style with the given highlighting applied.", "signature": "pub fn highlight (mut self, style : impl Into) -> Self", "cfg": [], "target": "TextStyle" }, { "id": "gpui::style::TextStyle::line_height_in_pixels", "name": "line_height_in_pixels", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Returns the rounded line height in pixels.", "documentation": "Returns the rounded line height in pixels.", "signature": "pub fn line_height_in_pixels (& self, rem_size : Pixels) -> Pixels", "cfg": [], "target": "TextStyle" }, { "id": "gpui::style::TextStyle::to_run", "name": "to_run", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Convert this text style into a [`TextRun`], for the given length of the text.", "documentation": "Convert this text style into a [`TextRun`], for the given length of the text.", "signature": "pub fn to_run (& self, len : usize) -> TextRun", "cfg": [], "target": "TextStyle" }, { "id": "gpui::style::UnderlineStyle", "name": "UnderlineStyle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The properties that can be applied to an underline.", "documentation": "The properties that can be applied to an underline.", "signature": "# [doc = \" The properties that can be applied to an underline.\"] # [derive (Refineable, Copy, Clone, Default, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema,)] pub struct UnderlineStyle { # [doc = \" The thickness of the underline.\"] pub thickness : Pixels, # [doc = \" The color of the underline.\"] pub color : Option, # [doc = \" Whether the underline should be wavy, like in a spell checker.\"] pub wavy : bool, }", "cfg": [] }, { "id": "gpui::style::Visibility", "name": "Visibility", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "The value of the visibility property, similar to the CSS property `visibility`", "documentation": "The value of the visibility property, similar to the CSS property `visibility`", "signature": "# [doc = \" The value of the visibility property, similar to the CSS property `visibility`\"] # [derive (Default, Clone, Copy, Debug, Eq, PartialEq, Serialize, Deserialize, JsonSchema)] pub enum Visibility { # [doc = \" The element should be drawn as normal.\"] # [default] Visible, # [doc = \" The element should not be drawn, but should still take up space in the layout.\"] Hidden, }", "cfg": [] }, { "id": "gpui::style::WhiteSpace", "name": "WhiteSpace", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "How to handle whitespace in text", "documentation": "How to handle whitespace in text", "signature": "# [doc = \" How to handle whitespace in text\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, JsonSchema)] pub enum WhiteSpace { # [doc = \" Normal line wrapping when text overflows the width of the element\"] # [default] Normal, # [doc = \" No line wrapping, text will overflow the width of the element\"] Nowrap, }", "cfg": [] }, { "id": "gpui::style::combine_highlights", "name": "combine_highlights", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "style", "path": "gpui::style", "source": "crates/gpui/src/style.rs", "summary": "Combine and merge the highlights and ranges in the two iterators.", "documentation": "Combine and merge the highlights and ranges in the two iterators.", "signature": "pub fn combine_highlights (a : impl IntoIterator, HighlightStyle)>, b : impl IntoIterator, HighlightStyle)>,) -> impl Iterator, HighlightStyle)>", "cfg": [] }, { "id": "gpui::styled::Styled", "name": "Styled", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "styled", "path": "gpui::styled", "source": "crates/gpui/src/styled.rs", "summary": "A trait for elements that can be styled. Use this to opt-in to a utility CSS-like styling API.", "documentation": "A trait for elements that can be styled.\nUse this to opt-in to a utility CSS-like styling API.", "signature": "# [doc = \" A trait for elements that can be styled.\"] # [doc = \" Use this to opt-in to a utility CSS-like styling API.\"] # [cfg_attr (all (any (feature = \"inspector\", debug_assertions), not (rust_analyzer)), gpui_macros::derive_inspector_reflection)] pub trait Styled : Sized { # [doc = \" Returns a reference to the style memory of this element.\"] fn style (& mut self) -> & mut StyleRefinement; gpui_macros::style_helpers ! (); gpui_macros::visibility_style_methods ! (); gpui_macros::margin_style_methods ! (); gpui_macros::padding_style_methods ! (); gpui_macros::position_style_methods ! (); gpui_macros::overflow_style_methods ! (); gpui_macros::cursor_style_methods ! (); gpui_macros::border_style_methods ! (); gpui_macros::box_shadow_style_methods ! (); # [doc = \" Sets the display type of the element to `block`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/display)\"] fn block (mut self) -> Self { self . style () . display = Some (Display::Block); self } # [doc = \" Sets the display type of the element to `flex`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/display)\"] fn flex (mut self) -> Self { self . style () . display = Some (Display::Flex); self } # [doc = \" Sets the display type of the element to `grid`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/display)\"] fn grid (mut self) -> Self { self . style () . display = Some (Display::Grid); self } # [doc = \" Sets the display type of the element to `none`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/display)\"] fn hidden (mut self) -> Self { self . style () . display = Some (Display::None); self } # [doc = \" Set the space to be reserved for rendering the scrollbar.\"] # [doc = \"\"] # [doc = \" This will only affect the layout of the element when overflow for this element is set to\"] # [doc = \" `Overflow::Scroll`.\"] fn scrollbar_width (mut self, width : impl Into) -> Self { self . style () . scrollbar_width = Some (width . into ()); self } # [doc = \" Sets the whitespace of the element to `normal`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/whitespace#normal)\"] fn whitespace_normal (mut self) -> Self { self . text_style () . white_space = Some (WhiteSpace::Normal); self } # [doc = \" Sets the whitespace of the element to `nowrap`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/whitespace#nowrap)\"] fn whitespace_nowrap (mut self) -> Self { self . text_style () . white_space = Some (WhiteSpace::Nowrap); self } # [doc = \" Sets the truncate overflowing text with an ellipsis (…) at the end if needed.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-overflow#ellipsis)\"] fn text_ellipsis (mut self) -> Self { self . text_style () . text_overflow = Some (TextOverflow::Truncate (ELLIPSIS)); self } # [doc = \" Sets the truncate overflowing text with an ellipsis (…) at the start if needed.\"] # [doc = \" Typically more adequate for file paths where the end is more important than the beginning.\"] # [doc = \" Note: This doesn't exist in Tailwind CSS.\"] fn text_ellipsis_start (mut self) -> Self { self . text_style () . text_overflow = Some (TextOverflow::TruncateStart (ELLIPSIS)); self } # [doc = \" Sets the truncate overflowing text with an ellipsis (…) in the middle if needed.\"] # [doc = \" Preserves the beginning and end of the text. Useful for filenames.\"] # [doc = \" Note: This doesn't exist in Tailwind CSS.\"] fn text_ellipsis_middle (mut self) -> Self { self . text_style () . text_overflow = Some (TextOverflow::TruncateMiddle (ELLIPSIS)); self } # [doc = \" Sets the text overflow behavior of the element.\"] fn text_overflow (mut self, overflow : TextOverflow) -> Self { self . text_style () . text_overflow = Some (overflow); self } # [doc = \" Set the text alignment of the element.\"] fn text_align (mut self, align : TextAlign) -> Self { self . text_style () . text_align = Some (align); self } # [doc = \" Sets the text alignment to left\"] fn text_left (mut self) -> Self { self . text_align (TextAlign::Left) } # [doc = \" Sets the text alignment to center\"] fn text_center (mut self) -> Self { self . text_align (TextAlign::Center) } # [doc = \" Sets the text alignment to right\"] fn text_right (mut self) -> Self { self . text_align (TextAlign::Right) } # [doc = \" Sets the truncate to prevent text from wrapping and truncate overflowing text with an ellipsis (…) if needed.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-overflow#truncate)\"] fn truncate (mut self) -> Self { self . overflow_hidden () . whitespace_nowrap () . text_ellipsis () } # [doc = \" Sets number of lines to show before truncating the text.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/line-clamp)\"] fn line_clamp (mut self, lines : usize) -> Self { let mut text_style = self . text_style (); text_style . line_clamp = Some (lines); self . overflow_hidden () } # [doc = \" Sets the flex direction of the element to `column`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-direction#column)\"] fn flex_col (mut self) -> Self { self . style () . flex_direction = Some (FlexDirection::Column); self } # [doc = \" Sets the flex direction of the element to `column-reverse`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-direction#column-reverse)\"] fn flex_col_reverse (mut self) -> Self { self . style () . flex_direction = Some (FlexDirection::ColumnReverse); self } # [doc = \" Sets the flex direction of the element to `row`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-direction#row)\"] fn flex_row (mut self) -> Self { self . style () . flex_direction = Some (FlexDirection::Row); self } # [doc = \" Sets the flex direction of the element to `row-reverse`.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-direction#row-reverse)\"] fn flex_row_reverse (mut self) -> Self { self . style () . flex_direction = Some (FlexDirection::RowReverse); self } # [doc = \" Sets the element to allow a flex item to grow and shrink as needed, ignoring its initial size.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex#flex-1)\"] fn flex_1 (mut self) -> Self { self . style () . flex_grow = Some (1.); self . style () . flex_shrink = Some (1.); self . style () . flex_basis = Some (relative (0.) . into ()); self } # [doc = \" Sets the element to allow a flex item to grow and shrink, taking into account its initial size.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex#auto)\"] fn flex_auto (mut self) -> Self { self . style () . flex_grow = Some (1.); self . style () . flex_shrink = Some (1.); self . style () . flex_basis = Some (Length::Auto); self } # [doc = \" Sets the element to allow a flex item to shrink but not grow, taking into account its initial size.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex#initial)\"] fn flex_initial (mut self) -> Self { self . style () . flex_grow = Some (0.); self . style () . flex_shrink = Some (1.); self . style () . flex_basis = Some (Length::Auto); self } # [doc = \" Sets the element to prevent a flex item from growing or shrinking.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex#none)\"] fn flex_none (mut self) -> Self { self . style () . flex_grow = Some (0.); self . style () . flex_shrink = Some (0.); self . style () . flex_basis = Some (Length::Auto); self } # [doc = \" Sets the initial size of flex items for this element.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-basis)\"] fn flex_basis (mut self, basis : impl Into) -> Self { self . style () . flex_basis = Some (basis . into ()); self } # [doc = \" Sets the flex item's grow factor.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-grow)\"] fn flex_grow (mut self, grow : f32) -> Self { self . style () . flex_grow = Some (grow); self } # [doc = \" Disables flex item growth (flex-grow: 0).\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-grow#dont-grow)\"] fn flex_grow_0 (mut self) -> Self { self . style () . flex_grow = Some (0.); self } # [doc = \" Enables flex item growth (flex-grow: 1).\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-grow#grow-1)\"] fn flex_grow_1 (mut self) -> Self { self . style () . flex_grow = Some (1.); self } # [doc = \" Sets the flex item's shrink factor.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-shrink)\"] fn flex_shrink (mut self, shrink : f32) -> Self { self . style () . flex_shrink = Some (shrink); self } # [doc = \" Disables flex item shrinking (flex-shrink: 0).\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-shrink#dont-shrink)\"] fn flex_shrink_0 (mut self) -> Self { self . style () . flex_shrink = Some (0.); self } # [doc = \" Enables flex item shrinking (flex-shrink: 1).\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-shrink#shrink-1)\"] fn flex_shrink_1 (mut self) -> Self { self . style () . flex_shrink = Some (1.); self } # [doc = \" Sets the element to allow flex items to wrap.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-wrap#wrap-normally)\"] fn flex_wrap (mut self) -> Self { self . style () . flex_wrap = Some (FlexWrap::Wrap); self } # [doc = \" Sets the element wrap flex items in the reverse direction.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-wrap#wrap-reversed)\"] fn flex_wrap_reverse (mut self) -> Self { self . style () . flex_wrap = Some (FlexWrap::WrapReverse); self } # [doc = \" Sets the element to prevent flex items from wrapping, causing inflexible items to overflow the container if necessary.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/flex-wrap#dont-wrap)\"] fn flex_nowrap (mut self) -> Self { self . style () . flex_wrap = Some (FlexWrap::NoWrap); self } # [doc = \" Sets the element to align flex items to the start of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-items#start)\"] fn items_start (mut self) -> Self { self . style () . align_items = Some (AlignItems::FlexStart); self } # [doc = \" Sets the element to align flex items to the end of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-items#end)\"] fn items_end (mut self) -> Self { self . style () . align_items = Some (AlignItems::FlexEnd); self } # [doc = \" Sets the element to align flex items along the center of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-items#center)\"] fn items_center (mut self) -> Self { self . style () . align_items = Some (AlignItems::Center); self } # [doc = \" Sets the element to align flex items along the baseline of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-items#baseline)\"] fn items_baseline (mut self) -> Self { self . style () . align_items = Some (AlignItems::Baseline); self } # [doc = \" Sets the element to stretch flex items to fill the available space along the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-items#stretch)\"] fn items_stretch (mut self) -> Self { self . style () . align_items = Some (AlignItems::Stretch); self } # [doc = \" Sets how this specific element is aligned along the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#start)\"] fn self_start (mut self) -> Self { self . style () . align_self = Some (AlignSelf::Start); self } # [doc = \" Sets this element to align against the end of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#end)\"] fn self_end (mut self) -> Self { self . style () . align_self = Some (AlignSelf::End); self } # [doc = \" Sets this element to align against the start of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#start)\"] fn self_flex_start (mut self) -> Self { self . style () . align_self = Some (AlignSelf::FlexStart); self } # [doc = \" Sets this element to align against the end of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#end)\"] fn self_flex_end (mut self) -> Self { self . style () . align_self = Some (AlignSelf::FlexEnd); self } # [doc = \" Sets this element to align along the center of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#center)\"] fn self_center (mut self) -> Self { self . style () . align_self = Some (AlignSelf::Center); self } # [doc = \" Sets this element to align along the baseline of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#baseline)\"] fn self_baseline (mut self) -> Self { self . style () . align_self = Some (AlignSelf::Baseline); self } # [doc = \" Sets this element to stretch to fill the available space along the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-self#stretch)\"] fn self_stretch (mut self) -> Self { self . style () . align_self = Some (AlignSelf::Stretch); self } # [doc = \" Sets the element to justify flex items against the start of the container's main axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/justify-content#start)\"] fn justify_start (mut self) -> Self { self . style () . justify_content = Some (JustifyContent::Start); self } # [doc = \" Sets the element to justify flex items against the end of the container's main axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/justify-content#end)\"] fn justify_end (mut self) -> Self { self . style () . justify_content = Some (JustifyContent::End); self } # [doc = \" Sets the element to justify flex items along the center of the container's main axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/justify-content#center)\"] fn justify_center (mut self) -> Self { self . style () . justify_content = Some (JustifyContent::Center); self } # [doc = \" Sets the element to justify flex items along the container's main axis\"] # [doc = \" such that there is an equal amount of space between each item.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/justify-content#space-between)\"] fn justify_between (mut self) -> Self { self . style () . justify_content = Some (JustifyContent::SpaceBetween); self } # [doc = \" Sets the element to justify items along the container's main axis such\"] # [doc = \" that there is an equal amount of space on each side of each item.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/justify-content#space-around)\"] fn justify_around (mut self) -> Self { self . style () . justify_content = Some (JustifyContent::SpaceAround); self } # [doc = \" Sets the element to justify items along the container's main axis such\"] # [doc = \" that there is an equal amount of space around each item, but also\"] # [doc = \" accounting for the doubling of space you would normally see between\"] # [doc = \" each item when using justify-around.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/justify-content#space-evenly)\"] fn justify_evenly (mut self) -> Self { self . style () . justify_content = Some (JustifyContent::SpaceEvenly); self } # [doc = \" Sets the element to pack content items in their default position as if no align-content value was set.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#normal)\"] fn content_normal (mut self) -> Self { self . style () . align_content = None; self } # [doc = \" Sets the element to pack content items in the center of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#center)\"] fn content_center (mut self) -> Self { self . style () . align_content = Some (AlignContent::Center); self } # [doc = \" Sets the element to pack content items against the start of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#start)\"] fn content_start (mut self) -> Self { self . style () . align_content = Some (AlignContent::FlexStart); self } # [doc = \" Sets the element to pack content items against the end of the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#end)\"] fn content_end (mut self) -> Self { self . style () . align_content = Some (AlignContent::FlexEnd); self } # [doc = \" Sets the element to pack content items along the container's cross axis\"] # [doc = \" such that there is an equal amount of space between each item.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#space-between)\"] fn content_between (mut self) -> Self { self . style () . align_content = Some (AlignContent::SpaceBetween); self } # [doc = \" Sets the element to pack content items along the container's cross axis\"] # [doc = \" such that there is an equal amount of space on each side of each item.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#space-around)\"] fn content_around (mut self) -> Self { self . style () . align_content = Some (AlignContent::SpaceAround); self } # [doc = \" Sets the element to pack content items along the container's cross axis\"] # [doc = \" such that there is an equal amount of space between each item.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#space-evenly)\"] fn content_evenly (mut self) -> Self { self . style () . align_content = Some (AlignContent::SpaceEvenly); self } # [doc = \" Sets the element to allow content items to fill the available space along the container's cross axis.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/align-content#stretch)\"] fn content_stretch (mut self) -> Self { self . style () . align_content = Some (AlignContent::Stretch); self } # [doc = \" Sets the aspect ratio of the element.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/aspect-ratio)\"] fn aspect_ratio (mut self, ratio : f32) -> Self { self . style () . aspect_ratio = Some (ratio); self } # [doc = \" Sets the aspect ratio of the element to 1/1 – equal width and height.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/aspect-ratio)\"] fn aspect_square (mut self) -> Self { self . style () . aspect_ratio = Some (1.0); self } # [doc = \" Sets the background color of the element.\"] fn bg (mut self, fill : F) -> Self where F : Into, Self : Sized, { self . style () . background = Some (fill . into ()); self } # [doc = \" Sets the border style of the element.\"] fn border_dashed (mut self) -> Self { self . style () . border_style = Some (BorderStyle::Dashed); self } # [doc = \" Returns a mutable reference to the text style that has been configured on this element.\"] fn text_style (& mut self) -> & mut TextStyleRefinement { let style : & mut StyleRefinement = self . style (); & mut style . text } # [doc = \" Sets the text color of this element.\"] # [doc = \"\"] # [doc = \" This value cascades to its child elements.\"] fn text_color (mut self, color : impl Into) -> Self { self . text_style () . color = Some (color . into ()); self } # [doc = \" Sets the font weight of this element\"] # [doc = \"\"] # [doc = \" This value cascades to its child elements.\"] fn font_weight (mut self, weight : FontWeight) -> Self { self . text_style () . font_weight = Some (weight); self } # [doc = \" Sets the background color of this element.\"] # [doc = \"\"] # [doc = \" This value cascades to its child elements.\"] fn text_bg (mut self, bg : impl Into) -> Self { self . text_style () . background_color = Some (bg . into ()); self } # [doc = \" Sets the text size of this element.\"] # [doc = \"\"] # [doc = \" This value cascades to its child elements.\"] fn text_size (mut self, size : impl Into) -> Self { self . text_style () . font_size = Some (size . into ()); self } # [doc = \" Sets the text size to 'extra small'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_xs (mut self) -> Self { self . text_style () . font_size = Some (rems (0.75) . into ()); self } # [doc = \" Sets the text size to 'small'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_sm (mut self) -> Self { self . text_style () . font_size = Some (rems (0.875) . into ()); self } # [doc = \" Sets the text size to 'base'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_base (mut self) -> Self { self . text_style () . font_size = Some (rems (1.0) . into ()); self } # [doc = \" Sets the text size to 'large'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_lg (mut self) -> Self { self . text_style () . font_size = Some (rems (1.125) . into ()); self } # [doc = \" Sets the text size to 'extra large'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_xl (mut self) -> Self { self . text_style () . font_size = Some (rems (1.25) . into ()); self } # [doc = \" Sets the text size to 'extra extra large'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_2xl (mut self) -> Self { self . text_style () . font_size = Some (rems (1.5) . into ()); self } # [doc = \" Sets the text size to 'extra extra extra large'.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-size#setting-the-font-size)\"] fn text_3xl (mut self) -> Self { self . text_style () . font_size = Some (rems (1.875) . into ()); self } # [doc = \" Sets the font style of the element to italic.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-style#italicizing-text)\"] fn italic (mut self) -> Self { self . text_style () . font_style = Some (FontStyle::Italic); self } # [doc = \" Sets the font style of the element to normal (not italic).\"] # [doc = \" [Docs](https://tailwindcss.com/docs/font-style#displaying-text-normally)\"] fn not_italic (mut self) -> Self { self . text_style () . font_style = Some (FontStyle::Normal); self } # [doc = \" Sets the text decoration to underline.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-line#underling-text)\"] fn underline (mut self) -> Self { let style = self . text_style (); style . underline = Some (UnderlineStyle { thickness : px (1.), .. Default::default () }); self } # [doc = \" Sets the decoration of the text to have a line through it.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-line#adding-a-line-through-text)\"] fn line_through (mut self) -> Self { let style = self . text_style (); style . strikethrough = Some (StrikethroughStyle { thickness : px (1.), .. Default::default () }); self } # [doc = \" Removes the text decoration on this element.\"] # [doc = \"\"] # [doc = \" This value cascades to its child elements.\"] fn text_decoration_none (mut self) -> Self { self . text_style () . underline = None; self } # [doc = \" Sets the color for the underline on this element\"] fn text_decoration_color (mut self, color : impl Into) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . color = Some (color . into ()); self } # [doc = \" Sets the text decoration style to a solid line.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-style)\"] fn text_decoration_solid (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . wavy = false; self } # [doc = \" Sets the text decoration style to a wavy line.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-style)\"] fn text_decoration_wavy (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . wavy = true; self } # [doc = \" Sets the text decoration to be 0px thick.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-thickness)\"] fn text_decoration_0 (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . thickness = px (0.); self } # [doc = \" Sets the text decoration to be 1px thick.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-thickness)\"] fn text_decoration_1 (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . thickness = px (1.); self } # [doc = \" Sets the text decoration to be 2px thick.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-thickness)\"] fn text_decoration_2 (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . thickness = px (2.); self } # [doc = \" Sets the text decoration to be 4px thick.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-thickness)\"] fn text_decoration_4 (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . thickness = px (4.); self } # [doc = \" Sets the text decoration to be 8px thick.\"] # [doc = \" [Docs](https://tailwindcss.com/docs/text-decoration-thickness)\"] fn text_decoration_8 (mut self) -> Self { let style = self . text_style (); let underline = style . underline . get_or_insert_with (Default::default); underline . thickness = px (8.); self } # [doc = \" Sets the font family of this element and its children.\"] fn font_family (mut self, family_name : impl Into) -> Self { self . text_style () . font_family = Some (family_name . into ()); self } # [doc = \" Sets the font features of this element and its children.\"] fn font_features (mut self, features : FontFeatures) -> Self { self . text_style () . font_features = Some (features); self } # [doc = \" Sets the ordered fallback font families of this element and its children.\"] fn font_fallbacks (mut self, fallbacks : FontFallbacks) -> Self { self . text_style () . font_fallbacks = Some (fallbacks); self } # [doc = \" Sets the font of this element and its children.\"] fn font (mut self, font : Font) -> Self { let Font { family, features, fallbacks, weight, style, } = font; let text_style = self . text_style (); text_style . font_family = Some (family); text_style . font_features = Some (features); text_style . font_weight = Some (weight); text_style . font_style = Some (style); text_style . font_fallbacks = fallbacks; self } # [doc = \" Sets the line height of this element and its children.\"] fn line_height (mut self, line_height : impl Into) -> Self { self . text_style () . line_height = Some (line_height . into ()); self } # [doc = \" Sets the opacity of this element and its children.\"] fn opacity (mut self, opacity : f32) -> Self { self . style () . opacity = Some (opacity); self } # [doc = \" Sets the grid columns of this element.\"] fn grid_cols (mut self, cols : u16) -> Self { self . style () . grid_cols = Some (GridTemplate { repeat : cols, min_size : GridTemplateMinSize::Zero, }); self } # [doc = \" Sets the grid columns with min-content minimum sizing.\"] # [doc = \" Unlike grid_cols, it won't shrink to width 0 in AvailableSpace::MinContent constraints.\"] fn grid_cols_min_content (mut self, cols : u16) -> Self { self . style () . grid_cols = Some (GridTemplate { repeat : cols, min_size : GridTemplateMinSize::MinContent, }); self } # [doc = \" Sets the grid columns with max-content maximum sizing for content-based column widths.\"] fn grid_cols_max_content (mut self, cols : u16) -> Self { self . style () . grid_cols = Some (GridTemplate { repeat : cols, min_size : GridTemplateMinSize::MaxContent, }); self } # [doc = \" Sets the grid rows of this element.\"] fn grid_rows (mut self, rows : u16) -> Self { self . style () . grid_rows = Some (GridTemplate { repeat : rows, min_size : GridTemplateMinSize::Zero, }); self } # [doc = \" Sets the grid rows with min-content minimum sizing.\"] # [doc = \" Unlike grid_rows, it won't shrink to height 0 in AvailableSpace::MinContent constraints.\"] fn grid_rows_min_content (mut self, rows : u16) -> Self { self . style () . grid_rows = Some (GridTemplate { repeat : rows, min_size : GridTemplateMinSize::MinContent, }); self } # [doc = \" Sets the grid rows with max-content maximum sizing for content-based row heights.\"] fn grid_rows_max_content (mut self, rows : u16) -> Self { self . style () . grid_rows = Some (GridTemplate { repeat : rows, min_size : GridTemplateMinSize::MaxContent, }); self } # [doc = \" Sets the column start of this element.\"] fn col_start (mut self, start : i16) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . column . start = GridPlacement::Line (start); self } # [doc = \" Sets the column start of this element to auto.\"] fn col_start_auto (mut self) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . column . start = GridPlacement::Auto; self } # [doc = \" Sets the column end of this element.\"] fn col_end (mut self, end : i16) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . column . end = GridPlacement::Line (end); self } # [doc = \" Sets the column end of this element to auto.\"] fn col_end_auto (mut self) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . column . end = GridPlacement::Auto; self } # [doc = \" Sets the column span of this element.\"] fn col_span (mut self, span : u16) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . column = GridPlacement::Span (span) .. GridPlacement::Span (span); self } # [doc = \" Sets the row span of this element.\"] fn col_span_full (mut self) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . column = GridPlacement::Line (1) .. GridPlacement::Line (- 1); self } # [doc = \" Sets the row start of this element.\"] fn row_start (mut self, start : i16) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . row . start = GridPlacement::Line (start); self } # [doc = \" Sets the row start of this element to \\\"auto\\\"\"] fn row_start_auto (mut self) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . row . start = GridPlacement::Auto; self } # [doc = \" Sets the row end of this element.\"] fn row_end (mut self, end : i16) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . row . end = GridPlacement::Line (end); self } # [doc = \" Sets the row end of this element to \\\"auto\\\"\"] fn row_end_auto (mut self) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . row . end = GridPlacement::Auto; self } # [doc = \" Sets the row span of this element.\"] fn row_span (mut self, span : u16) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . row = GridPlacement::Span (span) .. GridPlacement::Span (span); self } # [doc = \" Sets the row span of this element.\"] fn row_span_full (mut self) -> Self { let grid_location = self . style () . grid_location_mut (); grid_location . row = GridPlacement::Line (1) .. GridPlacement::Line (- 1); self } # [doc = \" Draws a debug border around this element.\"] # [cfg (debug_assertions)] fn debug (mut self) -> Self { self . style () . debug = Some (true); self } # [doc = \" Draws a debug border on all conforming elements below this element.\"] # [cfg (debug_assertions)] fn debug_below (mut self) -> Self { self . style () . debug_below = Some (true); self } }", "cfg": [] }, { "id": "gpui::styled::reexport-1", "name": "gpui_macros :: { border_style_methods , box_shadow_style_methods , cursor_style_methods , margin_style_methods , overflow_style_methods , padding_style_methods , position_style_methods , visibility_style_methods , }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "styled", "path": "gpui::styled", "source": "crates/gpui/src/styled.rs", "summary": "", "documentation": "", "signature": "pub use gpui_macros::{ border_style_methods, box_shadow_style_methods, cursor_style_methods, margin_style_methods, overflow_style_methods, padding_style_methods, position_style_methods, visibility_style_methods, };", "cfg": [] }, { "id": "gpui::subscription::SubscriberSet::insert", "name": "insert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "Inserts a new [`Subscription`] for the given `emitter_key`. By default, subscriptions are inert, meaning that they won't be listed when calling `[SubscriberSet::remove]` or `[SubscriberSet::retain]`. This method returns a tuple of a [`Subscription`] and an `impl FnOnce`, and you can use the latter to activate the [`Subscription`].", "documentation": "Inserts a new [`Subscription`] for the given `emitter_key`. By default, subscriptions\nare inert, meaning that they won't be listed when calling `[SubscriberSet::remove]` or `[SubscriberSet::retain]`.\nThis method returns a tuple of a [`Subscription`] and an `impl FnOnce`, and you can use the latter\nto activate the [`Subscription`].", "signature": "pub fn insert (& self, emitter_key : EmitterKey, callback : Callback,) -> (Subscription, impl FnOnce () + use)", "cfg": [], "target": "SubscriberSet" }, { "id": "gpui::subscription::SubscriberSet::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "SubscriberSet" }, { "id": "gpui::subscription::SubscriberSet::remove", "name": "remove", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "", "documentation": "", "signature": "pub fn remove (& self, emitter : & EmitterKey,) -> impl IntoIterator + use", "cfg": [], "target": "SubscriberSet" }, { "id": "gpui::subscription::SubscriberSet::retain", "name": "retain", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "Call the given callback for each subscriber to the given emitter. If the callback returns false, the subscriber is removed.", "documentation": "Call the given callback for each subscriber to the given emitter.\nIf the callback returns false, the subscriber is removed.", "signature": "pub fn retain (& self, emitter : & EmitterKey, mut f : F) where F : FnMut (& mut Callback) -> bool,", "cfg": [], "target": "SubscriberSet" }, { "id": "gpui::subscription::Subscription", "name": "Subscription", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "A handle to a subscription created by GPUI. When dropped, the subscription is cancelled and the callback will no longer be invoked.", "documentation": "A handle to a subscription created by GPUI. When dropped, the subscription\nis cancelled and the callback will no longer be invoked.", "signature": "# [doc = \" A handle to a subscription created by GPUI. When dropped, the subscription\"] # [doc = \" is cancelled and the callback will no longer be invoked.\"] # [must_use] pub struct Subscription { unsubscribe : Option>, }", "cfg": [] }, { "id": "gpui::subscription::Subscription::detach", "name": "detach", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "Detaches the subscription from this handle. The callback will continue to be invoked until the entities it has been subscribed to are dropped", "documentation": "Detaches the subscription from this handle. The callback will\ncontinue to be invoked until the entities it has been\nsubscribed to are dropped", "signature": "pub fn detach (mut self)", "cfg": [], "target": "Subscription" }, { "id": "gpui::subscription::Subscription::join", "name": "join", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "Joins two subscriptions into a single subscription. Detach will detach both interior subscriptions.", "documentation": "Joins two subscriptions into a single subscription. Detach will\ndetach both interior subscriptions.", "signature": "pub fn join (mut subscription_a : Self, mut subscription_b : Self) -> Self", "cfg": [], "target": "Subscription" }, { "id": "gpui::subscription::Subscription::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subscription", "path": "gpui::subscription", "source": "crates/gpui/src/subscription.rs", "summary": "Creates a new subscription with a callback that gets invoked when this subscription is dropped.", "documentation": "Creates a new subscription with a callback that gets invoked when\nthis subscription is dropped.", "signature": "pub fn new (unsubscribe : impl 'static + FnOnce ()) -> Self", "cfg": [], "target": "Subscription" }, { "id": "gpui::subtree_clip::ClipChain", "name": "ClipChain", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Value-typed inherited clips. Cloning is cheap and equality compares geometry, not allocation or scene-local indices, so this can be retained across frames.", "documentation": "Value-typed inherited clips. Cloning is cheap and equality compares geometry,\nnot allocation or scene-local indices, so this can be retained across frames.\n\nFlat storage also makes traversal and destruction independent of nesting\ndepth; neither operation consumes a recursive call stack.", "signature": "# [doc = \" Value-typed inherited clips. Cloning is cheap and equality compares geometry,\"] # [doc = \" not allocation or scene-local indices, so this can be retained across frames.\"] # [doc = \"\"] # [doc = \" Flat storage also makes traversal and destruction independent of nesting\"] # [doc = \" depth; neither operation consumes a recursive call stack.\"] # [derive (Clone, Debug, Default, PartialEq, Eq)] pub struct ClipChain (Arc>);", "cfg": [] }, { "id": "gpui::subtree_clip::ClipChain::accessible_bounds", "name": "accessible_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Conservative rectangular bounds for accessibility APIs such as AccessKit that cannot represent curved regions. Corner pixels may belong to this rectangle while being rejected by visual clipping and pointer hit tests. This is not an approximation used for pointer input or fragment coverage.", "documentation": "Conservative rectangular bounds for accessibility APIs such as AccessKit\nthat cannot represent curved regions. Corner pixels may belong to this\nrectangle while being rejected by visual clipping and pointer hit tests.\nThis is not an approximation used for pointer input or fragment coverage.", "signature": "pub fn accessible_bounds (& self, bounds : Bounds) -> Bounds", "cfg": [], "target": "ClipChain" }, { "id": "gpui::subtree_clip::ClipChain::clips", "name": "clips", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Ordered outermost to innermost.", "documentation": "Ordered outermost to innermost.", "signature": "pub fn clips (& self) -> & [RoundedClip]", "cfg": [], "target": "ClipChain" }, { "id": "gpui::subtree_clip::ClipChain::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "True only if every ancestor admits this point. No depth limit applies.", "documentation": "True only if every ancestor admits this point. No depth limit applies.", "signature": "pub fn contains (& self, position : Point) -> bool", "cfg": [], "target": "ClipChain" }, { "id": "gpui::subtree_clip::ClipChain::pop", "name": "pop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Removes the innermost clip, returning it if present.", "documentation": "Removes the innermost clip, returning it if present.", "signature": "pub fn pop (& mut self) -> Option", "cfg": [], "target": "ClipChain" }, { "id": "gpui::subtree_clip::ClipChain::push", "name": "push", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Adds a clip to this value without changing clones retained elsewhere.", "documentation": "Adds a clip to this value without changing clones retained elsewhere.", "signature": "pub fn push (& mut self, clip : RoundedClip)", "cfg": [], "target": "ClipChain" }, { "id": "gpui::subtree_clip::ClipId", "name": "ClipId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Scene-local linked clip index. Zero means no clip; nodes are one-based.", "documentation": "Scene-local linked clip index. Zero means no clip; nodes are one-based.", "signature": "# [doc = \" Scene-local linked clip index. Zero means no clip; nodes are one-based.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq, Hash)] # [repr (C)] pub struct ClipId { index : u32, padding : u32, }", "cfg": [] }, { "id": "gpui::subtree_clip::ClipId::as_u32", "name": "as_u32", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Integer used in GPU records. Nonzero indices are meaningful only in the scene that issued them.", "documentation": "Integer used in GPU records. Nonzero indices are meaningful only in the\nscene that issued them.", "signature": "pub fn as_u32 (self) -> u32", "cfg": [], "target": "ClipId" }, { "id": "gpui::subtree_clip::ClipNode", "name": "ClipNode", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "GPU-facing rounded clip record (ten 32-bit words, with no implicit padding). Parent is always zero or less than this node's one-based index. Renderers can walk until zero without a depth cap or cycle detection.", "documentation": "GPU-facing rounded clip record (ten 32-bit words, with no implicit padding).\nParent is always zero or less than this node's one-based index. Renderers can\nwalk until zero without a depth cap or cycle detection.", "signature": "# [doc = \" GPU-facing rounded clip record (ten 32-bit words, with no implicit padding).\"] # [doc = \" Parent is always zero or less than this node's one-based index. Renderers can\"] # [doc = \" walk until zero without a depth cap or cycle detection.\"] # [derive (Clone, Copy, Debug, PartialEq)] # [repr (C)] pub struct ClipNode { # [doc = \" Device-space bounds; never a replacement for a primitive's content mask.\"] pub bounds : Bounds, # [doc = \" Fitted device-space corner radii.\"] pub corner_radii : Corners, # [doc = \" Parent's one-based index, or zero.\"] pub parent : ClipId, }", "cfg": [] }, { "id": "gpui::subtree_clip::ClipNodes", "name": "ClipNodes", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Scene-owned clip storage. Only validated append operations can create nodes, ensuring that GPU traversal always terminates.", "documentation": "Scene-owned clip storage. Only validated append operations can create nodes,\nensuring that GPU traversal always terminates.", "signature": "# [doc = \" Scene-owned clip storage. Only validated append operations can create nodes,\"] # [doc = \" ensuring that GPU traversal always terminates.\"] # [derive (Default)] pub struct ClipNodes (Vec);", "cfg": [] }, { "id": "gpui::subtree_clip::ClipNodes::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Clears frame-local indices along with the owning scene.", "documentation": "Clears frame-local indices along with the owning scene.", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "ClipNodes" }, { "id": "gpui::subtree_clip::ClipNodes::insert", "name": "insert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Encodes a CPU chain in device coordinates, returning its innermost node. Fails clearly on invalid scale or exhausting the 32-bit index space.", "documentation": "Encodes a CPU chain in device coordinates, returning its innermost node.\nFails clearly on invalid scale or exhausting the 32-bit index space.", "signature": "pub fn insert (& mut self, chain : & ClipChain, scale : f32) -> ClipId", "cfg": [], "target": "ClipNodes" }, { "id": "gpui::subtree_clip::ClipNodes::nodes", "name": "nodes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "GPU upload records, in parent-first order.", "documentation": "GPU upload records, in parent-first order.", "signature": "pub fn nodes (& self) -> & [ClipNode]", "cfg": [], "target": "ClipNodes" }, { "id": "gpui::subtree_clip::ClipNodes::replay", "name": "replay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Copies one old chain parent-first into this scene. It never treats an old index as a new index, even when destination nodes already occupy that slot. Callers replaying many primitives should memoize the returned old/new pair.", "documentation": "Copies one old chain parent-first into this scene. It never treats an old\nindex as a new index, even when destination nodes already occupy that slot.\nCallers replaying many primitives should memoize the returned old/new pair.", "signature": "pub fn replay (& mut self, old : ClipId, source : & Self) -> ClipId", "cfg": [], "target": "ClipNodes" }, { "id": "gpui::subtree_clip::RoundedClip", "name": "RoundedClip", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "A rounded rectangle in window coordinates.", "documentation": "A rounded rectangle in window coordinates.\n\nRadii are fitted exactly as for framework quads: each radius is nonnegative\nand at most half the shortest side. This makes quadrant selection in the\nrounded rectangle distance function unambiguous.", "signature": "# [doc = \" A rounded rectangle in window coordinates.\"] # [doc = \"\"] # [doc = \" Radii are fitted exactly as for framework quads: each radius is nonnegative\"] # [doc = \" and at most half the shortest side. This makes quadrant selection in the\"] # [doc = \" rounded rectangle distance function unambiguous.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub struct RoundedClip { bounds : Bounds, corner_radii : Corners, }", "cfg": [] }, { "id": "gpui::subtree_clip::RoundedClip::bounds", "name": "bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "The rectangle enclosing the rounded clip.", "documentation": "The rectangle enclosing the rounded clip.", "signature": "pub fn bounds (& self) -> Bounds", "cfg": [], "target": "RoundedClip" }, { "id": "gpui::subtree_clip::RoundedClip::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Tests the same rounded rectangle distance used by renderer shaders.", "documentation": "Tests the same rounded rectangle distance used by renderer shaders.", "signature": "pub fn contains (& self, position : Point) -> bool", "cfg": [], "target": "RoundedClip" }, { "id": "gpui::subtree_clip::RoundedClip::corner_radii", "name": "corner_radii", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Fitted corner radii in top-left, top-right, bottom-right, bottom-left order.", "documentation": "Fitted corner radii in top-left, top-right, bottom-right, bottom-left order.", "signature": "pub fn corner_radii (& self) -> Corners", "cfg": [], "target": "RoundedClip" }, { "id": "gpui::subtree_clip::RoundedClip::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "subtree_clip", "path": "gpui::subtree_clip", "source": "crates/gpui/src/subtree_clip.rs", "summary": "Constructs finite geometry. Empty bounds represent an empty clip.", "documentation": "Constructs finite geometry. Empty bounds represent an empty clip.\n\nPanics for nonfinite coordinates or radii rather than admitting an\nundefined CPU/GPU disagreement.", "signature": "pub fn new (bounds : Bounds, corner_radii : Corners) -> Self", "cfg": [], "target": "RoundedClip" }, { "id": "gpui::svg_renderer::RenderSvgParams", "name": "RenderSvgParams", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "svg_renderer", "path": "gpui::svg_renderer", "source": "crates/gpui/src/svg_renderer.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, PartialEq, Hash, Eq)] # [expect (missing_docs)] pub struct RenderSvgParams { pub path : SharedString, pub size : Size, }", "cfg": [] }, { "id": "gpui::svg_renderer::SMOOTH_SVG_SCALE_FACTOR", "name": "SMOOTH_SVG_SCALE_FACTOR", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "svg_renderer", "path": "gpui::svg_renderer", "source": "crates/gpui/src/svg_renderer.rs", "summary": "When rendering SVGs, we render them at twice the size to get a higher-quality result.", "documentation": "When rendering SVGs, we render them at twice the size to get a higher-quality result.", "signature": "pub const SMOOTH_SVG_SCALE_FACTOR: f32", "cfg": [] }, { "id": "gpui::svg_renderer::SvgRenderer", "name": "SvgRenderer", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "svg_renderer", "path": "gpui::svg_renderer", "source": "crates/gpui/src/svg_renderer.rs", "summary": "A struct holding everything necessary to render SVGs.", "documentation": "A struct holding everything necessary to render SVGs.", "signature": "# [derive (Clone)] # [doc = \" A struct holding everything necessary to render SVGs.\"] pub struct SvgRenderer { asset_source : Arc, usvg_options : Arc>, }", "cfg": [] }, { "id": "gpui::svg_renderer::SvgRenderer::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "svg_renderer", "path": "gpui::svg_renderer", "source": "crates/gpui/src/svg_renderer.rs", "summary": "Creates a new SVG renderer with the provided asset source.", "documentation": "Creates a new SVG renderer with the provided asset source.", "signature": "pub fn new (asset_source : Arc) -> Self", "cfg": [], "target": "SvgRenderer" }, { "id": "gpui::svg_renderer::SvgRenderer::render_single_frame", "name": "render_single_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "svg_renderer", "path": "gpui::svg_renderer", "source": "crates/gpui/src/svg_renderer.rs", "summary": "Renders the given bytes into an image buffer.", "documentation": "Renders the given bytes into an image buffer.", "signature": "pub fn render_single_frame (& self, bytes : & [u8], scale_factor : f32,) -> Result, usvg::Error>", "cfg": [], "target": "SvgRenderer" }, { "id": "gpui::svg_renderer::SvgSize", "name": "SvgSize", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "svg_renderer", "path": "gpui::svg_renderer", "source": "crates/gpui/src/svg_renderer.rs", "summary": "The size in which to render the SVG.", "documentation": "The size in which to render the SVG.", "signature": "# [doc = \" The size in which to render the SVG.\"] pub enum SvgSize { # [doc = \" An absolute size in device pixels.\"] Size (Size), # [doc = \" A scaling factor to apply to the size provided by the SVG.\"] ScaleFactor (f32), }", "cfg": [] }, { "id": "gpui::tab_stop::TabStopMap::begin_group", "name": "begin_group", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn begin_group (& mut self, tab_index : isize)", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::end_group", "name": "end_group", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn end_group (& mut self)", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::insert", "name": "insert", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn insert (& mut self, focus_handle : & FocusHandle)", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::next", "name": "next", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn next (& self, focused_id : Option<& FocusId>) -> Option", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::paint_index", "name": "paint_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn paint_index (& self) -> usize", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::prev", "name": "prev", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn prev (& self, focused_id : Option<& FocusId>) -> Option", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopMap::replay", "name": "replay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "pub fn replay (& mut self, nodes : & [TabStopOperation])", "cfg": [], "target": "TabStopMap" }, { "id": "gpui::tab_stop::TabStopOperation", "name": "TabStopOperation", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "tab_stop", "path": "gpui::tab_stop", "source": "crates/gpui/src/tab_stop.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Clone)] pub enum TabStopOperation { Insert (FocusHandle), Group (TabIndex), GroupEnd, }", "cfg": [] }, { "id": "gpui::taffy::AvailableSpace", "name": "AvailableSpace", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "The space available for an element to be laid out in", "documentation": "The space available for an element to be laid out in", "signature": "# [doc = \" The space available for an element to be laid out in\"] # [derive (Copy, Clone, Default, Debug, Eq, PartialEq)] pub enum AvailableSpace { # [doc = \" The amount of space available is the specified number of pixels\"] Definite (Pixels), # [doc = \" The amount of space available is indefinite and the node should be laid out under a min-content constraint\"] # [default] MinContent, # [doc = \" The amount of space available is indefinite and the node should be laid out under a max-content constraint\"] MaxContent, }", "cfg": [] }, { "id": "gpui::taffy::AvailableSpace::min_size", "name": "min_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "Returns a `Size` with both width and height set to `AvailableSpace::MinContent`.", "documentation": "Returns a `Size` with both width and height set to `AvailableSpace::MinContent`.\n\nThis function is useful when you want to create a `Size` with the minimum content constraints\nfor both dimensions.\n\n# Examples\n\n```\nuse gpui::AvailableSpace;\nlet min_content_size = AvailableSpace::min_size();\nassert_eq!(min_content_size.width, AvailableSpace::MinContent);\nassert_eq!(min_content_size.height, AvailableSpace::MinContent);\n```", "signature": "pub const fn min_size () -> Size", "cfg": [], "target": "AvailableSpace" }, { "id": "gpui::taffy::LayoutId", "name": "LayoutId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "A unique identifier for a layout node, generated when requesting a layout from Taffy", "documentation": "A unique identifier for a layout node, generated when requesting a layout from Taffy", "signature": "# [doc = \" A unique identifier for a layout node, generated when requesting a layout from Taffy\"] # [derive (Copy, Clone, Eq, PartialEq, Debug)] # [repr (transparent)] pub struct LayoutId (NodeId);", "cfg": [] }, { "id": "gpui::taffy::TaffyLayoutEngine", "name": "TaffyLayoutEngine", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub struct TaffyLayoutEngine { taffy : TaffyTree, layouts : FxHashMap, absolute_layout_bounds : FxHashMap>, # [doc = \" Unrounded absolute border-box top-left per-node coordinate in device pixels.\"] absolute_outer_origins : FxHashMap>, computed_layouts : FxHashSet, layout_bounds_scratch_space : Vec, }", "cfg": [] }, { "id": "gpui::taffy::TaffyLayoutEngine::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn clear (& mut self)", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::compute_layout", "name": "compute_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn compute_layout (& mut self, id : LayoutId, available_space : Size, window : & mut Window, cx : & mut App,)", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::compute_layout_with_size", "name": "compute_layout_with_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "Assign a root border box for one computation without changing its authored style for later natural measurements. Descendants keep their styles; padding/borders may impose a larger minimum actual box.", "documentation": "Assign a root border box for one computation without changing its\nauthored style for later natural measurements. Descendants keep their\nstyles; padding/borders may impose a larger minimum actual box.", "signature": "pub fn compute_layout_with_size (& mut self, id : LayoutId, available_space : Size, assigned : Size, window : & mut Window, cx : & mut App,)", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::layout_bounds", "name": "layout_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn layout_bounds (& mut self, id : LayoutId, scale_factor : f32) -> Bounds", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::request_intrinsic_layout", "name": "request_intrinsic_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn request_intrinsic_layout (& mut self, style : Style, intrinsic : Size, rem_size : Pixels, scale_factor : f32,) -> LayoutId", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::request_layout", "name": "request_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn request_layout (& mut self, style : Style, rem_size : Pixels, scale_factor : f32, children : & [LayoutId],) -> LayoutId", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::request_measured_layout", "name": "request_measured_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "", "documentation": "", "signature": "pub fn request_measured_layout (& mut self, style : Style, rem_size : Pixels, scale_factor : f32, measure : impl FnMut (Size>, Size, & mut Window, & mut App,) -> Size + 'static,) -> LayoutId", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::taffy::TaffyLayoutEngine::stretch_auto_size_to_fill", "name": "stretch_auto_size_to_fill", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "taffy", "path": "gpui::taffy", "source": "crates/gpui/src/taffy.rs", "summary": "Treats any `auto` dimension of the given node's style as filling `size`.", "documentation": "Treats any `auto` dimension of the given node's style as filling `size`.\n\nThis is applied to window roots before layout so they behave like the\nroot element on the web, which stretches to fill the initial containing\nblock (the viewport) unless given an explicit size. Explicitly styled\ndimensions are preserved.", "signature": "pub fn stretch_auto_size_to_fill (& mut self, id : LayoutId, size : Size, scale_factor : f32,)", "cfg": [], "target": "TaffyLayoutEngine" }, { "id": "gpui::test::Observation", "name": "Observation", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "test", "path": "gpui::test", "source": "crates/gpui/src/test.rs", "summary": "A test struct for converting an observation callback into a stream.", "documentation": "A test struct for converting an observation callback into a stream.", "signature": "# [doc = \" A test struct for converting an observation callback into a stream.\"] pub struct Observation { rx : Pin>>, _subscription : Subscription, }", "cfg": [] }, { "id": "gpui::test::apply_seed_to_proptest_config", "name": "apply_seed_to_proptest_config", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "test", "path": "gpui::test", "source": "crates/gpui/src/test.rs", "summary": "Applies a fixed RNG seed to a proptest config so that case generation is deterministic. Uses `$SEED` if set, otherwise defaults to `0`. This bridges the GPUI `SEED` env var to proptest's RNG seed, so that a single variable controls both the scheduler seed and case generation.", "documentation": "Applies a fixed RNG seed to a proptest config so that case generation\nis deterministic. Uses `$SEED` if set, otherwise defaults to `0`.\nThis bridges the GPUI `SEED` env var to proptest's RNG seed, so that\na single variable controls both the scheduler seed and case generation.\n\nNote: this function is not intended to be used directly. Rather, it is\npublic so that it can be used from the `property_test` macro.", "signature": "pub fn apply_seed_to_proptest_config (mut config : proptest::test_runner::Config,) -> proptest::test_runner::Config", "cfg": [] }, { "id": "gpui::test::observe", "name": "observe", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "test", "path": "gpui::test", "source": "crates/gpui/src/test.rs", "summary": "observe returns a stream of the change events from the given `Entity`", "documentation": "observe returns a stream of the change events from the given `Entity`", "signature": "pub fn observe (entity : & Entity, cx : & mut TestAppContext) -> Observation<()>", "cfg": [] }, { "id": "gpui::test::run_test", "name": "run_test", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "test", "path": "gpui::test", "source": "crates/gpui/src/test.rs", "summary": "Run the given test function with the configured parameters. This is intended for use with the `gpui::test` macro and generally should not be used directly.", "documentation": "Run the given test function with the configured parameters.\nThis is intended for use with the `gpui::test` macro\nand generally should not be used directly.", "signature": "pub fn run_test (num_iterations : usize, explicit_seeds : & [u64], max_retries : usize, test_fn : & mut (dyn RefUnwindSafe + Fn (TestDispatcher, u64)), on_fail_fn : Option,)", "cfg": [] }, { "id": "gpui::test::run_test_once", "name": "run_test_once", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "test", "path": "gpui::test", "source": "crates/gpui/src/test.rs", "summary": "Similar to [`run_test`], but only runs the callback once, allowing [`FnOnce`] callbacks. This is intended for use with the `gpui::property_test` macro and generally should not be used directly.", "documentation": "Similar to [`run_test`], but only runs the callback once, allowing\n[`FnOnce`] callbacks. This is intended for use with the\n`gpui::property_test` macro and generally should not be used directly.\n\nDoesn't support many features of [`run_test`], since these are provided by\nproptest.", "signature": "pub fn run_test_once (seed : u64, test_fn : Box R>,) -> R", "cfg": [] }, { "id": "gpui::test::seed_strategy", "name": "seed_strategy", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "test", "path": "gpui::test", "source": "crates/gpui/src/test.rs", "summary": "Strategy injected into `#[gpui::property_test]` tests to control the seed given to the scheduler. Doesn't shrink, since all scheduler seeds are equivalent in complexity. If `$SEED` is set, it always uses that value.", "documentation": "Strategy injected into `#[gpui::property_test]` tests to control the seed\ngiven to the scheduler. Doesn't shrink, since all scheduler seeds are\nequivalent in complexity. If `$SEED` is set, it always uses that value.\n\nNote: this function is not intended to be used directly. Rather, it is\npublic so that it can be used from the `property_test` macro.", "signature": "pub fn seed_strategy () -> impl Strategy", "cfg": [] }, { "id": "gpui::text_system::Font", "name": "Font", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "The configuration details for identifying a specific font.", "documentation": "The configuration details for identifying a specific font.", "signature": "# [doc = \" The configuration details for identifying a specific font.\"] # [derive (Clone, Debug, Eq, PartialEq, Hash)] pub struct Font { # [doc = \" The font family name.\"] # [doc = \"\"] # [doc = \" The special name \\\".SystemUIFont\\\" is used to identify the system UI font, which varies based on platform.\"] pub family : SharedString, # [doc = \" The font features to use.\"] pub features : FontFeatures, # [doc = \" The fallbacks fonts to use.\"] pub fallbacks : Option, # [doc = \" The font weight.\"] pub weight : FontWeight, # [doc = \" The font style.\"] pub style : FontStyle, }", "cfg": [] }, { "id": "gpui::text_system::Font::bold", "name": "bold", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Set this Font to be bold", "documentation": "Set this Font to be bold", "signature": "pub fn bold (mut self) -> Self", "cfg": [], "target": "Font" }, { "id": "gpui::text_system::Font::italic", "name": "italic", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Set this Font to be italic", "documentation": "Set this Font to be italic", "signature": "pub fn italic (mut self) -> Self", "cfg": [], "target": "Font" }, { "id": "gpui::text_system::FontFamilyId", "name": "FontFamilyId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "An opaque identifier for a specific font family.", "documentation": "An opaque identifier for a specific font family.", "signature": "# [doc = \" An opaque identifier for a specific font family.\"] # [derive (Hash, PartialEq, Eq, Clone, Copy, Debug)] pub struct FontFamilyId (pub usize);", "cfg": [] }, { "id": "gpui::text_system::FontId", "name": "FontId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "An opaque identifier for a specific font.", "documentation": "An opaque identifier for a specific font.", "signature": "# [doc = \" An opaque identifier for a specific font.\"] # [derive (Hash, PartialEq, Eq, Clone, Copy, Debug)] # [repr (C)] pub struct FontId (pub usize);", "cfg": [] }, { "id": "gpui::text_system::FontMetrics", "name": "FontMetrics", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "A struct for storing font metrics. It is used to define the measurements of a typeface.", "documentation": "A struct for storing font metrics.\nIt is used to define the measurements of a typeface.", "signature": "# [doc = \" A struct for storing font metrics.\"] # [doc = \" It is used to define the measurements of a typeface.\"] # [derive (Clone, Copy, Debug)] pub struct FontMetrics { # [doc = \" The number of font units that make up the \\\"em square\\\",\"] # [doc = \" a scalable grid for determining the size of a typeface.\"] pub units_per_em : u32, # [doc = \" The vertical distance from the baseline of the font to the top of the glyph covers.\"] pub ascent : f32, # [doc = \" The vertical distance from the baseline of the font to the bottom of the glyph covers.\"] pub descent : f32, # [doc = \" The recommended additional space to add between lines of type.\"] pub line_gap : f32, # [doc = \" The suggested position of the underline.\"] pub underline_position : f32, # [doc = \" The suggested thickness of the underline.\"] pub underline_thickness : f32, # [doc = \" The height of a capital letter measured from the baseline of the font.\"] pub cap_height : f32, # [doc = \" The height of a lowercase x.\"] pub x_height : f32, # [doc = \" The outer limits of the area that the font covers.\"] # [doc = \" Corresponds to the xMin / xMax / yMin / yMax values in the OpenType `head` table\"] pub bounding_box : Bounds, }", "cfg": [] }, { "id": "gpui::text_system::FontMetrics::ascent", "name": "ascent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the vertical distance from the baseline of the font to the top of the glyph covers in pixels.", "documentation": "Returns the vertical distance from the baseline of the font to the top of the glyph covers in pixels.", "signature": "pub fn ascent (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::bounding_box", "name": "bounding_box", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the outer limits of the area that the font covers in pixels.", "documentation": "Returns the outer limits of the area that the font covers in pixels.", "signature": "pub fn bounding_box (& self, font_size : Pixels) -> Bounds", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::cap_height", "name": "cap_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the height of a capital letter measured from the baseline of the font in pixels.", "documentation": "Returns the height of a capital letter measured from the baseline of the font in pixels.", "signature": "pub fn cap_height (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::descent", "name": "descent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the vertical distance from the baseline of the font to the bottom of the glyph covers in pixels.", "documentation": "Returns the vertical distance from the baseline of the font to the bottom of the glyph covers in pixels.", "signature": "pub fn descent (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::line_gap", "name": "line_gap", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the recommended additional space to add between lines of type in pixels.", "documentation": "Returns the recommended additional space to add between lines of type in pixels.", "signature": "pub fn line_gap (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::underline_position", "name": "underline_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the suggested position of the underline in pixels.", "documentation": "Returns the suggested position of the underline in pixels.", "signature": "pub fn underline_position (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::underline_thickness", "name": "underline_thickness", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the suggested thickness of the underline in pixels.", "documentation": "Returns the suggested thickness of the underline in pixels.", "signature": "pub fn underline_thickness (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontMetrics::x_height", "name": "x_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the height of a lowercase x in pixels.", "documentation": "Returns the height of a lowercase x in pixels.", "signature": "pub fn x_height (& self, font_size : Pixels) -> Pixels", "cfg": [], "target": "FontMetrics" }, { "id": "gpui::text_system::FontStyle", "name": "FontStyle", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Allows italic or oblique faces to be selected.", "documentation": "Allows italic or oblique faces to be selected.", "signature": "# [doc = \" Allows italic or oblique faces to be selected.\"] # [derive (Clone, Copy, Eq, PartialEq, Debug, Hash, Default, Serialize, Deserialize, JsonSchema)] pub enum FontStyle { # [doc = \" A face that is neither italic not obliqued.\"] # [default] Normal, # [doc = \" A form that is generally cursive in nature.\"] Italic, # [doc = \" A typically-sloped version of the regular face.\"] Oblique, }", "cfg": [] }, { "id": "gpui::text_system::FontWeight", "name": "FontWeight", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "The degree of blackness or stroke thickness of a font. This value ranges from 100.0 to 900.0, with 400.0 as normal.", "documentation": "The degree of blackness or stroke thickness of a font. This value ranges from 100.0 to 900.0,\nwith 400.0 as normal.", "signature": "# [doc = \" The degree of blackness or stroke thickness of a font. This value ranges from 100.0 to 900.0,\"] # [doc = \" with 400.0 as normal.\"] # [derive (Clone, Copy, Debug, PartialEq, PartialOrd, Serialize, Deserialize, Add, Sub, FromStr)] # [serde (transparent)] pub struct FontWeight (pub f32);", "cfg": [] }, { "id": "gpui::text_system::GlyphId", "name": "GlyphId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "An identifier for a specific glyph, as returned by [`WindowTextSystem::layout_line`].", "documentation": "An identifier for a specific glyph, as returned by [`WindowTextSystem::layout_line`].", "signature": "# [doc = \" An identifier for a specific glyph, as returned by [`WindowTextSystem::layout_line`].\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Hash)] # [repr (C)] pub struct GlyphId (pub u32);", "cfg": [] }, { "id": "gpui::text_system::LineWrapperHandle", "name": "LineWrapperHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "A handle into the text system, which can be used to compute the wrapped layout of text", "documentation": "A handle into the text system, which can be used to compute the wrapped layout of text", "signature": "# [doc = \" A handle into the text system, which can be used to compute the wrapped layout of text\"] pub struct LineWrapperHandle { wrapper : Option, text_system : Arc, }", "cfg": [] }, { "id": "gpui::text_system::RenderGlyphParams", "name": "RenderGlyphParams", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Parameters for rendering a glyph, used as cache keys for raster bounds.", "documentation": "Parameters for rendering a glyph, used as cache keys for raster bounds.\n\nThis struct identifies a specific glyph rendering configuration including\nfont, size, subpixel positioning, and scale factor. It's used to look up\ncached raster bounds and sprite atlas entries.", "signature": "# [doc = \" Parameters for rendering a glyph, used as cache keys for raster bounds.\"] # [doc = \"\"] # [doc = \" This struct identifies a specific glyph rendering configuration including\"] # [doc = \" font, size, subpixel positioning, and scale factor. It's used to look up\"] # [doc = \" cached raster bounds and sprite atlas entries.\"] # [derive (Clone, Debug, PartialEq)] # [expect (missing_docs)] pub struct RenderGlyphParams { pub font_id : FontId, pub glyph_id : GlyphId, pub font_size : Pixels, pub subpixel_variant : Point, pub scale_factor : f32, pub is_emoji : bool, pub subpixel_rendering : bool, pub dilation : u8, }", "cfg": [] }, { "id": "gpui::text_system::SUBPIXEL_VARIANTS_X", "name": "SUBPIXEL_VARIANTS_X", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Number of subpixel glyph variants along the X axis.", "documentation": "Number of subpixel glyph variants along the X axis.", "signature": "pub const SUBPIXEL_VARIANTS_X: u8", "cfg": [] }, { "id": "gpui::text_system::SUBPIXEL_VARIANTS_Y", "name": "SUBPIXEL_VARIANTS_Y", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Number of subpixel glyph variants along the Y axis.", "documentation": "Number of subpixel glyph variants along the Y axis.", "signature": "pub const SUBPIXEL_VARIANTS_Y: u8", "cfg": [] }, { "id": "gpui::text_system::TextRun", "name": "TextRun", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "A styled run of text, for use in [`crate::TextLayout`].", "documentation": "A styled run of text, for use in [`crate::TextLayout`].", "signature": "# [doc = \" A styled run of text, for use in [`crate::TextLayout`].\"] # [derive (Clone, Debug, PartialEq, Eq, Default)] pub struct TextRun { # [doc = \" A number of utf8 bytes\"] pub len : usize, # [doc = \" The font to use for this run.\"] pub font : Font, # [doc = \" The color\"] pub color : Hsla, # [doc = \" The background color (if any)\"] pub background_color : Option, # [doc = \" A uniform corner radius for each background fragment.\"] pub background_radius : Option, # [doc = \" How far each background fragment reaches past this run's glyphs,\"] # [doc = \" horizontally, on each side. Paint only; the run keeps its advances.\"] pub background_padding : Option, # [doc = \" The underline style (if any)\"] pub underline : Option, # [doc = \" The strikethrough style (if any)\"] pub strikethrough : Option, }", "cfg": [] }, { "id": "gpui::text_system::TextSystem", "name": "TextSystem", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "The GPUI text rendering sub system.", "documentation": "The GPUI text rendering sub system.", "signature": "# [doc = \" The GPUI text rendering sub system.\"] pub struct TextSystem { platform_text_system : Arc, font_ids_by_font : RwLock>>, font_metrics : RwLock>, raster_bounds : RwLock>>, wrapper_pool : Mutex>>, font_runs_pool : Mutex>>, fallback_font_stack : SmallVec<[Font; 2]>, }", "cfg": [] }, { "id": "gpui::text_system::TextSystem::add_fonts", "name": "add_fonts", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Add a font's data to the text system.", "documentation": "Add a font's data to the text system.", "signature": "pub fn add_fonts (& self, fonts : Vec>) -> Result<()>", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::advance", "name": "advance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the advance width for the given character, in the given font and size.", "documentation": "Get the advance width for the given character, in the given font and size.", "signature": "pub fn advance (& self, font_id : FontId, font_size : Pixels, ch : char) -> Result>", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::all_font_names", "name": "all_font_names", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get a list of all available font names from the operating system.", "documentation": "Get a list of all available font names from the operating system.", "signature": "pub fn all_font_names (& self) -> Vec", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::ascent", "name": "ascent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the recommended distance from the baseline for the given font", "documentation": "Get the recommended distance from the baseline for the given font", "signature": "pub fn ascent (& self, font_id : FontId, font_size : Pixels) -> Pixels", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::baseline_offset", "name": "baseline_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the recommended baseline offset for the given font and line height.", "documentation": "Get the recommended baseline offset for the given font and line height.", "signature": "pub fn baseline_offset (& self, font_id : FontId, font_size : Pixels, line_height : Pixels,) -> Pixels", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::bounding_box", "name": "bounding_box", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the bounding box for the given font and font size. A font's bounding box is the smallest rectangle that could enclose all glyphs in the font. superimposed over one another.", "documentation": "Get the bounding box for the given font and font size.\nA font's bounding box is the smallest rectangle that could enclose all glyphs\nin the font. superimposed over one another.", "signature": "pub fn bounding_box (& self, font_id : FontId, font_size : Pixels) -> Bounds", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::cap_height", "name": "cap_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the height of a capital letter in the given font and size.", "documentation": "Get the height of a capital letter in the given font and size.", "signature": "pub fn cap_height (& self, font_id : FontId, font_size : Pixels) -> Pixels", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::ch_advance", "name": "ch_advance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the advance width of an `ch`.", "documentation": "Returns the advance width of an `ch`.\n\nUses the advance width of the `0` character in the given font and size.", "signature": "pub fn ch_advance (& self, font_id : FontId, font_size : Pixels) -> Result", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::ch_width", "name": "ch_width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the width of an `ch`.", "documentation": "Returns the width of an `ch`.\n\nUses the width of the `0` character in the given font and size.", "signature": "pub fn ch_width (& self, font_id : FontId, font_size : Pixels) -> Result", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::descent", "name": "descent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the recommended distance below the baseline for the given font, in single spaced text.", "documentation": "Get the recommended distance below the baseline for the given font,\nin single spaced text.", "signature": "pub fn descent (& self, font_id : FontId, font_size : Pixels) -> Pixels", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::em_advance", "name": "em_advance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the advance width of an `em`.", "documentation": "Returns the advance width of an `em`.\n\nUses the advance width of the `m` character in the given font and size.", "signature": "pub fn em_advance (& self, font_id : FontId, font_size : Pixels) -> Result", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::em_width", "name": "em_width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the width of an `em`.", "documentation": "Returns the width of an `em`.\n\nUses the width of the `m` character in the given font and size.", "signature": "pub fn em_width (& self, font_id : FontId, font_size : Pixels) -> Result", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::get_font_for_id", "name": "get_font_for_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the Font for the Font Id.", "documentation": "Get the Font for the Font Id.", "signature": "pub fn get_font_for_id (& self, id : FontId) -> Option", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::layout_width", "name": "layout_width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the shaped layout width of for the given character, in the given font and size.", "documentation": "Returns the shaped layout width of for the given character, in the given font and size.", "signature": "pub fn layout_width (& self, font_id : FontId, font_size : Pixels, ch : char) -> Pixels", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::line_wrapper", "name": "line_wrapper", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns a handle to a line wrapper, for the given font and font size.", "documentation": "Returns a handle to a line wrapper, for the given font and font size.", "signature": "pub fn line_wrapper (self : & Arc, font : Font, font_size : Pixels) -> LineWrapperHandle", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Create a new TextSystem with the given platform text system.", "documentation": "Create a new TextSystem with the given platform text system.", "signature": "pub fn new (platform_text_system : Arc) -> Self", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::resolve_font", "name": "resolve_font", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Resolves the specified font, falling back to the default font stack if the font fails to load.", "documentation": "Resolves the specified font, falling back to the default font stack if\nthe font fails to load.\n\n# Panics\n\nPanics if the font and none of the fallbacks can be resolved.", "signature": "pub fn resolve_font (& self, font : & Font) -> FontId", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::typographic_bounds", "name": "typographic_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the typographic bounds for the given character, in the given font and size.", "documentation": "Get the typographic bounds for the given character, in the given font and size.", "signature": "pub fn typographic_bounds (& self, font_id : FontId, font_size : Pixels, character : char,) -> Result>", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::units_per_em", "name": "units_per_em", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the number of font size units per 'em square', Per MDN: \"an abstract square whose height is the intended distance between lines of type in the same type size\"", "documentation": "Get the number of font size units per 'em square',\nPer MDN: \"an abstract square whose height is the intended distance between\nlines of type in the same type size\"", "signature": "pub fn units_per_em (& self, font_id : FontId) -> u32", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::TextSystem::x_height", "name": "x_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get the height of the x character in the given font and size.", "documentation": "Get the height of the x character in the given font and size.", "signature": "pub fn x_height (& self, font_id : FontId, font_size : Pixels) -> Pixels", "cfg": [], "target": "TextSystem" }, { "id": "gpui::text_system::WindowTextSystem", "name": "WindowTextSystem", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "The GPUI text layout subsystem.", "documentation": "The GPUI text layout subsystem.", "signature": "# [doc = \" The GPUI text layout subsystem.\"] # [derive (Deref)] pub struct WindowTextSystem { line_layout_cache : LineLayoutCache, # [deref] text_system : Arc, }", "cfg": [] }, { "id": "gpui::text_system::WindowTextSystem::em_layout_width", "name": "em_layout_width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the shaped layout width of an `em`.", "documentation": "Returns the shaped layout width of an `em`.", "signature": "pub fn em_layout_width (& self, font_id : FontId, font_size : Pixels) -> Pixels", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::layout_line", "name": "layout_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Layout the given line of text, at the given font_size. Subsets of the line can be styled independently with the `runs` parameter. Generally, you should prefer to use [`Self::shape_line`] instead, which can be painted directly.", "documentation": "Layout the given line of text, at the given font_size.\nSubsets of the line can be styled independently with the `runs` parameter.\nGenerally, you should prefer to use [`Self::shape_line`] instead, which\ncan be painted directly.", "signature": "pub fn layout_line (& self, text : & str, font_size : Pixels, runs : & [TextRun], force_width : Option,) -> Arc", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::layout_line_by_hash", "name": "layout_line_by_hash", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Layout the given line of text using a caller-provided content hash as the cache key.", "documentation": "Layout the given line of text using a caller-provided content hash as the cache key.\n\nThis enables cache hits without materializing a contiguous `SharedString` for the text.\nIf the cache misses, `materialize_text` is invoked to produce the `SharedString` for shaping.\n\nContract (caller enforced):\n- Same `text_hash` implies identical text content (collision risk accepted by caller).\n- `text_len` should be the UTF-8 byte length of the text (helps reduce accidental collisions).", "signature": "pub fn layout_line_by_hash (& self, text_hash : u64, text_len : usize, font_size : Pixels, runs : & [TextRun], force_width : Option, materialize_text : impl FnOnce () -> SharedString,) -> Arc", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::layout_width", "name": "layout_width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Returns the shaped layout width of for the given character, in the given font and size.", "documentation": "Returns the shaped layout width of for the given character, in the given font and size.", "signature": "pub fn layout_width (& self, font_id : FontId, font_size : Pixels, ch : char) -> Pixels", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Create a new WindowTextSystem with the given TextSystem.", "documentation": "Create a new WindowTextSystem with the given TextSystem.", "signature": "pub fn new (text_system : Arc) -> Self", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::shape_line", "name": "shape_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Shape the given line, at the given font_size, for painting to the screen. Subsets of the line can be styled independently with the `runs` parameter.", "documentation": "Shape the given line, at the given font_size, for painting to the screen.\nSubsets of the line can be styled independently with the `runs` parameter.\n\nNote that this method can only shape a single line of text. It will panic\nif the text contains newlines. If you need to shape multiple lines of text,\nuse [`Self::shape_text`] instead.", "signature": "pub fn shape_line (& self, text : SharedString, font_size : Pixels, runs : & [TextRun], force_width : Option,) -> ShapedLine", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::shape_line_by_hash", "name": "shape_line_by_hash", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Shape the given line using a caller-provided content hash as the cache key.", "documentation": "Shape the given line using a caller-provided content hash as the cache key.\n\nThis enables cache hits without materializing a contiguous `SharedString` for the text.\nIf the cache misses, `materialize_text` is invoked to produce the `SharedString` for shaping.\n\nContract (caller enforced):\n- Same `text_hash` implies identical text content (collision risk accepted by caller).\n- `text_len` should be the UTF-8 byte length of the text (helps reduce accidental collisions).\n\nLike [`Self::shape_line`], this must be used only for single-line text (no `\\n`).", "signature": "pub fn shape_line_by_hash (& self, text_hash : u64, text_len : usize, font_size : Pixels, runs : & [TextRun], force_width : Option, materialize_text : impl FnOnce () -> SharedString,) -> ShapedLine", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::shape_text", "name": "shape_text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Shape a multi line string of text, at the given font_size, for painting to the screen. Subsets of the text can be styled independently with the `runs` parameter. If `wrap_width` is provided, the line breaks will be adjusted to fit within the given width.", "documentation": "Shape a multi line string of text, at the given font_size, for painting to the screen.\nSubsets of the text can be styled independently with the `runs` parameter.\nIf `wrap_width` is provided, the line breaks will be adjusted to fit within the given width.", "signature": "pub fn shape_text (& self, text : SharedString, font_size : Pixels, runs : & [TextRun], wrap_width : Option, line_clamp : Option,) -> Result>", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::WindowTextSystem::try_layout_line_by_hash", "name": "try_layout_line_by_hash", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Probe the line layout cache using a caller-provided content hash, without allocating.", "documentation": "Probe the line layout cache using a caller-provided content hash, without allocating.\n\nReturns `Some(layout)` if the layout is already cached in either the current frame\nor the previous frame. Returns `None` if it is not cached.\n\nContract (caller enforced):\n- Same `text_hash` implies identical text content (collision risk accepted by caller).\n- `text_len` should be the UTF-8 byte length of the text (helps reduce accidental collisions).", "signature": "pub fn try_layout_line_by_hash (& self, text_hash : u64, text_len : usize, font_size : Pixels, runs : & [TextRun], force_width : Option,) -> Option>", "cfg": [], "target": "WindowTextSystem" }, { "id": "gpui::text_system::font", "name": "font", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Get a [`Font`] for a given name.", "documentation": "Get a [`Font`] for a given name.", "signature": "pub fn font (family : impl Into) -> Font", "cfg": [] }, { "id": "gpui::text_system::font_fallbacks::FontFallbacks", "name": "FontFallbacks", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_fallbacks", "path": "gpui::text_system::font_fallbacks", "source": "crates/gpui/src/text_system/font_fallbacks.rs", "summary": "The fallback fonts that can be configured for a given font. Fallback fonts family names are stored here.", "documentation": "The fallback fonts that can be configured for a given font.\nFallback fonts family names are stored here.", "signature": "# [doc = \" The fallback fonts that can be configured for a given font.\"] # [doc = \" Fallback fonts family names are stored here.\"] # [derive (Default, Clone, Eq, PartialEq, Hash, Debug, Deserialize, Serialize, JsonSchema)] pub struct FontFallbacks (pub Arc>);", "cfg": [] }, { "id": "gpui::text_system::font_fallbacks::FontFallbacks::fallback_list", "name": "fallback_list", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_fallbacks", "path": "gpui::text_system::font_fallbacks", "source": "crates/gpui/src/text_system/font_fallbacks.rs", "summary": "Get the fallback fonts family names", "documentation": "Get the fallback fonts family names", "signature": "pub fn fallback_list (& self) -> & [String]", "cfg": [], "target": "FontFallbacks" }, { "id": "gpui::text_system::font_fallbacks::FontFallbacks::from_fonts", "name": "from_fonts", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_fallbacks", "path": "gpui::text_system::font_fallbacks", "source": "crates/gpui/src/text_system/font_fallbacks.rs", "summary": "Create a font fallback from a list of strings", "documentation": "Create a font fallback from a list of strings", "signature": "pub fn from_fonts (fonts : Vec) -> Self", "cfg": [], "target": "FontFallbacks" }, { "id": "gpui::text_system::font_features::FontFeatures", "name": "FontFeatures", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_features", "path": "gpui::text_system::font_features", "source": "crates/gpui/src/text_system/font_features.rs", "summary": "The OpenType features that can be configured for a given font.", "documentation": "The OpenType features that can be configured for a given font.", "signature": "# [doc = \" The OpenType features that can be configured for a given font.\"] # [derive (Default, Clone, Eq, PartialEq, Hash)] pub struct FontFeatures (pub Arc>);", "cfg": [] }, { "id": "gpui::text_system::font_features::FontFeatures::disable_ligatures", "name": "disable_ligatures", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_features", "path": "gpui::text_system::font_features", "source": "crates/gpui/src/text_system/font_features.rs", "summary": "Turns off every ligature feature a shaper applies without being asked.", "documentation": "Turns off every ligature feature a shaper applies without being asked.\n\nAll three, because they are on by default and a caller that says\n\"no ligatures\" and still gets `liga` has been told something untrue:\n`liga` is the standard set, `clig` the contextual one, and `calt` the\nalternates most programming faces hang their arrows and arrows-like\nforms on. Discretionary `dlig` is off unless someone asks for it, so\nthere is nothing here to turn off.", "signature": "pub fn disable_ligatures () -> Self", "cfg": [], "target": "FontFeatures" }, { "id": "gpui::text_system::font_features::FontFeatures::is_calt_enabled", "name": "is_calt_enabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_features", "path": "gpui::text_system::font_features", "source": "crates/gpui/src/text_system/font_features.rs", "summary": "Returns whether the `calt` feature is enabled.", "documentation": "Returns whether the `calt` feature is enabled.\n\nReturns `None` if the feature is not present.", "signature": "pub fn is_calt_enabled (& self) -> Option", "cfg": [], "target": "FontFeatures" }, { "id": "gpui::text_system::font_features::FontFeatures::tag_value_list", "name": "tag_value_list", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::font_features", "path": "gpui::text_system::font_features", "source": "crates/gpui/src/text_system/font_features.rs", "summary": "Get the tag name list of the font OpenType features only enabled or disabled features are returned", "documentation": "Get the tag name list of the font OpenType features\nonly enabled or disabled features are returned", "signature": "pub fn tag_value_list (& self) -> & [(String, u32)]", "cfg": [], "target": "FontFeatures" }, { "id": "gpui::text_system::font_name_with_fallbacks", "name": "font_name_with_fallbacks", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Maps well-known virtual font names to their concrete equivalents.", "documentation": "Maps well-known virtual font names to their concrete equivalents.", "signature": "pub fn font_name_with_fallbacks<'a> (name : & 'a str, system : & 'a str) -> & 'a str", "cfg": [] }, { "id": "gpui::text_system::font_name_with_fallbacks_shared", "name": "font_name_with_fallbacks_shared", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "Like [`font_name_with_fallbacks`] but accepts and returns [`SharedString`] references.", "documentation": "Like [`font_name_with_fallbacks`] but accepts and returns [`SharedString`] references.", "signature": "pub fn font_name_with_fallbacks_shared<'a> (name : & 'a SharedString, system : & 'a SharedString,) -> & 'a SharedString", "cfg": [] }, { "id": "gpui::text_system::line::DecorationRun", "name": "DecorationRun", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Set the text decoration for a run of text.", "documentation": "Set the text decoration for a run of text.", "signature": "# [doc = \" Set the text decoration for a run of text.\"] # [derive (Debug, Clone)] pub struct DecorationRun { # [doc = \" The length of the run in utf-8 bytes.\"] pub len : u32, # [doc = \" The color for this run\"] pub color : Hsla, # [doc = \" The background color for this run\"] pub background_color : Option, # [doc = \" A uniform corner radius for each background fragment.\"] pub background_radius : Option, # [doc = \" How far each background fragment reaches past this run's glyphs,\"] # [doc = \" horizontally, on each side. Paint only: the run keeps its advance\"] # [doc = \" width, so growing the fill reflows nothing around it.\"] pub background_padding : Option, # [doc = \" The underline style for this run\"] pub underline : Option, # [doc = \" The strikethrough style for this run\"] pub strikethrough : Option, }", "cfg": [] }, { "id": "gpui::text_system::line::GlyphRasterData", "name": "GlyphRasterData", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Pre-computed glyph data for efficient painting without per-glyph cache lookups.", "documentation": "Pre-computed glyph data for efficient painting without per-glyph cache lookups.\n\nThis is produced by `ShapedLine::compute_glyph_raster_data` during prepaint\nand consumed by `ShapedLine::paint_with_raster_data` during paint.", "signature": "# [doc = \" Pre-computed glyph data for efficient painting without per-glyph cache lookups.\"] # [doc = \"\"] # [doc = \" This is produced by `ShapedLine::compute_glyph_raster_data` during prepaint\"] # [doc = \" and consumed by `ShapedLine::paint_with_raster_data` during paint.\"] # [derive (Clone, Debug)] pub struct GlyphRasterData { # [doc = \" The raster bounds for each glyph, in paint order.\"] pub bounds : Vec>, # [doc = \" The render params for each glyph (needed for sprite atlas lookup).\"] pub params : Vec, }", "cfg": [] }, { "id": "gpui::text_system::line::ShapedLine", "name": "ShapedLine", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "A line of text that has been shaped and decorated.", "documentation": "A line of text that has been shaped and decorated.", "signature": "# [doc = \" A line of text that has been shaped and decorated.\"] # [derive (Clone, Default, Debug, Deref, DerefMut)] pub struct ShapedLine { # [deref] # [deref_mut] pub (crate) layout : Arc, # [doc = \" The text that was shaped for this line.\"] pub text : SharedString, pub (crate) decoration_runs : SmallVec<[DecorationRun; 32]>, }", "cfg": [] }, { "id": "gpui::text_system::line::ShapedLine::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "The length of the line in utf-8 bytes.", "documentation": "The length of the line in utf-8 bytes.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "ShapedLine" }, { "id": "gpui::text_system::line::ShapedLine::paint", "name": "paint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Paint the line of text to the window.", "documentation": "Paint the line of text to the window.", "signature": "pub fn paint (& self, origin : Point, line_height : Pixels, align : TextAlign, align_width : Option, window : & mut Window, cx : & mut App,) -> Result<()>", "cfg": [], "target": "ShapedLine" }, { "id": "gpui::text_system::line::ShapedLine::paint_background", "name": "paint_background", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Paint the background of the line to the window.", "documentation": "Paint the background of the line to the window.", "signature": "pub fn paint_background (& self, origin : Point, line_height : Pixels, align : TextAlign, align_width : Option, window : & mut Window, cx : & mut App,) -> Result<()>", "cfg": [], "target": "ShapedLine" }, { "id": "gpui::text_system::line::ShapedLine::split_at", "name": "split_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Split this shaped line at a byte index, returning `(prefix, suffix)`.", "documentation": "Split this shaped line at a byte index, returning `(prefix, suffix)`.\n\n- `prefix` contains glyphs for bytes `[0, byte_index)` with original positions.\nIts width equals the x-advance up to the split point.\n- `suffix` contains glyphs for bytes `[byte_index, len)` with positions\nshifted left so the first glyph starts at x=0, and byte indices rebased to 0.\n- Decoration runs are partitioned at the boundary; a run that straddles it is\nsplit into two with adjusted lengths.\n- `font_size`, `ascent`, and `descent` are copied to both halves.", "signature": "pub fn split_at (& self, byte_index : usize) -> (ShapedLine, ShapedLine)", "cfg": [], "target": "ShapedLine" }, { "id": "gpui::text_system::line::ShapedLine::width", "name": "width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "The width of the shaped line in pixels.", "documentation": "The width of the shaped line in pixels.\n\nThis is the glyph advance width computed by the text shaping system and is useful for\nincrementally advancing a \"pen\" when painting multiple fragments on the same row.", "signature": "pub fn width (& self) -> Pixels", "cfg": [], "target": "ShapedLine" }, { "id": "gpui::text_system::line::ShapedLine::with_len", "name": "with_len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Override the len, useful if you're rendering text a as text b (e.g. rendering invisibles).", "documentation": "Override the len, useful if you're rendering text a\nas text b (e.g. rendering invisibles).", "signature": "pub fn with_len (mut self, len : usize) -> Self", "cfg": [], "target": "ShapedLine" }, { "id": "gpui::text_system::line::WrappedLine", "name": "WrappedLine", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "A line of text that has been shaped, decorated, and wrapped by the text layout system.", "documentation": "A line of text that has been shaped, decorated, and wrapped by the text layout system.", "signature": "# [doc = \" A line of text that has been shaped, decorated, and wrapped by the text layout system.\"] # [derive (Default, Debug, Deref, DerefMut)] pub struct WrappedLine { # [deref] # [deref_mut] pub (crate) layout : Arc, # [doc = \" The text that was shaped for this line.\"] pub text : SharedString, pub (crate) decoration_runs : Vec, }", "cfg": [] }, { "id": "gpui::text_system::line::WrappedLine::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "The length of the underlying, unwrapped layout, in utf-8 bytes.", "documentation": "The length of the underlying, unwrapped layout, in utf-8 bytes.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "WrappedLine" }, { "id": "gpui::text_system::line::WrappedLine::paint", "name": "paint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Paint this line of text to the window.", "documentation": "Paint this line of text to the window.", "signature": "pub fn paint (& self, origin : Point, line_height : Pixels, align : TextAlign, bounds : Option>, window : & mut Window, cx : & mut App,) -> Result<()>", "cfg": [], "target": "WrappedLine" }, { "id": "gpui::text_system::line::WrappedLine::paint_background", "name": "paint_background", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line", "path": "gpui::text_system::line", "source": "crates/gpui/src/text_system/line.rs", "summary": "Paint the background of line of text to the window.", "documentation": "Paint the background of line of text to the window.", "signature": "pub fn paint_background (& self, origin : Point, line_height : Pixels, align : TextAlign, bounds : Option>, window : & mut Window, cx : & mut App,) -> Result<()>", "cfg": [], "target": "WrappedLine" }, { "id": "gpui::text_system::line_layout::FontRun", "name": "FontRun", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "A run of text with a single font.", "documentation": "A run of text with a single font.", "signature": "# [doc = \" A run of text with a single font.\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Hash)] # [expect (missing_docs)] pub struct FontRun { pub len : usize, pub font_id : FontId, }", "cfg": [] }, { "id": "gpui::text_system::line_layout::LineLayout", "name": "LineLayout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "A laid out and styled line of text", "documentation": "A laid out and styled line of text", "signature": "# [doc = \" A laid out and styled line of text\"] # [derive (Default, Debug)] pub struct LineLayout { # [doc = \" The font size for this line\"] pub font_size : Pixels, # [doc = \" The width of the line\"] pub width : Pixels, # [doc = \" The ascent of the line\"] pub ascent : Pixels, # [doc = \" The descent of the line\"] pub descent : Pixels, # [doc = \" The shaped runs that make up this line\"] pub runs : Vec, # [doc = \" The length of the line in utf-8 bytes\"] pub len : usize, }", "cfg": [] }, { "id": "gpui::text_system::line_layout::LineLayout::closest_index_for_x", "name": "closest_index_for_x", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "closest_index_for_x returns the character boundary closest to the given x coordinate (e.g. to handle aligning up/down arrow keys)", "documentation": "closest_index_for_x returns the character boundary closest to the given x coordinate\n(e.g. to handle aligning up/down arrow keys)", "signature": "pub fn closest_index_for_x (& self, x : Pixels) -> usize", "cfg": [], "target": "LineLayout" }, { "id": "gpui::text_system::line_layout::LineLayout::font_id_for_index", "name": "font_id_for_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The corresponding Font at the given index", "documentation": "The corresponding Font at the given index", "signature": "pub fn font_id_for_index (& self, index : usize) -> Option", "cfg": [], "target": "LineLayout" }, { "id": "gpui::text_system::line_layout::LineLayout::index_for_x", "name": "index_for_x", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The index for the character at the given x coordinate", "documentation": "The index for the character at the given x coordinate", "signature": "pub fn index_for_x (& self, x : Pixels) -> Option", "cfg": [], "target": "LineLayout" }, { "id": "gpui::text_system::line_layout::LineLayout::x_for_index", "name": "x_for_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The x position of the character at the given index", "documentation": "The x position of the character at the given index", "signature": "pub fn x_for_index (& self, index : usize) -> Pixels", "cfg": [], "target": "LineLayout" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::finish_frame", "name": "finish_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn finish_frame (& self)", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::layout_index", "name": "layout_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn layout_index (& self) -> LineLayoutIndex", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::layout_line", "name": "layout_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn layout_line (& self, text : Text, font_size : Pixels, runs : & [FontRun], force_width : Option,) -> Arc where Text : AsRef, SharedString : From,", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::layout_line_by_hash", "name": "layout_line_by_hash", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "Layout a line of text using a caller-provided content hash as the cache key.", "documentation": "Layout a line of text using a caller-provided content hash as the cache key.\n\nThis enables cache hits without materializing a contiguous `SharedString` for `text`.\nIf the cache misses, `materialize_text` is invoked to produce the `SharedString` for shaping.\n\nContract (caller enforced):\n- Same `text_hash` implies identical text content (collision risk accepted by caller).\n- `text_len` should be the UTF-8 byte length of the text (helps reduce accidental collisions).", "signature": "pub fn layout_line_by_hash (& self, text_hash : u64, text_len : usize, font_size : Pixels, runs : & [FontRun], force_width : Option, materialize_text : impl FnOnce () -> SharedString,) -> Arc", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::layout_wrapped_line", "name": "layout_wrapped_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn layout_wrapped_line (& self, text : Text, font_size : Pixels, runs : & [FontRun], wrap_width : Option, max_lines : Option,) -> Arc where Text : AsRef, SharedString : From,", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn new (platform_text_system : Arc) -> Self", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::reuse_layouts", "name": "reuse_layouts", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn reuse_layouts (& self, range : Range)", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::truncate_layouts", "name": "truncate_layouts", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "", "documentation": "", "signature": "pub fn truncate_layouts (& self, index : LineLayoutIndex)", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::LineLayoutCache::try_layout_line_by_hash", "name": "try_layout_line_by_hash", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "Try to retrieve a previously-shaped line layout using a caller-provided content hash.", "documentation": "Try to retrieve a previously-shaped line layout using a caller-provided content hash.\n\nThis is a *non-allocating* cache probe: it does not materialize any text. If the layout\nis not already cached in either the current frame or previous frame, returns `None`.\n\nContract (caller enforced):\n- Same `text_hash` implies identical text content (collision risk accepted by caller).\n- `text_len` should be the UTF-8 byte length of the text (helps reduce accidental collisions).", "signature": "pub fn try_layout_line_by_hash (& self, text_hash : u64, text_len : usize, font_size : Pixels, runs : & [FontRun], force_width : Option,) -> Option>", "cfg": [], "target": "LineLayoutCache" }, { "id": "gpui::text_system::line_layout::ShapedGlyph", "name": "ShapedGlyph", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "A single glyph, ready to paint.", "documentation": "A single glyph, ready to paint.", "signature": "# [doc = \" A single glyph, ready to paint.\"] # [derive (Clone, Debug)] pub struct ShapedGlyph { # [doc = \" The ID for this glyph, as determined by the text system.\"] pub id : GlyphId, # [doc = \" The position of this glyph in its containing line.\"] pub position : Point, # [doc = \" The index of this glyph in the original text.\"] pub index : usize, # [doc = \" Whether this glyph is an emoji\"] pub is_emoji : bool, }", "cfg": [] }, { "id": "gpui::text_system::line_layout::ShapedRun", "name": "ShapedRun", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "A run of text that has been shaped .", "documentation": "A run of text that has been shaped .", "signature": "# [doc = \" A run of text that has been shaped .\"] # [derive (Debug, Clone)] pub struct ShapedRun { # [doc = \" The font id for this run\"] pub font_id : FontId, # [doc = \" The glyphs that make up this run\"] pub glyphs : Vec, }", "cfg": [] }, { "id": "gpui::text_system::line_layout::WrapBoundary", "name": "WrapBoundary", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "A boundary at which a line was wrapped", "documentation": "A boundary at which a line was wrapped", "signature": "# [doc = \" A boundary at which a line was wrapped\"] # [derive (Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] pub struct WrapBoundary { # [doc = \" The index in the run just before the line was wrapped\"] pub run_ix : usize, # [doc = \" The index of the glyph just before the line was wrapped\"] pub glyph_ix : usize, }", "cfg": [] }, { "id": "gpui::text_system::line_layout::WrappedLineLayout", "name": "WrappedLineLayout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "A line of text that has been wrapped to fit a given width", "documentation": "A line of text that has been wrapped to fit a given width", "signature": "# [doc = \" A line of text that has been wrapped to fit a given width\"] # [derive (Default, Debug)] pub struct WrappedLineLayout { # [doc = \" The line layout, pre-wrapping.\"] pub unwrapped_layout : Arc, # [doc = \" The boundaries at which the line was wrapped\"] pub wrap_boundaries : SmallVec<[WrapBoundary; 1]>, # [doc = \" The width of the line, if it was wrapped\"] pub wrap_width : Option, }", "cfg": [] }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::ascent", "name": "ascent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The ascent of a line in this layout", "documentation": "The ascent of a line in this layout", "signature": "pub fn ascent (& self) -> Pixels", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::bounds_for_range", "name": "bounds_for_range", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "Returns the painted rectangles occupied by a UTF-8 byte range.", "documentation": "Returns the painted rectangles occupied by a UTF-8 byte range.\n\nRectangles follow visual glyph order, so a logical range crossing a\nbidirectional run may produce more than one rectangle on a row. The\ncaller is responsible for snapping the range to grapheme boundaries.", "signature": "pub fn bounds_for_range (& self, range : Range, origin : Point, line_height : Pixels, align : TextAlign, align_width : Pixels,) -> Vec>", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::closest_index_for_position", "name": "closest_index_for_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The closest index to a given position in this layout for the given line height.", "documentation": "The closest index to a given position in this layout for the given line height.\n\nClosest means the character boundary closest to the given position.\n\nSee also [`LineLayout::closest_index_for_x`].", "signature": "pub fn closest_index_for_position (& self, position : Point, line_height : Pixels,) -> Result", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::closest_index_for_position_aligned", "name": "closest_index_for_position_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The closest index to a painted position when visual rows use an alignment.", "documentation": "The closest index to a painted position when visual rows use an\nalignment.", "signature": "pub fn closest_index_for_position_aligned (& self, position : Point, line_height : Pixels, align : TextAlign, align_width : Pixels,) -> Result", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::descent", "name": "descent", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The descent of a line in this layout", "documentation": "The descent of a line in this layout", "signature": "pub fn descent (& self) -> Pixels", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::font_size", "name": "font_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The font size of this layout", "documentation": "The font size of this layout", "signature": "pub fn font_size (& self) -> Pixels", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::index_for_position", "name": "index_for_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The index corresponding to a given position in this layout for the given line height.", "documentation": "The index corresponding to a given position in this layout for the given line height.\n\nSee also [`Self::closest_index_for_position`].", "signature": "pub fn index_for_position (& self, position : Point, line_height : Pixels,) -> Result", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::index_for_position_aligned", "name": "index_for_position_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The index at a painted position when visual rows use an alignment.", "documentation": "The index at a painted position when visual rows use an alignment.\n\n`align_width` must be the same width passed while painting. This keeps\neditable hit testing on centered and right-aligned text in the same\ngeometry authority as the glyphs rather than making an editor reverse\nthe paint offset itself.", "signature": "pub fn index_for_position_aligned (& self, position : Point, line_height : Pixels, align : TextAlign, align_width : Pixels,) -> Result", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::len", "name": "len", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The length of the underlying text, in utf8 bytes.", "documentation": "The length of the underlying text, in utf8 bytes.", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::position_for_index", "name": "position_for_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "Returns the pixel position for the given byte index.", "documentation": "Returns the pixel position for the given byte index.", "signature": "pub fn position_for_index (& self, index : usize, line_height : Pixels) -> Option>", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::position_for_index_aligned", "name": "position_for_index_aligned", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "Returns the painted pixel position for a byte index when visual rows use an alignment.", "documentation": "Returns the painted pixel position for a byte index when visual rows\nuse an alignment.\n\nThe returned x coordinate includes the alignment offset inside\n`align_width`; y remains relative to the line origin.", "signature": "pub fn position_for_index_aligned (& self, index : usize, line_height : Pixels, align : TextAlign, align_width : Pixels,) -> Option>", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::runs", "name": "runs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The runs in this layout, sans wrapping", "documentation": "The runs in this layout, sans wrapping", "signature": "pub fn runs (& self) -> & [ShapedRun]", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::size", "name": "size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The size of the whole wrapped text, for the given line_height. can span multiple lines if there are multiple wrap boundaries.", "documentation": "The size of the whole wrapped text, for the given line_height.\ncan span multiple lines if there are multiple wrap boundaries.", "signature": "pub fn size (& self, line_height : Pixels) -> Size", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::width", "name": "width", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The width of this line, in pixels, whether or not it was wrapped.", "documentation": "The width of this line, in pixels, whether or not it was wrapped.", "signature": "pub fn width (& self) -> Pixels", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_layout::WrappedLineLayout::wrap_boundaries", "name": "wrap_boundaries", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_layout", "path": "gpui::text_system::line_layout", "source": "crates/gpui/src/text_system/line_layout.rs", "summary": "The wrap boundaries in this layout", "documentation": "The wrap boundaries in this layout", "signature": "pub fn wrap_boundaries (& self) -> & [WrapBoundary]", "cfg": [], "target": "WrappedLineLayout" }, { "id": "gpui::text_system::line_wrapper::Boundary", "name": "Boundary", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "A boundary between two lines of text.", "documentation": "A boundary between two lines of text.", "signature": "# [doc = \" A boundary between two lines of text.\"] # [derive (Copy, Clone, Debug, PartialEq, Eq)] pub struct Boundary { # [doc = \" The index of the last character in a line\"] pub ix : usize, # [doc = \" The indent of the next line.\"] pub next_indent : u32, }", "cfg": [] }, { "id": "gpui::text_system::line_wrapper::LineFragment", "name": "LineFragment", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "A fragment of a line that can be wrapped.", "documentation": "A fragment of a line that can be wrapped.", "signature": "# [doc = \" A fragment of a line that can be wrapped.\"] pub enum LineFragment<'a> { # [doc = \" A text fragment consisting of characters.\"] Text { # [doc = \" The text content of the fragment.\"] text : & 'a str, }, # [doc = \" A non-text element with a fixed width.\"] Element { # [doc = \" The width of the element in pixels.\"] width : Pixels, # [doc = \" The UTF-8 encoded length of the element.\"] len_utf8 : usize, }, }", "cfg": [] }, { "id": "gpui::text_system::line_wrapper::LineFragment::element", "name": "element", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Creates a new non-text element with the given width and UTF-8 encoded length.", "documentation": "Creates a new non-text element with the given width and UTF-8 encoded length.", "signature": "pub fn element (width : Pixels, len_utf8 : usize) -> Self", "cfg": [], "target": "LineFragment<'a>" }, { "id": "gpui::text_system::line_wrapper::LineFragment::text", "name": "text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Creates a new text fragment from the given text.", "documentation": "Creates a new text fragment from the given text.", "signature": "pub fn text (text : & 'a str) -> Self", "cfg": [], "target": "LineFragment<'a>" }, { "id": "gpui::text_system::line_wrapper::LineWrapper", "name": "LineWrapper", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "The GPUI line wrapper, used to wrap lines of text to a given width.", "documentation": "The GPUI line wrapper, used to wrap lines of text to a given width.", "signature": "# [doc = \" The GPUI line wrapper, used to wrap lines of text to a given width.\"] pub struct LineWrapper { text_system : Arc, pub (crate) font_id : FontId, pub (crate) font_size : Pixels, cached_ascii_char_widths : [Option; 128], cached_other_char_widths : HashMap, }", "cfg": [] }, { "id": "gpui::text_system::line_wrapper::LineWrapper::should_truncate_line", "name": "should_truncate_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Determines if a line should be truncated based on its width.", "documentation": "Determines if a line should be truncated based on its width.\n\nReturns the truncation index in `line`.", "signature": "pub fn should_truncate_line (& mut self, line : & str, truncate_width : Pixels, truncation_affix : & str, truncate_from : TruncateFrom,) -> Option", "cfg": [], "target": "LineWrapper" }, { "id": "gpui::text_system::line_wrapper::LineWrapper::truncate_line", "name": "truncate_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Truncate a line of text to the given width with this wrapper's font and font size.", "documentation": "Truncate a line of text to the given width with this wrapper's font and font size.", "signature": "pub fn truncate_line<'a> (& mut self, line : SharedString, truncate_width : Pixels, truncation_affix : & str, runs : & 'a [TextRun], truncate_from : TruncateFrom,) -> (SharedString, Cow<'a, [TextRun]>)", "cfg": [], "target": "LineWrapper" }, { "id": "gpui::text_system::line_wrapper::LineWrapper::truncate_wrapped_line", "name": "truncate_wrapped_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Truncate text to fit within a given number of wrapped lines.", "documentation": "Truncate text to fit within a given number of wrapped lines.\n\nUnlike `truncate_line` which treats the text as a flat width budget\n(`width * max_lines`), this method uses `wrap_line`'s Unicode boundaries\nand continuation indent, then fits the affix on the last allowed line.\n\nFor `max_lines == 1`, this delegates to `truncate_line`.", "signature": "pub fn truncate_wrapped_line<'a> (& mut self, text : SharedString, wrap_width : Pixels, max_lines : usize, truncation_affix : & str, runs : & 'a [TextRun], truncate_from : TruncateFrom,) -> (SharedString, Cow<'a, [TextRun]>)", "cfg": [], "target": "LineWrapper" }, { "id": "gpui::text_system::line_wrapper::LineWrapper::wrap_line", "name": "wrap_line", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Wrap a line of text to the given width with this wrapper's font and font size. UAX #14 supplies break opportunities across fragment boundaries. Inline elements behave as object replacement characters, but returned indices retain their caller-supplied UTF-8 lengths. When no opportunity fits, emergency wrapping still breaks before the overflowing character/item.", "documentation": "Wrap a line of text to the given width with this wrapper's font and font size.\nUAX #14 supplies break opportunities across fragment boundaries. Inline\nelements behave as object replacement characters, but returned indices\nretain their caller-supplied UTF-8 lengths. When no opportunity fits,\nemergency wrapping still breaks before the overflowing character/item.", "signature": "pub fn wrap_line<'a> (& 'a mut self, fragments : & 'a [LineFragment], wrap_width : Pixels,) -> impl Iterator + 'a", "cfg": [], "target": "LineWrapper" }, { "id": "gpui::text_system::line_wrapper::TruncateFrom", "name": "TruncateFrom", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "Determines whether to truncate text from the start or end.", "documentation": "Determines whether to truncate text from the start or end.", "signature": "# [doc = \" Determines whether to truncate text from the start or end.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum TruncateFrom { # [doc = \" Truncate text from the start.\"] Start, # [doc = \" Truncate text from the end.\"] End, # [doc = \" Truncate text from the middle, preserving the start and end.\"] Middle, }", "cfg": [] }, { "id": "gpui::text_system::line_wrapper::WrapBoundaryCandidate::len_utf8", "name": "len_utf8", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "text_system::line_wrapper", "path": "gpui::text_system::line_wrapper", "source": "crates/gpui/src/text_system/line_wrapper.rs", "summary": "", "documentation": "", "signature": "pub fn len_utf8 (& self) -> usize", "cfg": [], "target": "WrapBoundaryCandidate" }, { "id": "gpui::text_system::reexport-1", "name": "font_fallbacks :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "", "documentation": "", "signature": "pub use font_fallbacks::*;", "cfg": [] }, { "id": "gpui::text_system::reexport-2", "name": "font_features :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "", "documentation": "", "signature": "pub use font_features::*;", "cfg": [] }, { "id": "gpui::text_system::reexport-3", "name": "line :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "", "documentation": "", "signature": "pub use line::*;", "cfg": [] }, { "id": "gpui::text_system::reexport-4", "name": "line_layout :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "", "documentation": "", "signature": "pub use line_layout::*;", "cfg": [] }, { "id": "gpui::text_system::reexport-5", "name": "line_wrapper :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "text_system", "path": "gpui::text_system", "source": "crates/gpui/src/text_system.rs", "summary": "", "documentation": "", "signature": "pub use line_wrapper::*;", "cfg": [] }, { "id": "gpui::util::FluentBuilder", "name": "FluentBuilder", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "util", "path": "gpui::util", "source": "crates/gpui/src/util.rs", "summary": "A helper trait for building complex objects with imperative conditionals in a fluent style.", "documentation": "A helper trait for building complex objects with imperative conditionals in a fluent style.", "signature": "# [doc = \" A helper trait for building complex objects with imperative conditionals in a fluent style.\"] pub trait FluentBuilder { # [doc = \" Imperatively modify self with the given closure.\"] fn map (self, f : impl FnOnce (Self) -> U) -> U where Self : Sized, { f (self) } # [doc = \" Conditionally modify self with the given closure.\"] fn when (self, condition : bool, then : impl FnOnce (Self) -> Self) -> Self where Self : Sized, { self . map (| this | if condition { then (this) } else { this }) } # [doc = \" Conditionally modify self with the given closure.\"] fn when_else (self, condition : bool, then : impl FnOnce (Self) -> Self, else_fn : impl FnOnce (Self) -> Self,) -> Self where Self : Sized, { self . map (| this | if condition { then (this) } else { else_fn (this) }) } # [doc = \" Conditionally unwrap and modify self with the given closure, if the given option is Some.\"] fn when_some (self, option : Option, then : impl FnOnce (Self, T) -> Self) -> Self where Self : Sized, { self . map (| this | { if let Some (value) = option { then (this, value) } else { this } }) } # [doc = \" Conditionally unwrap and modify self with the given closure, if the given option is None.\"] fn when_none (self, option : & Option, then : impl FnOnce (Self) -> Self) -> Self where Self : Sized, { self . map (| this | if option . is_some () { this } else { then (this) }) } }", "cfg": [] }, { "id": "gpui::util::FutureExt", "name": "FutureExt", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "util", "path": "gpui::util", "source": "crates/gpui/src/util.rs", "summary": "Extensions for Future types that provide additional combinators and utilities.", "documentation": "Extensions for Future types that provide additional combinators and utilities.", "signature": "# [doc = \" Extensions for Future types that provide additional combinators and utilities.\"] pub trait FutureExt { # [doc = \" Requires a Future to complete before the specified duration has elapsed.\"] # [doc = \" Similar to tokio::timeout.\"] fn with_timeout (self, timeout : Duration, executor : & BackgroundExecutor) -> WithTimeout where Self : Sized; }", "cfg": [] }, { "id": "gpui::util::Timeout", "name": "Timeout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "util", "path": "gpui::util", "source": "crates/gpui/src/util.rs", "summary": "Error returned by with_timeout when the timeout duration elapsed before the future resolved", "documentation": "Error returned by with_timeout when the timeout duration elapsed before the future resolved", "signature": "# [derive (Debug, thiserror::Error)] # [error (\"Timed out before future resolved\")] # [doc = \" Error returned by with_timeout when the timeout duration elapsed before the future resolved\"] pub struct Timeout;", "cfg": [] }, { "id": "gpui::util::WithTimeout", "name": "WithTimeout", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "util", "path": "gpui::util", "source": "crates/gpui/src/util.rs", "summary": "", "documentation": "", "signature": "# [pin_project::pin_project] pub struct WithTimeout { # [pin] future : T, # [pin] timer : Task<()>, }", "cfg": [] }, { "id": "gpui::view::AnyView", "name": "AnyView", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "A dynamically-typed view handle that can be downcast to a specific `Entity`.", "documentation": "A dynamically-typed view handle that can be downcast to a specific `Entity`.\n\nThis is the type-erased counterpart to [`ViewElement`]: it holds an entity plus\na function pointer to its render, and is itself a [`View`], so embedding it as an\nelement goes through the same [`ViewElement`] machinery as any other view.", "signature": "# [doc = \" A dynamically-typed view handle that can be downcast to a specific `Entity`.\"] # [doc = \"\"] # [doc = \" This is the type-erased counterpart to [`ViewElement`]: it holds an entity plus\"] # [doc = \" a function pointer to its render, and is itself a [`View`], so embedding it as an\"] # [doc = \" element goes through the same [`ViewElement`] machinery as any other view.\"] # [derive (Clone, Debug)] pub struct AnyView { entity : AnyEntity, render : fn (& AnyView, & mut Window, & mut App) -> AnyElement, }", "cfg": [] }, { "id": "gpui::view::AnyView::cached", "name": "cached", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Embed this view as a cached [`ViewElement`] laid out at `style`.", "documentation": "Embed this view as a cached [`ViewElement`] laid out at `style`.\n\nThe rendered subtree is recycled from the previous frame unless\n[Context::notify] was called on the backing entity since it was rendered\n(or [Window::refresh] is called, which ignores caching).", "signature": "pub fn cached (self, style : StyleRefinement) -> ViewElement", "cfg": [], "target": "AnyView" }, { "id": "gpui::view::AnyView::downcast", "name": "downcast", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Convert this to a [Entity] of a specific type. If this handle does not contain a view of the specified type, returns itself in an `Err` variant.", "documentation": "Convert this to a [Entity] of a specific type.\nIf this handle does not contain a view of the specified type, returns itself in an `Err` variant.", "signature": "pub fn downcast (self) -> Result, Self>", "cfg": [], "target": "AnyView" }, { "id": "gpui::view::AnyView::downgrade", "name": "downgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Convert this to a weak handle.", "documentation": "Convert this to a weak handle.", "signature": "pub fn downgrade (& self) -> AnyWeakView", "cfg": [], "target": "AnyView" }, { "id": "gpui::view::AnyView::entity_id", "name": "entity_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "The [`EntityId`] of this view.", "documentation": "The [`EntityId`] of this view.", "signature": "pub fn entity_id (& self) -> EntityId", "cfg": [], "target": "AnyView" }, { "id": "gpui::view::AnyView::entity_type", "name": "entity_type", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Gets the [TypeId] of the underlying view.", "documentation": "Gets the [TypeId] of the underlying view.", "signature": "pub fn entity_type (& self) -> TypeId", "cfg": [], "target": "AnyView" }, { "id": "gpui::view::AnyWeakView", "name": "AnyWeakView", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "A weak, dynamically-typed view handle.", "documentation": "A weak, dynamically-typed view handle.", "signature": "# [doc = \" A weak, dynamically-typed view handle.\"] pub struct AnyWeakView { entity : AnyWeakEntity, render : fn (& AnyView, & mut Window, & mut App) -> AnyElement, }", "cfg": [] }, { "id": "gpui::view::AnyWeakView::upgrade", "name": "upgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Upgrade to a strong `AnyView` handle, if the view is still alive.", "documentation": "Upgrade to a strong `AnyView` handle, if the view is still alive.", "signature": "pub fn upgrade (& self) -> Option", "cfg": [], "target": "AnyWeakView" }, { "id": "gpui::view::EmptyView", "name": "EmptyView", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "A view that renders nothing", "documentation": "A view that renders nothing", "signature": "# [doc = \" A view that renders nothing\"] pub struct EmptyView;", "cfg": [] }, { "id": "gpui::view::Entity::cached", "name": "cached", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Embed this entity as a cached [`ViewElement`] laid out at `style`.", "documentation": "Embed this entity as a cached [`ViewElement`] laid out at `style`.\n\nThe rendered subtree is reused until the entity is notified (or the\ncached bounds / text style change). Caching requires a definite size:\na cached view is laid out from `style` and is *not* measured from its\ncontents. Use [`ViewElement::new`] (or `.child(entity)`) for the\nuncached case.", "signature": "pub fn cached (self, style : StyleRefinement) -> ViewElement>", "cfg": [], "target": "Entity" }, { "id": "gpui::view::View", "name": "View", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "A renderable that participates in GPUI's reactive graph — the unifying model behind [`Render`] and [`RenderOnce`].", "documentation": "A renderable that participates in GPUI's reactive graph — the unifying model\nbehind [`Render`] and [`RenderOnce`].\n\nWhen `entity_id()` returns `Some`, that id becomes the view's identity: it gets\na unique element-id space (so internal `use_state` / `.id(..)` never collide\nacross siblings) and `cx.notify()` on that entity re-renders only this view's\nsubtree. `None` behaves like a stateless component.\n\nYou rarely implement `View` directly. `Entity` and any `T: RenderOnce`\nget a blanket impl below; implement it by hand only when a component needs both\nparent-supplied props *and* a backing entity for identity.", "signature": "# [doc = \" A renderable that participates in GPUI's reactive graph — the unifying model\"] # [doc = \" behind [`Render`] and [`RenderOnce`].\"] # [doc = \"\"] # [doc = \" When `entity_id()` returns `Some`, that id becomes the view's identity: it gets\"] # [doc = \" a unique element-id space (so internal `use_state` / `.id(..)` never collide\"] # [doc = \" across siblings) and `cx.notify()` on that entity re-renders only this view's\"] # [doc = \" subtree. `None` behaves like a stateless component.\"] # [doc = \"\"] # [doc = \" You rarely implement `View` directly. `Entity` and any `T: RenderOnce`\"] # [doc = \" get a blanket impl below; implement it by hand only when a component needs both\"] # [doc = \" parent-supplied props *and* a backing entity for identity.\"] pub trait View : 'static + Sized { # [doc = \" This view's identity, if it has one. A view typically holds the backing\"] # [doc = \" entity as a field and returns its [`EntityId`] here.\"] # [doc = \"\"] # [doc = \" The id becomes this view's [`ElementId`], so two views keyed on the same\"] # [doc = \" entity must not be rendered at the same position in the element tree\"] # [doc = \" (e.g. as siblings under the same parent): their internal element state\"] # [doc = \" (`use_state`, scroll offsets, etc.) would silently collide. Nesting is\"] # [doc = \" fine — the id is scoped by the parent path.\"] fn entity_id (& self) -> Option; # [doc = \" Render this view into an element tree, consuming `self`.\"] fn render (self, window : & mut Window, cx : & mut App) -> impl IntoElement; }", "cfg": [] }, { "id": "gpui::view::ViewElement", "name": "ViewElement", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "The element type for [`View`] implementations. Wraps a `View` and hooks it into layout, prepaint, and paint. Constructed via [`ViewElement::new`].", "documentation": "The element type for [`View`] implementations. Wraps a `View` and hooks it\ninto layout, prepaint, and paint. Constructed via [`ViewElement::new`].", "signature": "# [doc = \" The element type for [`View`] implementations. Wraps a `View` and hooks it\"] # [doc = \" into layout, prepaint, and paint. Constructed via [`ViewElement::new`].\"] # [doc (hidden)] pub struct ViewElement { view : Option, entity_id : Option, cached_style : Option, # [cfg (debug_assertions)] source : & 'static core::panic::Location<'static>, }", "cfg": [] }, { "id": "gpui::view::ViewElement::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "view", "path": "gpui::view", "source": "crates/gpui/src/view.rs", "summary": "Wrap a [`View`] as an element.", "documentation": "Wrap a [`View`] as an element.", "signature": "pub fn new (view : V) -> Self", "cfg": [], "target": "ViewElement" }, { "id": "gpui::visual_transform::VisualTransform", "name": "VisualTransform", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "A positive uniform scale and translation from layout/window coordinates to displayed window coordinates. Events remain displayed window coordinates. Capture this value during prepaint for later event handlers and semantic measurement; do not read the current scope from an asynchronous handler.", "documentation": "A positive uniform scale and translation from layout/window coordinates to\ndisplayed window coordinates. Events remain displayed window coordinates.\nCapture this value during prepaint for later event handlers and semantic\nmeasurement; do not read the current scope from an asynchronous handler.", "signature": "# [doc = \" A positive uniform scale and translation from layout/window coordinates to\"] # [doc = \" displayed window coordinates. Events remain displayed window coordinates.\"] # [doc = \" Capture this value during prepaint for later event handlers and semantic\"] # [doc = \" measurement; do not read the current scope from an asynchronous handler.\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct VisualTransform { scale : f32, offset : Point, }", "cfg": [] }, { "id": "gpui::visual_transform::VisualTransform::compose", "name": "compose", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Apply `inner` first, then this transform. Nested origins are therefore expressed in the same unscaled layout coordinates as descendant bounds.", "documentation": "Apply `inner` first, then this transform. Nested origins are therefore\nexpressed in the same unscaled layout coordinates as descendant bounds.", "signature": "pub fn compose (self, inner : Self) -> Self", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::visual_transform::VisualTransform::map_bounds", "name": "map_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Displayed bounds for semantic measurement and accessibility. Layout callbacks still receive original bounds; this never requests new layout.", "documentation": "Displayed bounds for semantic measurement and accessibility. Layout\ncallbacks still receive original bounds; this never requests new layout.", "signature": "pub fn map_bounds (self, bounds : Bounds) -> Bounds", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::visual_transform::VisualTransform::map_point", "name": "map_point", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Map a layout point to displayed window coordinates.", "documentation": "Map a layout point to displayed window coordinates.", "signature": "pub fn map_point (self, point : Point) -> Point", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::visual_transform::VisualTransform::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Effective uniform raster/length multiplier, excluding display DPI.", "documentation": "Effective uniform raster/length multiplier, excluding display DPI.", "signature": "pub fn scale (self) -> f32", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::visual_transform::VisualTransform::scale_about", "name": "scale_about", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Scale about an origin in the enclosing scope's untransformed window coordinates. Zero, negative and nonfinite scales/origins are refused.", "documentation": "Scale about an origin in the enclosing scope's untransformed window\ncoordinates. Zero, negative and nonfinite scales/origins are refused.", "signature": "pub fn scale_about (scale : f32, origin : Point) -> Self", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::visual_transform::VisualTransform::unmap_bounds", "name": "unmap_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Convert an enclosing displayed rectangle into this scope's coordinates.", "documentation": "Convert an enclosing displayed rectangle into this scope's coordinates.", "signature": "pub fn unmap_bounds (self, bounds : Bounds) -> Bounds", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::visual_transform::VisualTransform::unmap_point", "name": "unmap_point", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "visual_transform", "path": "gpui::visual_transform", "source": "crates/gpui/src/visual_transform.rs", "summary": "Map a window-global event position back to this scope's layout coordinates.", "documentation": "Map a window-global event position back to this scope's layout coordinates.", "signature": "pub fn unmap_point (self, point : Point) -> Point", "cfg": [], "target": "VisualTransform" }, { "id": "gpui::window::AnyWindowHandle", "name": "AnyWindowHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A handle to a window with any root view type, which can be downcast to a window with a specific root view type.", "documentation": "A handle to a window with any root view type, which can be downcast to a window with a specific root view type.", "signature": "# [doc = \" A handle to a window with any root view type, which can be downcast to a window with a specific root view type.\"] # [derive (Copy, Clone, PartialEq, Eq, Hash, Debug)] pub struct AnyWindowHandle { pub (crate) id : WindowId, state_type : TypeId, }", "cfg": [] }, { "id": "gpui::window::AnyWindowHandle::downcast", "name": "downcast", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Attempt to convert this handle to a window handle with a specific root view type. If the types do not match, this will return `None`.", "documentation": "Attempt to convert this handle to a window handle with a specific root view type.\nIf the types do not match, this will return `None`.", "signature": "pub fn downcast (& self) -> Option>", "cfg": [], "target": "AnyWindowHandle" }, { "id": "gpui::window::AnyWindowHandle::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Read the state of the root view of this window.", "documentation": "Read the state of the root view of this window.\n\nThis will fail if the window has been closed.", "signature": "pub fn read (self, cx : & C, read : impl FnOnce (Entity, & App) -> R) -> Result where C : AppContext, T : 'static,", "cfg": [], "target": "AnyWindowHandle" }, { "id": "gpui::window::AnyWindowHandle::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the state of the root view of this window.", "documentation": "Updates the state of the root view of this window.\n\nThis will fail if the window has been closed.", "signature": "pub fn update (self, cx : & mut C, update : impl FnOnce (AnyView, & mut Window, & mut App) -> R,) -> Result where C : AppContext,", "cfg": [], "target": "AnyWindowHandle" }, { "id": "gpui::window::AnyWindowHandle::window_id", "name": "window_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Get the ID of this window.", "documentation": "Get the ID of this window.", "signature": "pub fn window_id (& self) -> WindowId", "cfg": [], "target": "AnyWindowHandle" }, { "id": "gpui::window::ArenaClearNeeded", "name": "ArenaClearNeeded", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returned when the element arena has been used and so must be cleared before the next draw.", "documentation": "Returned when the element arena has been used and so must be cleared before the next draw.", "signature": "# [doc = \" Returned when the element arena has been used and so must be cleared before the next draw.\"] # [must_use] pub struct ArenaClearNeeded { # [doc = \" Identity of the arena that was drawn into. Only ever compared against\"] # [doc = \" another pointer in `clear`; never dereferenced.\"] arena : * const RefCell, }", "cfg": [] }, { "id": "gpui::window::ArenaClearNeeded::clear", "name": "clear", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Clear the element arena of the App the draw ran against. If an enclosing draw is still in progress (this draw was nested inside it), the clear is deferred to the enclosing draw's own `ArenaClearNeeded` so that its live allocations aren't freed.", "documentation": "Clear the element arena of the App the draw ran against. If an enclosing\ndraw is still in progress (this draw was nested inside it), the clear is\ndeferred to the enclosing draw's own `ArenaClearNeeded` so that its live\nallocations aren't freed.\n\nPanics if passed a different App than the draw ran against, since\nclearing another App's arena could free memory its draws still\nreference.", "signature": "pub fn clear (self, cx : & mut App)", "cfg": [], "target": "ArenaClearNeeded" }, { "id": "gpui::window::ContentMask", "name": "ContentMask", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Indicates which region of the window is visible. Content falling outside of this mask will not be rendered. Currently, only rectangular content masks are supported, but we give the mask its own type to leave room to support more complex shapes in the future.", "documentation": "Indicates which region of the window is visible. Content falling outside of this mask will not be\nrendered. Currently, only rectangular content masks are supported, but we give the mask its own type\nto leave room to support more complex shapes in the future.", "signature": "# [doc = \" Indicates which region of the window is visible. Content falling outside of this mask will not be\"] # [doc = \" rendered. Currently, only rectangular content masks are supported, but we give the mask its own type\"] # [doc = \" to leave room to support more complex shapes in the future.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] # [repr (C)] pub struct ContentMask

{ # [doc = \" The bounds\"] pub bounds : Bounds

, }", "cfg": [] }, { "id": "gpui::window::ContentMask::intersect", "name": "intersect", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Intersect the content mask with the given content mask.", "documentation": "Intersect the content mask with the given content mask.", "signature": "pub fn intersect (& self, other : & Self) -> Self", "cfg": [], "target": "ContentMask" }, { "id": "gpui::window::ContentMask::scale", "name": "scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Scale the content mask's pixel units by the given scaling factor.", "documentation": "Scale the content mask's pixel units by the given scaling factor.", "signature": "pub fn scale (& self, factor : f32) -> ContentMask", "cfg": [], "target": "ContentMask" }, { "id": "gpui::window::DEFAULT_ADDITIONAL_WINDOW_SIZE", "name": "DEFAULT_ADDITIONAL_WINDOW_SIZE", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A 6:5 aspect ratio minimum window size to be used for functional, additional-to-main-Zed windows, like the settings and rules library windows.", "documentation": "A 6:5 aspect ratio minimum window size to be used for functional,\nadditional-to-main-Zed windows, like the settings and rules library windows.", "signature": "pub const DEFAULT_ADDITIONAL_WINDOW_SIZE: Size", "cfg": [] }, { "id": "gpui::window::DEFAULT_WINDOW_SIZE", "name": "DEFAULT_WINDOW_SIZE", "kind": "constant", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Default window size used when no explicit size is provided.", "documentation": "Default window size used when no explicit size is provided.", "signature": "pub const DEFAULT_WINDOW_SIZE: Size", "cfg": [] }, { "id": "gpui::window::DismissEvent", "name": "DismissEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Emitted by implementers of [`ManagedView`] to indicate the view should be dismissed, such as when a view is presented as a modal.", "documentation": "Emitted by implementers of [`ManagedView`] to indicate the view should be dismissed, such as when a view is presented as a modal.", "signature": "# [doc = \" Emitted by implementers of [`ManagedView`] to indicate the view should be dismissed, such as when a view is presented as a modal.\"] pub struct DismissEvent;", "cfg": [] }, { "id": "gpui::window::DispatchEventResult", "name": "DispatchEventResult", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Debug, Default, PartialEq, Eq)] # [expect (missing_docs)] pub struct DispatchEventResult { pub propagate : bool, pub default_prevented : bool, }", "cfg": [] }, { "id": "gpui::window::DispatchPhase", "name": "DispatchPhase", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Represents the two different phases when dispatching events.", "documentation": "Represents the two different phases when dispatching events.", "signature": "# [doc = \" Represents the two different phases when dispatching events.\"] # [derive (Default, Copy, Clone, Debug, Eq, PartialEq)] pub enum DispatchPhase { # [doc = \" After the capture phase comes the bubble phase, in which mouse event listeners are\"] # [doc = \" invoked front to back and keyboard event listeners are invoked from the focused element\"] # [doc = \" to the root of the element tree. This is the phase you'll most commonly want to use when\"] # [doc = \" registering event listeners.\"] # [default] Bubble, # [doc = \" During the initial capture phase, mouse event listeners are invoked back to front, and keyboard\"] # [doc = \" listeners are invoked from the root of the tree downward toward the focused element. This phase\"] # [doc = \" is used for special purposes such as clearing the \\\"pressed\\\" state for click events. If\"] # [doc = \" you stop event propagation during this phase, you need to know what you're doing. Handlers\"] # [doc = \" outside of the immediate region may rely on detecting non-local events during this phase.\"] Capture, }", "cfg": [] }, { "id": "gpui::window::DispatchPhase::bubble", "name": "bubble", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns true if this represents the \"bubble\" phase.", "documentation": "Returns true if this represents the \"bubble\" phase.", "signature": "pub fn bubble (self) -> bool", "cfg": [], "target": "DispatchPhase" }, { "id": "gpui::window::DispatchPhase::capture", "name": "capture", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns true if this represents the \"capture\" phase.", "documentation": "Returns true if this represents the \"capture\" phase.", "signature": "pub fn capture (self) -> bool", "cfg": [], "target": "DispatchPhase" }, { "id": "gpui::window::EdgeFade", "name": "EdgeFade", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A scoped vertical edge fade (see [`Window::with_edge_fade`]): primitives painted inside the scope get their opacity multiplied by a ramp that runs from 0 at an active edge of `bounds` to 1 a `band` further in. Built for scroll-edge fades over translucent/blurred window backgrounds, where a backdrop-colored gradient overlay cannot exist (there is no paintable color equal to \"what is behind the window\").", "documentation": "A scoped vertical edge fade (see [`Window::with_edge_fade`]): primitives\npainted inside the scope get their opacity multiplied by a ramp that runs\nfrom 0 at an active edge of `bounds` to 1 a `band` further in. Built for\nscroll-edge fades over translucent/blurred window backgrounds, where a\nbackdrop-colored gradient overlay cannot exist (there is no paintable\ncolor equal to \"what is behind the window\").", "signature": "# [doc = \" A scoped vertical edge fade (see [`Window::with_edge_fade`]): primitives\"] # [doc = \" painted inside the scope get their opacity multiplied by a ramp that runs\"] # [doc = \" from 0 at an active edge of `bounds` to 1 a `band` further in. Built for\"] # [doc = \" scroll-edge fades over translucent/blurred window backgrounds, where a\"] # [doc = \" backdrop-colored gradient overlay cannot exist (there is no paintable\"] # [doc = \" color equal to \\\"what is behind the window\\\").\"] # [derive (Clone, Copy, Debug, PartialEq)] pub struct EdgeFade { # [doc = \" The faded region, in window coordinates.\"] pub bounds : Bounds, # [doc = \" Ramp height inside each active edge.\"] pub band : Pixels, # [doc = \" Fade primitives approaching the region's top edge.\"] pub top : bool, # [doc = \" Fade primitives approaching the region's bottom edge.\"] pub bottom : bool, # [doc = \" Fade primitives approaching the region's left edge.\"] pub left : bool, # [doc = \" Fade primitives approaching the region's right edge.\"] pub right : bool, }", "cfg": [] }, { "id": "gpui::window::ElementId", "name": "ElementId", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "An identifier for an [`Element`].", "documentation": "An identifier for an [`Element`].\n\nCan be constructed with a string, a number, or both, as well\nas other internal representations.", "signature": "# [doc = \" An identifier for an [`Element`].\"] # [doc = \"\"] # [doc = \" Can be constructed with a string, a number, or both, as well\"] # [doc = \" as other internal representations.\"] # [derive (Clone, Debug, Eq, PartialEq, Hash)] pub enum ElementId { # [doc = \" The ID of a View element\"] View (EntityId), # [doc = \" An integer ID.\"] Integer (u64), # [doc = \" A string based ID.\"] Name (SharedString), # [doc = \" A UUID.\"] Uuid (Uuid), # [doc = \" An ID that's equated with a focus handle.\"] FocusHandle (FocusId), # [doc = \" A combination of a name and an integer.\"] NamedInteger (SharedString, u64), # [doc = \" A path.\"] Path (Arc), # [doc = \" A code location.\"] CodeLocation (core::panic::Location<'static>), # [doc = \" A labeled child of an element.\"] NamedChild (Arc, SharedString), # [doc = \" A byte array ID (used for text-anchors)\"] OpaqueId ([u8; 20]), }", "cfg": [] }, { "id": "gpui::window::ElementId::named_usize", "name": "named_usize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Constructs an `ElementId::NamedInteger` from a name and `usize`.", "documentation": "Constructs an `ElementId::NamedInteger` from a name and `usize`.", "signature": "pub fn named_usize (name : impl Into, integer : usize) -> ElementId", "cfg": [], "target": "ElementId" }, { "id": "gpui::window::FocusHandle", "name": "FocusHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A handle which can be used to track and manipulate the focused element in a window.", "documentation": "A handle which can be used to track and manipulate the focused element in a window.", "signature": "# [doc = \" A handle which can be used to track and manipulate the focused element in a window.\"] pub struct FocusHandle { pub (crate) id : FocusId, handles : Arc, # [doc = \" The index of this element in the tab order.\"] pub tab_index : isize, # [doc = \" Whether this element can be focused by tab navigation.\"] pub tab_stop : bool, }", "cfg": [] }, { "id": "gpui::window::FocusHandle::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether this handle contains the given handle in the most recently rendered frame.", "documentation": "Obtains whether this handle contains the given handle in the most recently rendered frame.", "signature": "pub fn contains (& self, other : & Self, window : & Window) -> bool", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::contains_focused", "name": "contains_focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether the element associated with this handle contains the focused element or is itself focused.", "documentation": "Obtains whether the element associated with this handle contains the focused\nelement or is itself focused.", "signature": "pub fn contains_focused (& self, window : & Window, cx : & App) -> bool", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::dispatch_action", "name": "dispatch_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Dispatch an action on the element that rendered this focus handle", "documentation": "Dispatch an action on the element that rendered this focus handle", "signature": "pub fn dispatch_action (& self, action : & dyn Action, window : & mut Window, cx : & mut App)", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::downgrade", "name": "downgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Converts this focus handle into a weak variant, which does not prevent it from being released.", "documentation": "Converts this focus handle into a weak variant, which does not prevent it from being released.", "signature": "pub fn downgrade (& self) -> WeakFocusHandle", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::focus", "name": "focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Moves the focus to the element associated with this handle.", "documentation": "Moves the focus to the element associated with this handle.", "signature": "pub fn focus (& self, window : & mut Window, cx : & mut App)", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::is_focused", "name": "is_focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether the element associated with this handle is currently focused.", "documentation": "Obtains whether the element associated with this handle is currently focused.", "signature": "pub fn is_focused (& self, window : & Window) -> bool", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::tab_index", "name": "tab_index", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the tab index of the element associated with this handle.", "documentation": "Sets the tab index of the element associated with this handle.", "signature": "pub fn tab_index (mut self, index : isize) -> Self", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::tab_stop", "name": "tab_stop", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets whether the element associated with this handle is a tab stop.", "documentation": "Sets whether the element associated with this handle is a tab stop.\n\nWhen `false`, the element will not be included in the tab order.", "signature": "pub fn tab_stop (mut self, tab_stop : bool) -> Self", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusHandle::within_focused", "name": "within_focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether the element associated with this handle is contained within the focused element or is itself focused.", "documentation": "Obtains whether the element associated with this handle is contained within the\nfocused element or is itself focused.", "signature": "pub fn within_focused (& self, window : & Window, cx : & mut App) -> bool", "cfg": [], "target": "FocusHandle" }, { "id": "gpui::window::FocusId::contains_focused", "name": "contains_focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether the element associated with this handle contains the focused element or is itself focused.", "documentation": "Obtains whether the element associated with this handle contains the focused\nelement or is itself focused.", "signature": "pub fn contains_focused (& self, window : & Window, cx : & App) -> bool", "cfg": [], "target": "FocusId" }, { "id": "gpui::window::FocusId::is_focused", "name": "is_focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether the element associated with this handle is currently focused.", "documentation": "Obtains whether the element associated with this handle is currently focused.", "signature": "pub fn is_focused (& self, window : & Window) -> bool", "cfg": [], "target": "FocusId" }, { "id": "gpui::window::FocusId::within_focused", "name": "within_focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtains whether the element associated with this handle is contained within the focused element or is itself focused.", "documentation": "Obtains whether the element associated with this handle is contained within the\nfocused element or is itself focused.", "signature": "pub fn within_focused (& self, window : & Window, cx : & App) -> bool", "cfg": [], "target": "FocusId" }, { "id": "gpui::window::FocusOutEvent", "name": "FocusOutEvent", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "This is provided when subscribing for `Context::on_focus_out` events.", "documentation": "This is provided when subscribing for `Context::on_focus_out` events.", "signature": "# [doc = \" This is provided when subscribing for `Context::on_focus_out` events.\"] pub struct FocusOutEvent { # [doc = \" A weak focus handle representing what was blurred.\"] pub blurred : WeakFocusHandle, }", "cfg": [] }, { "id": "gpui::window::Focusable", "name": "Focusable", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Focusable allows users of your view to easily focus it (using window.focus_view(cx, view))", "documentation": "Focusable allows users of your view to easily\nfocus it (using window.focus_view(cx, view))", "signature": "# [doc = \" Focusable allows users of your view to easily\"] # [doc = \" focus it (using window.focus_view(cx, view))\"] pub trait Focusable : 'static { # [doc = \" Returns the focus handle associated with this view.\"] fn focus_handle (& self, cx : & App) -> FocusHandle; }", "cfg": [] }, { "id": "gpui::window::Hitbox", "name": "Hitbox", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A rectangular region that potentially blocks hitboxes inserted prior. See [Window::insert_hitbox] for more details.", "documentation": "A rectangular region that potentially blocks hitboxes inserted prior.\nSee [Window::insert_hitbox] for more details.", "signature": "# [doc = \" A rectangular region that potentially blocks hitboxes inserted prior.\"] # [doc = \" See [Window::insert_hitbox] for more details.\"] # [derive (Clone, Debug, Deref)] pub struct Hitbox { # [doc = \" A unique identifier for the hitbox.\"] pub id : HitboxId, # [doc = \" The bounds of the hitbox.\"] # [deref] pub bounds : Bounds, # [doc = \" The content mask when the hitbox was inserted.\"] pub content_mask : ContentMask, # [doc = \" Rounded ancestor clips captured during prepaint.\"] pub clip_chain : crate::ClipChain, # [doc = \" Captured mapping for window-global pointer positions and semantic bounds.\"] pub visual_transform : crate::VisualTransform, # [doc = \" Flags that specify hitbox behavior.\"] pub behavior : HitboxBehavior, }", "cfg": [] }, { "id": "gpui::window::Hitbox::contains", "name": "contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Tests a window-global point against this hitbox and its inherited clips, without testing occlusion by later elements. `bounds` stays layout-space.", "documentation": "Tests a window-global point against this hitbox and its inherited clips,\nwithout testing occlusion by later elements. `bounds` stays layout-space.", "signature": "pub fn contains (& self, position : & Point) -> bool", "cfg": [], "target": "Hitbox" }, { "id": "gpui::window::Hitbox::displayed_bounds", "name": "displayed_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Displayed rectangle for semantic measurement. Rounded clipping may reject corners inside this conservative rectangle.", "documentation": "Displayed rectangle for semantic measurement. Rounded clipping may reject\ncorners inside this conservative rectangle.", "signature": "pub fn displayed_bounds (& self) -> Bounds", "cfg": [], "target": "Hitbox" }, { "id": "gpui::window::Hitbox::is_hovered", "name": "is_hovered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks if the hitbox is currently hovered. Returns `false` during keyboard input modality so that keyboard navigation suppresses hover highlights. Except when handling `ScrollWheelEvent`, this is typically what you want when determining whether to handle mouse events or paint hover styles.", "documentation": "Checks if the hitbox is currently hovered. Returns `false` during keyboard input modality\nso that keyboard navigation suppresses hover highlights. Except when handling\n`ScrollWheelEvent`, this is typically what you want when determining whether to handle mouse\nevents or paint hover styles.\n\nThis can return `false` even when the hitbox contains the mouse, if a hitbox in front of\nthis sets `HitboxBehavior::BlockMouse` (`InteractiveElement::occlude`) or\n`HitboxBehavior::BlockMouseExceptScroll` (`InteractiveElement::block_mouse_except_scroll`),\nor if the current input modality is keyboard (see [`Window::last_input_was_keyboard`]).\n\nHandling of `ScrollWheelEvent` should typically use `should_handle_scroll` instead.\nConcretely, this is due to use-cases like overlays that cause the elements under to be\nnon-interactive while still allowing scrolling. More abstractly, this is because\n`is_hovered` is about element interactions directly under the mouse - mouse moves, clicks,\nhover styling, etc. In contrast, scrolling is about finding the current outer scrollable\ncontainer.", "signature": "pub fn is_hovered (& self, window : & Window) -> bool", "cfg": [], "target": "Hitbox" }, { "id": "gpui::window::Hitbox::should_handle_scroll", "name": "should_handle_scroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks if the hitbox contains the mouse and should handle scroll events. Typically this should only be used when handling `ScrollWheelEvent`, and otherwise `is_hovered` should be used. See the documentation of `Hitbox::is_hovered` for details about this distinction.", "documentation": "Checks if the hitbox contains the mouse and should handle scroll events. Typically this\nshould only be used when handling `ScrollWheelEvent`, and otherwise `is_hovered` should be\nused. See the documentation of `Hitbox::is_hovered` for details about this distinction.\n\nThis can return `false` even when the hitbox contains the mouse, if a hitbox in front of\nthis sets `HitboxBehavior::BlockMouse` (`InteractiveElement::occlude`).", "signature": "pub fn should_handle_scroll (& self, window : & Window) -> bool", "cfg": [], "target": "Hitbox" }, { "id": "gpui::window::HitboxBehavior", "name": "HitboxBehavior", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "How the hitbox affects mouse behavior.", "documentation": "How the hitbox affects mouse behavior.", "signature": "# [doc = \" How the hitbox affects mouse behavior.\"] # [derive (Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum HitboxBehavior { # [doc = \" Normal hitbox mouse behavior, doesn't affect mouse handling for other hitboxes.\"] # [default] Normal, # [doc = \" All hitboxes behind this hitbox will be ignored and so will have `hitbox.is_hovered() ==\"] # [doc = \" false` and `hitbox.should_handle_scroll() == false`. Typically for elements this causes\"] # [doc = \" skipping of all mouse events, hover styles, and tooltips. This flag is set by\"] # [doc = \" [`InteractiveElement::occlude`].\"] # [doc = \"\"] # [doc = \" For mouse handlers that check those hitboxes, this behaves the same as registering a\"] # [doc = \" bubble-phase handler for every mouse event type:\"] # [doc = \"\"] # [doc = \" ```ignore\"] # [doc = \" window.on_mouse_event(move |_: &EveryMouseEventTypeHere, phase, window, cx| {\"] # [doc = \" if phase == DispatchPhase::Capture && hitbox.is_hovered(window) {\"] # [doc = \" cx.stop_propagation();\"] # [doc = \" }\"] # [doc = \" })\"] # [doc = \" ```\"] # [doc = \"\"] # [doc = \" This has effects beyond event handling - any use of hitbox checking, such as hover\"] # [doc = \" styles and tooltips. These other behaviors are the main point of this mechanism. An\"] # [doc = \" alternative might be to not affect mouse event handling - but this would allow\"] # [doc = \" inconsistent UI where clicks and moves interact with elements that are not considered to\"] # [doc = \" be hovered.\"] BlockMouse, # [doc = \" All hitboxes behind this hitbox will have `hitbox.is_hovered() == false`, even when\"] # [doc = \" `hitbox.should_handle_scroll() == true`. Typically for elements this causes all mouse\"] # [doc = \" interaction except scroll events to be ignored - see the documentation of\"] # [doc = \" [`Hitbox::is_hovered`] for details. This flag is set by\"] # [doc = \" [`InteractiveElement::block_mouse_except_scroll`].\"] # [doc = \"\"] # [doc = \" For mouse handlers that check those hitboxes, this behaves the same as registering a\"] # [doc = \" bubble-phase handler for every mouse event type **except** `ScrollWheelEvent`:\"] # [doc = \"\"] # [doc = \" ```ignore\"] # [doc = \" window.on_mouse_event(move |_: &EveryMouseEventTypeExceptScroll, phase, window, cx| {\"] # [doc = \" if phase == DispatchPhase::Bubble && hitbox.should_handle_scroll(window) {\"] # [doc = \" cx.stop_propagation();\"] # [doc = \" }\"] # [doc = \" })\"] # [doc = \" ```\"] # [doc = \"\"] # [doc = \" See the documentation of [`Hitbox::is_hovered`] for details of why `ScrollWheelEvent` is\"] # [doc = \" handled differently than other mouse events. If also blocking these scroll events is\"] # [doc = \" desired, then a `cx.stop_propagation()` handler like the one above can be used.\"] # [doc = \"\"] # [doc = \" This has effects beyond event handling - this affects any use of `is_hovered`, such as\"] # [doc = \" hover styles and tooltips. These other behaviors are the main point of this mechanism.\"] # [doc = \" An alternative might be to not affect mouse event handling - but this would allow\"] # [doc = \" inconsistent UI where clicks and moves interact with elements that are not considered to\"] # [doc = \" be hovered.\"] BlockMouseExceptScroll, }", "cfg": [] }, { "id": "gpui::window::HitboxId", "name": "HitboxId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "An identifier for a [Hitbox] which also includes [HitboxBehavior].", "documentation": "An identifier for a [Hitbox] which also includes [HitboxBehavior].", "signature": "# [doc = \" An identifier for a [Hitbox] which also includes [HitboxBehavior].\"] # [derive (Copy, Clone, Debug, Eq, PartialEq, Hash)] pub struct HitboxId (u64);", "cfg": [] }, { "id": "gpui::window::HitboxId::is_hovered", "name": "is_hovered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks if the hitbox with this ID is currently hovered. Returns `false` during keyboard input modality so that keyboard navigation suppresses hover highlights. Except when handling `ScrollWheelEvent`, this is typically what you want when determining whether to handle mouse events or paint hover styles.", "documentation": "Checks if the hitbox with this ID is currently hovered. Returns `false` during keyboard\ninput modality so that keyboard navigation suppresses hover highlights. Except when handling\n`ScrollWheelEvent`, this is typically what you want when determining whether to handle mouse\nevents or paint hover styles.\n\nSee [`Hitbox::is_hovered`] for details.", "signature": "pub fn is_hovered (self, window : & Window) -> bool", "cfg": [], "target": "HitboxId" }, { "id": "gpui::window::HitboxId::placeholder", "name": "placeholder", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A placeholder HitboxId exclusively for integration testing API's that need a hitbox but where the value of the hitbox does not matter. The alternative is to make the Hitbox optional but that complicates the implementation.", "documentation": "A placeholder HitboxId exclusively for integration testing API's that\nneed a hitbox but where the value of the hitbox does not matter. The\nalternative is to make the Hitbox optional but that complicates the\nimplementation.", "signature": "pub const fn placeholder () -> Self", "cfg": [], "target": "HitboxId" }, { "id": "gpui::window::HitboxId::should_handle_scroll", "name": "should_handle_scroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks if the hitbox with this ID contains the mouse and should handle scroll events. Typically this should only be used when handling `ScrollWheelEvent`, and otherwise `is_hovered` should be used. See the documentation of `Hitbox::is_hovered` for details about this distinction.", "documentation": "Checks if the hitbox with this ID contains the mouse and should handle scroll events.\nTypically this should only be used when handling `ScrollWheelEvent`, and otherwise\n`is_hovered` should be used. See the documentation of `Hitbox::is_hovered` for details about\nthis distinction.", "signature": "pub fn should_handle_scroll (self, window : & Window) -> bool", "cfg": [], "target": "HitboxId" }, { "id": "gpui::window::InputLatencySnapshot", "name": "InputLatencySnapshot", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A point-in-time snapshot of the input-latency histograms for a window, suitable for external formatting.", "documentation": "A point-in-time snapshot of the input-latency histograms for a window,\nsuitable for external formatting.", "signature": "# [doc = \" A point-in-time snapshot of the input-latency histograms for a window,\"] # [doc = \" suitable for external formatting.\"] # [cfg (feature = \"input-latency-histogram\")] # [derive (Clone)] pub struct InputLatencySnapshot { # [doc = \" Histogram of input-to-platform-submission latency samples, in\"] # [doc = \" nanoseconds.\"] pub latency_histogram : Histogram, # [doc = \" Histogram of input events coalesced per submitted frame.\"] pub events_per_frame_histogram : Histogram, # [doc = \" Count of input events that arrived mid-draw and were excluded from\"] # [doc = \" latency recording.\"] pub mid_draw_events_dropped : u64, }", "cfg": [ "cfg (feature = \"input-latency-histogram\")" ] }, { "id": "gpui::window::InputRateTracker::is_high_rate", "name": "is_high_rate", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn is_high_rate (& self) -> bool", "cfg": [], "target": "InputRateTracker" }, { "id": "gpui::window::InputRateTracker::record_input", "name": "record_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn record_input (& mut self)", "cfg": [], "target": "InputRateTracker" }, { "id": "gpui::window::ManagedView", "name": "ManagedView", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "ManagedView is a view (like a Modal, Popover, Menu, etc.) where the lifecycle of the view is handled by another view.", "documentation": "ManagedView is a view (like a Modal, Popover, Menu, etc.)\nwhere the lifecycle of the view is handled by another view.", "signature": "# [doc = \" ManagedView is a view (like a Modal, Popover, Menu, etc.)\"] # [doc = \" where the lifecycle of the view is handled by another view.\"] pub trait ManagedView : Focusable + EventEmitter + Render { }", "cfg": [] }, { "id": "gpui::window::PaintQuad", "name": "PaintQuad", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A rectangle to be rendered in the window at the given position and size. Passed as an argument [`Window::paint_quad`].", "documentation": "A rectangle to be rendered in the window at the given position and size.\nPassed as an argument [`Window::paint_quad`].", "signature": "# [doc = \" A rectangle to be rendered in the window at the given position and size.\"] # [doc = \" Passed as an argument [`Window::paint_quad`].\"] # [derive (Clone)] pub struct PaintQuad { # [doc = \" The bounds of the quad within the window.\"] pub bounds : Bounds, # [doc = \" The radii of the quad's corners.\"] pub corner_radii : Corners, # [doc = \" The background color of the quad.\"] pub background : Background, # [doc = \" The widths of the quad's borders.\"] pub border_widths : Edges, # [doc = \" The color of the quad's borders.\"] pub border_color : Hsla, # [doc = \" The style of the quad's borders.\"] pub border_style : BorderStyle, }", "cfg": [] }, { "id": "gpui::window::PaintQuad::background", "name": "background", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the background color of the quad.", "documentation": "Sets the background color of the quad.", "signature": "pub fn background (self, background : impl Into) -> Self", "cfg": [], "target": "PaintQuad" }, { "id": "gpui::window::PaintQuad::border_color", "name": "border_color", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the border color of the quad.", "documentation": "Sets the border color of the quad.", "signature": "pub fn border_color (self, border_color : impl Into) -> Self", "cfg": [], "target": "PaintQuad" }, { "id": "gpui::window::PaintQuad::border_widths", "name": "border_widths", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the border widths of the quad.", "documentation": "Sets the border widths of the quad.", "signature": "pub fn border_widths (self, border_widths : impl Into>) -> Self", "cfg": [], "target": "PaintQuad" }, { "id": "gpui::window::PaintQuad::corner_radii", "name": "corner_radii", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the corner radii of the quad.", "documentation": "Sets the corner radii of the quad.", "signature": "pub fn corner_radii (self, corner_radii : impl Into>) -> Self", "cfg": [], "target": "PaintQuad" }, { "id": "gpui::window::TooltipId", "name": "TooltipId", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "An identifier for a tooltip.", "documentation": "An identifier for a tooltip.", "signature": "# [doc = \" An identifier for a tooltip.\"] # [derive (Copy, Clone, Debug, Default, Eq, PartialEq)] pub struct TooltipId (usize);", "cfg": [] }, { "id": "gpui::window::TooltipId::is_hovered", "name": "is_hovered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks if the tooltip is currently hovered.", "documentation": "Checks if the tooltip is currently hovered.", "signature": "pub fn is_hovered (& self, window : & Window) -> bool", "cfg": [], "target": "TooltipId" }, { "id": "gpui::window::WeakFocusHandle", "name": "WeakFocusHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A weak reference to a focus handle.", "documentation": "A weak reference to a focus handle.", "signature": "# [doc = \" A weak reference to a focus handle.\"] # [derive (Clone, Debug)] pub struct WeakFocusHandle { pub (crate) id : FocusId, pub (crate) handles : Weak, }", "cfg": [] }, { "id": "gpui::window::WeakFocusHandle::upgrade", "name": "upgrade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Attempts to upgrade the [WeakFocusHandle] to a [FocusHandle].", "documentation": "Attempts to upgrade the [WeakFocusHandle] to a [FocusHandle].", "signature": "pub fn upgrade (& self) -> Option", "cfg": [], "target": "WeakFocusHandle" }, { "id": "gpui::window::Window", "name": "Window", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Holds the state for a specific window.", "documentation": "Holds the state for a specific window.", "signature": "# [doc = \" Holds the state for a specific window.\"] pub struct Window { pub (crate) handle : AnyWindowHandle, pub (crate) invalidator : WindowInvalidator, pub (crate) removed : bool, pub (crate) platform_window : Box, native_context_menu : Option<(crate::NativeMenuSessionId, bool)>, # [doc = \" Whether the platform accepted a transparent scene plane above native\"] # [doc = \" child views. This is window state rather than frame state: once native\"] # [doc = \" hosting creates the plane, every later deferred overlay uses it.\"] scene_overlay_enabled : Cell, # [doc = \" True only while painting primitives that will land on that transparent\"] # [doc = \" plane. Subpixel glyphs require a known opaque destination, so text in\"] # [doc = \" this phase must use grayscale antialiasing.\"] painting_transparent_overlay : bool, display_id : Option, is_resizable : bool, is_minimizable : bool, sprite_atlas : Arc, text_system : Arc, text_rendering_mode : Rc>, rem_size : Pixels, # [doc = \" The stack of override values for the window's rem size.\"] # [doc = \"\"] # [doc = \" This is used by `with_rem_size` to allow rendering an element tree with\"] # [doc = \" a given rem size.\"] rem_size_override_stack : SmallVec<[Pixels; 8]>, pub (crate) viewport_size : Size, layout_engine : Option, pub (crate) root : Option, pub (crate) element_id_stack : SmallVec<[ElementId; 32]>, pub (crate) text_style_stack : Vec, pub (crate) rendered_entity_stack : Vec, pub (crate) element_offset_stack : Vec>, element_placement_stack : Vec>, pub (crate) element_opacity : f32, pub (crate) edge_fade : Option, pub (crate) content_mask_stack : Vec>, pub (crate) clip_chain : crate::ClipChain, pub (crate) visual_transform : crate::VisualTransform, pub (crate) selection_scope_stack : Vec, # [doc = \" One selection that may span separately mounted text elements. It\"] # [doc = \" belongs to the window rather than to a global, so a closed window\"] # [doc = \" leaves nothing behind.\"] pub (crate) document_selection : crate::DocumentSelectionState, pub (crate) requested_autoscroll : Option>, pub (crate) image_cache_stack : Vec, pub (crate) rendered_frame : Frame, pub (crate) next_frame : Frame, platform_view_registry : PlatformViewRegistry, next_hitbox_id : HitboxId, pub (crate) next_tooltip_id : TooltipId, pub (crate) tooltip_bounds : Option, next_frame_callbacks : Rc>>, pub (crate) dirty_views : FxHashSet, focus_listeners : SubscriberSet<(), AnyWindowFocusListener>, pub (crate) focus_lost_listeners : SubscriberSet<(), AnyObserver>, default_prevented : bool, effect_owner : Rc>>, remaining_scroll_delta : Option, mouse_position : Point, mouse_hit_test : HitTest, modifiers : Modifiers, capslock : Capslock, scale_factor : f32, pub (crate) bounds_observers : SubscriberSet<(), AnyObserver>, appearance : WindowAppearance, pub (crate) appearance_observers : SubscriberSet<(), AnyObserver>, pub (crate) button_layout_observers : SubscriberSet<(), AnyObserver>, active : Rc>, hovered : Rc>, pub (crate) needs_present : Rc>, # [doc = \" Tracks recent input event timestamps to determine if input is arriving at a high rate.\"] # [doc = \" Used to selectively enable VRR optimization only when input rate exceeds 60fps.\"] pub (crate) input_rate_tracker : Rc>, frame_inputs : FrameInputAccumulator, pending_frame_timing : Option, # [cfg (feature = \"input-latency-histogram\")] input_latency_tracker : InputLatencyTracker, last_input_modality : InputModality, touch_gestures : TouchGestureRecognizer, touch_prediction_enabled : bool, long_press_timer : Option>, long_press_capture : Option, touch_pan_capture : Option, touch_pinch_capture : Option, touch_pinch_target : Option, touch_pinch_anchor : Option>, last_pinch_event : Option, text_input_state : Option<(FocusId, crate::TextInputOptions)>, pub (crate) refreshing : bool, pub (crate) activation_observers : SubscriberSet<(), AnyObserver>, pub (crate) focus : Option, focus_enabled : bool, # [doc = \" Whether a pointer press put focus where it currently is, rather than a\"] # [doc = \" tab stop, an action, or the application moving it. Read by\"] # [doc = \" focus-visible styling; see [`Window::focus_is_visible`].\"] focus_placed_by_pointer : bool, # [doc = \" Incremented every time focus moves. Used to invalidate a\"] # [doc = \" pending keyboard activation state when focus changes.\"] pub (crate) focus_generation : u64, pending_input : Option, pending_modifier : ModifierState, pub (crate) pending_input_observers : SubscriberSet<(), AnyObserver>, prompt : Option, pub (crate) client_inset : Option, # [doc = \" The hitbox that has captured the pointer, if any.\"] # [doc = \" While captured, mouse events route to this hitbox regardless of hit testing.\"] captured_hitbox : Option, # [doc = \" The stable identity behind `captured_hitbox`, when the capturing\"] # [doc = \" element has an id. This remaps capture to its replacement hitbox after\"] # [doc = \" a redraw.\"] captured_pointer_element : Option, captured_pointer_button : Option, # [cfg (any (feature = \"inspector\", debug_assertions))] inspector : Option>, pub (crate) a11y : A11y, current_frame_stats : profiler::FrameStats, completed_frame_stats : profiler::FrameStats, }", "cfg": [] }, { "id": "gpui::window::Window::activate_window", "name": "activate_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Focus the current window and bring it to the foreground at the platform level.", "documentation": "Focus the current window and bring it to the foreground at the platform level.", "signature": "pub fn activate_window (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::ambient_element_offset", "name": "ambient_element_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Offset due to scrolling and transient ancestor slides, excluding layout placement declared by `with_placed_element_offset`. Subtract this from an element's prepaint origin to sample its content-space layout position. Without a declared placement scope this equals `element_offset()`. This is prepaint metadata, not a separate rendering or hit-test transform.", "documentation": "Offset due to scrolling and transient ancestor slides, excluding layout\nplacement declared by `with_placed_element_offset`. Subtract this from\nan element's prepaint origin to sample its content-space layout position.\nWithout a declared placement scope this equals `element_offset()`.\nThis is prepaint metadata, not a separate rendering or hit-test transform.", "signature": "pub fn ambient_element_offset (& self) -> Point", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::appearance", "name": "appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the appearance of the current window.", "documentation": "Returns the appearance of the current window.", "signature": "pub fn appearance (& self) -> WindowAppearance", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::available_actions", "name": "available_actions", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns all available actions for the focused element.", "documentation": "Returns all available actions for the focused element.", "signature": "pub fn available_actions (& self, cx : & App) -> Vec>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::backdrop_luminance", "name": "backdrop_luminance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The mean luminance of the optical source a probed glass surface covered, in `0..=1`, or `None` while this lease holds no completed reading or was absent from the last submitted frame (including budget fallback). The source is sharp for clear glass and blurred for frost.", "documentation": "The mean luminance of the optical source a probed glass surface\ncovered, in `0..=1`, or `None` while this lease holds no completed\nreading or was absent from the last submitted frame (including budget\nfallback). The source is sharp for clear glass and blurred for frost.\n\nPass the opaque ID from a live [`crate::LuminanceProbeLease`], also set\nin [`crate::GlassMaterial::probe`], never its physical slot index. The\nrenderer copies the reading back without stalling the frame that took\nit, so the value describes the backdrop one frame ago: a caller that\nflips its own contrast on it must expect the flip to land a frame\nafter the backdrop moved, and `None` on any renderer that takes no\nprobes — the honest reading for a backdrop nobody measured.", "signature": "pub fn backdrop_luminance (& self, id : u32) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::backdrop_statistics", "name": "backdrop_statistics", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Statistics of the five sampled optical-source texels, not exhaustive backdrop extrema or linear-light measurements. See [`crate::BackdropStatistics`]. Pass a live [`crate::LuminanceProbeLease`] ID also set on the glass material. Availability and freshness match [`Self::backdrop_luminance`], including `None` for absent probes, budget fallback, and unsupported renderers. Collection preserves backend behavior: WGPU can wait for an outstanding map and DirectX can wait when mapping staging data; Metal reads its completion-populated cache. No additional GPU work is submitted here.", "documentation": "Statistics of the five sampled optical-source texels, not exhaustive\nbackdrop extrema or linear-light measurements. See [`crate::BackdropStatistics`].\nPass a live [`crate::LuminanceProbeLease`] ID also set on the glass material.\nAvailability and freshness match [`Self::backdrop_luminance`], including\n`None` for absent probes, budget fallback, and unsupported renderers.\nCollection preserves backend behavior: WGPU can wait for an outstanding\nmap and DirectX can wait when mapping staging data; Metal reads its\ncompletion-populated cache. No additional GPU work is submitted here.", "signature": "pub fn backdrop_statistics (& self, id : u32) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::bindings_for_action", "name": "bindings_for_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns key bindings that invoke an action on the currently focused element. Bindings are returned in the order they were added. For display, the last binding should take precedence.", "documentation": "Returns key bindings that invoke an action on the currently focused element. Bindings are\nreturned in the order they were added. For display, the last binding should take precedence.", "signature": "pub fn bindings_for_action (& self, action : & dyn Action) -> Vec", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::bindings_for_action_in", "name": "bindings_for_action_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns any bindings that would invoke an action on the given focus handle if it were focused. Bindings are returned in the order they were added. For display, the last binding should take precedence.", "documentation": "Returns any bindings that would invoke an action on the given focus handle if it were\nfocused. Bindings are returned in the order they were added. For display, the last binding\nshould take precedence.", "signature": "pub fn bindings_for_action_in (& self, action : & dyn Action, focus_handle : & FocusHandle,) -> Vec", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::bindings_for_action_in_context", "name": "bindings_for_action_in_context", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the key bindings for an action in a context.", "documentation": "Returns the key bindings for an action in a context.", "signature": "pub fn bindings_for_action_in_context (& self, action : & dyn Action, context : KeyContext,) -> Vec", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::blur", "name": "blur", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Remove focus from all elements within this context's window.", "documentation": "Remove focus from all elements within this context's window.", "signature": "pub fn blur (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::bounds", "name": "bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the bounds of the current window in the global coordinate space, which could span across multiple displays.", "documentation": "Returns the bounds of the current window in the global coordinate space, which could span across multiple displays.", "signature": "pub fn bounds (& self) -> Bounds", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::bounds_changed", "name": "bounds_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Notify the window that its bounds have changed.", "documentation": "Notify the window that its bounds have changed.\n\nThis updates internal state like `viewport_size` and `scale_factor` from\nthe platform window, then notifies observers. Normally called automatically\nby the platform's resize callback, but exposed publicly for test infrastructure.", "signature": "pub fn bounds_changed (& mut self, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::cancel_context_menu", "name": "cancel_context_menu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Invalidates this window's matching revision and requests native closure. `false` is an ended/stale/different native session; it cannot close a newer menu. Matching queued commands are invalidated even then. On refusal the revision remains invalidated but can be retried with the same identity. Await its completion before claiming native UI closure.", "documentation": "Invalidates this window's matching revision and requests native closure.\n`false` is an ended/stale/different native session; it cannot close a\nnewer menu. Matching queued commands are invalidated even then. On\nrefusal the revision remains invalidated but can be retried with the\nsame identity. Await its completion before claiming native UI closure.", "signature": "pub fn cancel_context_menu (& mut self, session : crate::NativeMenuSessionId,) -> Result", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::cancel_touch_input", "name": "cancel_touch_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Cancel every portable touch gesture, native pinch, pending long press and fling. Called automatically when the platform reports inactive. Backends must report inactive before suspending input or destroying the surface, even if no fingers remain. Hosts may call this before removing a gesture owner. Cancellation never synthesizes a release, click, or commit.", "documentation": "Cancel every portable touch gesture, native pinch, pending long press and fling.\nCalled automatically when the platform reports inactive. Backends must\nreport inactive before suspending input or destroying the surface, even\nif no fingers remain. Hosts may call this before removing a gesture\nowner. Cancellation never synthesizes a release, click, or commit.", "signature": "pub fn cancel_touch_input (& mut self, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::capslock", "name": "capslock", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The current state of the keyboard's capslock", "documentation": "The current state of the keyboard's capslock", "signature": "pub fn capslock (& self) -> Capslock", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::capture_long_press", "name": "capture_long_press", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Captures the current long press for the given entity.", "documentation": "Captures the current long press for the given entity.\n\nThe capture is released when the gesture ends or is cancelled, or when\na replacement touch begins. A listener must also call\n[`Self::prevent_default`] on the started event to claim the gesture.", "signature": "pub fn capture_long_press (& mut self, entity : & Entity)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::capture_pointer", "name": "capture_pointer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Captures the pointer for the given hitbox. While captured, all mouse move and mouse up events will be routed to listeners that check this hitbox's `is_hovered` status, regardless of actual hit testing. This enables drag operations that continue even when the pointer moves outside the element's bounds.", "documentation": "Captures the pointer for the given hitbox. While captured, all mouse move and mouse up\nevents will be routed to listeners that check this hitbox's `is_hovered` status,\nregardless of actual hit testing. This enables drag operations that continue\neven when the pointer moves outside the element's bounds.\n\nThis legacy unbound capture releases on any mouse up or cancellation.\nPrefer [`Self::capture_pointer_for_button`] for a button-owned gesture.\nA capture whose hitbox disappears on redraw is cancelled. Stable element\nids preserve capture across rebuilt or cached frames, not across unmount.", "signature": "pub fn capture_pointer (& mut self, hitbox_id : HitboxId)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::capture_pointer_for_button", "name": "capture_pointer_for_button", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Captures until the specified button is released, or the stream is cancelled. Other buttons' releases do not terminate this gesture.", "documentation": "Captures until the specified button is released, or the stream is\ncancelled. Other buttons' releases do not terminate this gesture.", "signature": "pub fn capture_pointer_for_button (& mut self, hitbox_id : HitboxId, button : MouseButton)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::captured_hitbox", "name": "captured_hitbox", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the hitbox that has captured the pointer, if any.", "documentation": "Returns the hitbox that has captured the pointer, if any.", "signature": "pub fn captured_hitbox (& self) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::clear_document_selection", "name": "clear_document_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Forgets the document selection.", "documentation": "Forgets the document selection.", "signature": "pub fn clear_document_selection (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::client_inset", "name": "client_inset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the client_inset value by [`Self::set_client_inset`].", "documentation": "Returns the client_inset value by [`Self::set_client_inset`].", "signature": "pub fn client_inset (& self) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::compute_layout", "name": "compute_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Compute the layout for the given id within the given available space. This method is called for its side effect, typically by the framework prior to painting. After calling it, you can request the bounds of the given layout node id or any descendant.", "documentation": "Compute the layout for the given id within the given available space.\nThis method is called for its side effect, typically by the framework prior to painting.\nAfter calling it, you can request the bounds of the given layout node id or any descendant.\n\nThis method should only be called as part of the prepaint phase of element drawing.", "signature": "pub fn compute_layout (& mut self, layout_id : LayoutId, available_space : Size, cx : & mut App,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::compute_layout_with_size", "name": "compute_layout_with_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Compute a root with assigned border-box dimensions for this invocation. Authored root size/min/max/aspect-ratio are temporarily overridden; descendants reflow normally. Padding/borders and device-pixel rounding may enlarge the result: query actual bounds with [`Self::layout_bounds`]. Subsequent natural computation restores authored sizing.", "documentation": "Compute a root with assigned border-box dimensions for this invocation.\nAuthored root size/min/max/aspect-ratio are temporarily overridden;\ndescendants reflow normally. Padding/borders and device-pixel rounding\nmay enlarge the result: query actual bounds with [`Self::layout_bounds`].\nSubsequent natural computation restores authored sizing.", "signature": "pub fn compute_layout_with_size (& mut self, layout_id : LayoutId, available_space : Size, assigned_size : Size, cx : & mut App,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::consume_scroll_delta", "name": "consume_scroll_delta", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Consumes actual wheel movement on the event's original axes. Subsequent listeners receive only the remainder, including unused axes and edge overshoot. Supply the same line height used to interpret the event; line deltas remain in lines for ancestors with different typography. Does nothing outside mouse-wheel dispatch. Fully consumed events stop propagating; explicit `App::stop_propagation` still refuses all remainder.", "documentation": "Consumes actual wheel movement on the event's original axes. Subsequent\nlisteners receive only the remainder, including unused axes and edge\novershoot. Supply the same line height used to interpret the event;\nline deltas remain in lines for ancestors with different typography.\nDoes nothing outside mouse-wheel dispatch. Fully consumed events stop\npropagating; explicit `App::stop_propagation` still refuses all remainder.", "signature": "pub fn consume_scroll_delta (& mut self, consumed : Point, line_height : Pixels, cx : & mut App,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::content_mask", "name": "content_mask", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtain the current content mask. This method should only be called during element drawing.", "documentation": "Obtain the current content mask. This method should only be called during element drawing.", "signature": "pub fn content_mask (& self) -> ContentMask", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::context_stack", "name": "context_stack", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the current context stack.", "documentation": "Returns the current context stack.", "signature": "pub fn context_stack (& self) -> Vec", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::create_native_surface", "name": "create_native_surface", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates a native surface slot between the root scene and GPUI's deferred/window-level overlay scene.", "documentation": "Creates a native surface slot between the root scene and GPUI's\ndeferred/window-level overlay scene.", "signature": "pub fn create_native_surface (& self) -> anyhow::Result>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::current_view", "name": "current_view", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Get the entity ID for the currently rendering view", "documentation": "Get the entity ID for the currently rendering view", "signature": "pub fn current_view (& self) -> EntityId", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::debug_a11y_tree_json", "name": "debug_a11y_tree_json", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Debug representation of the last frame's accessibility information.", "documentation": "Debug representation of the last frame's accessibility information.", "signature": "pub fn debug_a11y_tree_json (& self) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::default_prevented", "name": "default_prevented", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtain whether default has been prevented for the event currently being dispatched.", "documentation": "Obtain whether default has been prevented for the event currently being dispatched.", "signature": "pub fn default_prevented (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::defer", "name": "defer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Schedules the given function to be run at the end of the current effect cycle, allowing entities that are currently on the stack to be returned to the app.", "documentation": "Schedules the given function to be run at the end of the current effect cycle, allowing entities\nthat are currently on the stack to be returned to the app.", "signature": "pub fn defer (& self, cx : & mut App, f : impl FnOnce (& mut Window, & mut App) + 'static)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::defer_draw", "name": "defer_draw", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Defers the drawing of the given element, scheduling it to be painted on top of the currently-drawn tree at a later time. The `priority` parameter determines the drawing order relative to other deferred elements, with higher values being drawn on top.", "documentation": "Defers the drawing of the given element, scheduling it to be painted on top of the currently-drawn tree\nat a later time. The `priority` parameter determines the drawing order relative to other deferred elements,\nwith higher values being drawn on top.\n\nWhen `content_mask` is provided, the deferred element will be clipped to that region during\nboth prepaint and paint. When `None`, no additional clipping is applied.\n\nAccessibility surfaces attach to the window root, independently of their\ntrigger. Inline subtrees should use [`Self::defer_draw_with_accessibility`].\n\nThis method should only be called as part of the prepaint phase of element drawing.", "signature": "pub fn defer_draw (& mut self, element : AnyElement, absolute_offset : Point, priority : usize, content_mask : Option>,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::defer_draw_with_accessibility", "name": "defer_draw_with_accessibility", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Defers an inline subtree while retaining its logical accessibility ancestors and source-order child position, including nested deferrals. Clipping and paint priority behave exactly as in [`Self::defer_draw`]. Call only during prepaint.", "documentation": "Defers an inline subtree while retaining its logical accessibility\nancestors and source-order child position, including nested deferrals.\nClipping and paint priority behave exactly as in [`Self::defer_draw`].\nCall only during prepaint.", "signature": "pub fn defer_draw_with_accessibility (& mut self, element : AnyElement, absolute_offset : Point, priority : usize, content_mask : Option>,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::disable_focus", "name": "disable_focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Blur the window and don't allow anything in it to be focused again.", "documentation": "Blur the window and don't allow anything in it to be focused again.", "signature": "pub fn disable_focus (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::dispatch_action", "name": "dispatch_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Dispatch the given action on the currently focused element.", "documentation": "Dispatch the given action on the currently focused element.", "signature": "pub fn dispatch_action (& mut self, action : Box, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::dispatch_event", "name": "dispatch_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Dispatch a mouse, keyboard, or touch event on the window.", "documentation": "Dispatch a mouse, keyboard, or touch event on the window.", "signature": "pub fn dispatch_event (& mut self, event : PlatformInput, cx : & mut App) -> DispatchEventResult", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::dispatch_keystroke", "name": "dispatch_keystroke", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Dispatch a given keystroke as though the user had typed it. You can create a keystroke with Keystroke::parse(\"\").", "documentation": "Dispatch a given keystroke as though the user had typed it.\nYou can create a keystroke with Keystroke::parse(\"\").", "signature": "pub fn dispatch_keystroke (& mut self, keystroke : Keystroke, cx : & mut App) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::display", "name": "display", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Determine the display on which the window is visible.", "documentation": "Determine the display on which the window is visible.", "signature": "pub fn display (& self, cx : & App) -> Option>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::document_selection", "name": "document_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "This window's document selection.", "documentation": "This window's document selection.", "signature": "pub fn document_selection (& self) -> & DocumentSelectionState", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::document_selection_mut", "name": "document_selection_mut", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "This window's document selection, for a caller placing or clearing it.", "documentation": "This window's document selection, for a caller placing or clearing it.", "signature": "pub fn document_selection_mut (& mut self) -> & mut DocumentSelectionState", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::document_selection_text", "name": "document_selection_text", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Reads the document selection out of the participants that were drawn.", "documentation": "Reads the document selection out of the participants that were drawn.\n\nReturns `None` when nothing is selected. The result states whether it\ncould prove it saw the whole span; see [`SelectionCopy::complete`].", "signature": "pub fn document_selection_text (& self) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::drag_document_selection_to", "name": "drag_document_selection_to", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Moves the far end of the document selection to a window position.", "documentation": "Moves the far end of the document selection to a window position.\n\nA position inside a participant selects to that offset. A position past\nthe mounted content extends to the edge it passed, so a drag that left\nthe text it started in still means something. Returns whether the\nselection changed.", "signature": "pub fn drag_document_selection_to (& mut self, position : Point) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::draw", "name": "draw", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Produces a new frame and assigns it to `rendered_frame`. The internal presentation pass then shows the contents of the new [`Scene`].", "documentation": "Produces a new frame and assigns it to `rendered_frame`. The internal\npresentation pass then shows the contents of the new [`Scene`].", "signature": "pub fn draw (& mut self, cx : & mut App) -> ArenaClearNeeded", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::drop_image", "name": "drop_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Removes an image from the sprite atlas.", "documentation": "Removes an image from the sprite atlas.", "signature": "pub fn drop_image (& mut self, data : Arc) -> Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::element_offset", "name": "element_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtain the current element offset. This method should only be called during the prepaint phase of element drawing.", "documentation": "Obtain the current element offset. This method should only be called during the\nprepaint phase of element drawing.", "signature": "pub fn element_offset (& self) -> Point", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::enable_scene_overlay", "name": "enable_scene_overlay", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Enables an experimental transparent GPUI scene plane above native child views hosted by this window.", "documentation": "Enables an experimental transparent GPUI scene plane above native child\nviews hosted by this window.\n\nThe root scene remains on the primary surface. Deferred elements and\nwindow-level overlays are rendered on the transparent plane. Glyphs on\nthat plane use grayscale antialiasing because subpixel coverage cannot\nbe alpha-composited; root-scene text keeps the platform rendering mode.", "signature": "pub fn enable_scene_overlay (& self) -> anyhow::Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::focus", "name": "focus", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Move focus to the element associated with the given [`FocusHandle`].", "documentation": "Move focus to the element associated with the given [`FocusHandle`].", "signature": "pub fn focus (& mut self, handle : & FocusHandle, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::focus_from_pointer", "name": "focus_from_pointer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Move focus to the element a pointer press just landed on.", "documentation": "Move focus to the element a pointer press just landed on.\n\nThe same move as [`Window::focus`], and additionally the record that\nthis focus was placed by that press. It is the one distinction\nfocus-visible styling turns on: somebody who clicked a control already\nknows where they clicked, while focus a tab stop, an action, or a\ndialog moved is only visible because the ring says so.", "signature": "pub fn focus_from_pointer (& mut self, handle : & FocusHandle, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::focus_is_visible", "name": "focus_is_visible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Whether the focused element's focus is worth drawing a ring around.", "documentation": "Whether the focused element's focus is worth drawing a ring around.\n\nFalse only while a pointer press is what put focus there. See\n[`Window::focus_from_pointer`] and\n[`InteractiveElement::focus_visible`].", "signature": "pub fn focus_is_visible (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::focus_next", "name": "focus_next", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Move focus to next tab stop.", "documentation": "Move focus to next tab stop.", "signature": "pub fn focus_next (& mut self, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::focus_prev", "name": "focus_prev", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Move focus to previous tab stop.", "documentation": "Move focus to previous tab stop.", "signature": "pub fn focus_prev (& mut self, cx : & mut App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::focused", "name": "focused", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtain the currently focused [`FocusHandle`]. If no elements are focused, returns `None`.", "documentation": "Obtain the currently focused [`FocusHandle`]. If no elements are focused, returns `None`.", "signature": "pub fn focused (& self, cx : & App) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::frame_stats", "name": "frame_stats", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns deterministic structural counters for the most recently completed frame in this window.", "documentation": "Returns deterministic structural counters for the most recently\ncompleted frame in this window.", "signature": "pub fn frame_stats (& self) -> profiler::FrameStats", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::get_asset", "name": "get_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Asynchronously load an asset, if the asset hasn't finished loading or doesn't exist this will return None. Your view will not be re-drawn once the asset has finished loading.", "documentation": "Asynchronously load an asset, if the asset hasn't finished loading or doesn't exist this will return None.\nYour view will not be re-drawn once the asset has finished loading.\n\nNote that the multiple calls to this method will only result in one `Asset::load` call at a\ntime.", "signature": "pub fn get_asset (& mut self, source : & A::Source, cx : & mut App) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::gpu_specs", "name": "gpu_specs", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Read information about the GPU backing this window. Currently returns None on Mac and Windows.", "documentation": "Read information about the GPU backing this window.\nCurrently returns None on Mac and Windows.", "signature": "pub fn gpu_specs (& self) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::handle_input", "name": "handle_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets an input handler, such as [`ElementInputHandler`][element_input_handler], which interfaces with the platform to receive textual input with proper integration with concerns such as IME interactions. This handler will be active for the upcoming frame until the following frame is rendered.", "documentation": "Sets an input handler, such as [`ElementInputHandler`][element_input_handler], which interfaces with the\nplatform to receive textual input with proper integration with concerns such\nas IME interactions. This handler will be active for the upcoming frame until the following frame is\nrendered.\n\nThis method should only be called as part of the paint phase of element drawing.\n\n[element_input_handler]: crate::ElementInputHandler", "signature": "pub fn handle_input (& mut self, focus_handle : & FocusHandle, input_handler : impl InputHandler, cx : & App,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::handler_for", "name": "handler_for", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns a generic handler that invokes the given handler with the view and context associated with the given view handle.", "documentation": "Returns a generic handler that invokes the given handler with the view and context associated with the given view handle.", "signature": "pub fn handler_for) + 'static> (& self, entity : & Entity, f : Callback,) -> impl Fn (& mut Window, & mut App) + 'static", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::has_active_prompt", "name": "has_active_prompt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether a prompt rendered by GPUI is currently active in this window.", "documentation": "Returns whether a prompt rendered by GPUI is currently active in this window.\n\nThis is only true for prompts rendered in the window (see\n[`App::set_prompt_builder`]), not for platform-native prompt dialogs.", "signature": "pub fn has_active_prompt (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::has_image_atlas_entry", "name": "has_image_atlas_entry", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether every frame of an image is present in the sprite atlas.", "documentation": "Returns whether every frame of an image is present in the sprite atlas.", "signature": "pub fn has_image_atlas_entry (& self, data : & RenderImage) -> bool", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::has_long_press_capture", "name": "has_long_press_capture", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether the given entity has captured the current long press.", "documentation": "Returns whether the given entity has captured the current long press.", "signature": "pub fn has_long_press_capture (& self, entity : & Entity) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::has_pending_keystrokes", "name": "has_pending_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Determine whether a potential multi-stroke key binding is in progress on this window.", "documentation": "Determine whether a potential multi-stroke key binding is in progress on this window.", "signature": "pub fn has_pending_keystrokes (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::highest_precedence_binding_for_action", "name": "highest_precedence_binding_for_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the highest precedence key binding that invokes an action on the currently focused element. This is more efficient than getting the last result of `bindings_for_action`.", "documentation": "Returns the highest precedence key binding that invokes an action on the currently focused\nelement. This is more efficient than getting the last result of `bindings_for_action`.", "signature": "pub fn highest_precedence_binding_for_action (& self, action : & dyn Action) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::highest_precedence_binding_for_action_in", "name": "highest_precedence_binding_for_action_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the highest precedence key binding that would invoke an action on the given focus handle if it were focused. This is more efficient than getting the last result of `bindings_for_action_in`.", "documentation": "Returns the highest precedence key binding that would invoke an action on the given focus\nhandle if it were focused. This is more efficient than getting the last result of\n`bindings_for_action_in`.", "signature": "pub fn highest_precedence_binding_for_action_in (& self, action : & dyn Action, focus_handle : & FocusHandle,) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::highest_precedence_binding_for_action_in_context", "name": "highest_precedence_binding_for_action_in_context", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the highest precedence key binding for an action in a context. This is more efficient than getting the last result of `bindings_for_action_in_context`.", "documentation": "Returns the highest precedence key binding for an action in a context. This is more\nefficient than getting the last result of `bindings_for_action_in_context`.", "signature": "pub fn highest_precedence_binding_for_action_in_context (& self, action : & dyn Action, context : KeyContext,) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::inner_window_bounds", "name": "inner_window_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Return the `WindowBounds` excluding insets (Wayland and X11)", "documentation": "Return the `WindowBounds` excluding insets (Wayland and X11)", "signature": "pub fn inner_window_bounds (& self) -> WindowBounds", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::input_latency_snapshot", "name": "input_latency_snapshot", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns a snapshot of the current input-latency histograms.", "documentation": "Returns a snapshot of the current input-latency histograms.", "signature": "pub fn input_latency_snapshot (& self) -> InputLatencySnapshot", "cfg": [ "cfg (feature = \"input-latency-histogram\")" ], "target": "Window" }, { "id": "gpui::window::Window::insert_hitbox", "name": "insert_hitbox", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "This method should be called during `prepaint`. You can use the returned [Hitbox] during `paint` or in an event handler to determine whether the inserted hitbox was the topmost.", "documentation": "This method should be called during `prepaint`. You can use\nthe returned [Hitbox] during `paint` or in an event handler\nto determine whether the inserted hitbox was the topmost.\n\nThis method should only be called as part of the prepaint phase of element drawing.", "signature": "pub fn insert_hitbox (& mut self, bounds : Bounds, behavior : HitboxBehavior) -> Hitbox", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::insert_inspector_hitbox", "name": "insert_inspector_hitbox", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Registers a hitbox that can be used for inspector picking mode, allowing users to select and inspect UI elements by clicking on them.", "documentation": "Registers a hitbox that can be used for inspector picking mode, allowing users to select and\ninspect UI elements by clicking on them.", "signature": "pub fn insert_inspector_hitbox (& mut self, hitbox_id : HitboxId, inspector_id : Option<& crate::InspectorElementId>, cx : & App,)", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ], "target": "Window" }, { "id": "gpui::window::Window::insert_window_control_hitbox", "name": "insert_window_control_hitbox", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Set a hitbox which will act as a control area of the platform window.", "documentation": "Set a hitbox which will act as a control area of the platform window.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn insert_window_control_hitbox (& mut self, area : WindowControlArea, hitbox : Hitbox)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::insets", "name": "insets", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "System-reserved edge regions in logical pixels of the current content viewport. Changes invalidate the window, including animation frames. See [`crate::WindowInsets`] for resize versus overlay semantics.", "documentation": "System-reserved edge regions in logical pixels of the current content\nviewport. Changes invalidate the window, including animation frames.\nSee [`crate::WindowInsets`] for resize versus overlay semantics.", "signature": "pub fn insets (& self) -> crate::WindowInsets", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::invalidate_character_coordinates", "name": "invalidate_character_coordinates", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the IME panel position suggestions for languages like japanese, chinese.", "documentation": "Updates the IME panel position suggestions for languages like japanese, chinese.", "signature": "pub fn invalidate_character_coordinates (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_a11y_active", "name": "is_a11y_active", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether accessibility features are active for this frame, i.e. whether assistive technology (such as a screen reader) is connected and an accessibility tree is being built.", "documentation": "Returns whether accessibility features are active for this frame,\ni.e. whether assistive technology (such as a screen reader) is\nconnected and an accessibility tree is being built.\n\nUse this to skip computing data during rendering that is only\nobservable through the accessibility tree. When accessibility is\nactivated, a redraw is forced, so gated work is recomputed before the\nnext tree update is sent to the platform.\n\nSee the [accessibility guide](crate::_accessibility) for an overview.", "signature": "pub fn is_a11y_active (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_action_available", "name": "is_action_available", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Determine whether the given action is available along the dispatch path to the currently focused element.", "documentation": "Determine whether the given action is available along the dispatch path to the currently focused element.", "signature": "pub fn is_action_available (& self, action : & dyn Action, cx : & App) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_action_available_in", "name": "is_action_available_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Determine whether the given action is available along the dispatch path to the given focus_handle.", "documentation": "Determine whether the given action is available along the dispatch path to the given focus_handle.", "signature": "pub fn is_action_available_in (& self, action : & dyn Action, focus_handle : & FocusHandle) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_fullscreen", "name": "is_fullscreen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether or not the window is currently fullscreen", "documentation": "Returns whether or not the window is currently fullscreen", "signature": "pub fn is_fullscreen (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_inspector_picking", "name": "is_inspector_picking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns true if the window is in inspector mode.", "documentation": "Returns true if the window is in inspector mode.", "signature": "pub fn is_inspector_picking (& self, _cx : & App) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_maximized", "name": "is_maximized", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Check if the platform window is maximized.", "documentation": "Check if the platform window is maximized.\n\nOn some platforms (namely Windows) this is different than the bounds being the size of the display", "signature": "pub fn is_maximized (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_minimizable", "name": "is_minimizable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether this window is minimizable.", "documentation": "Returns whether this window is minimizable.", "signature": "pub fn is_minimizable (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_resizable", "name": "is_resizable", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether this window is resizable.", "documentation": "Returns whether this window is resizable.", "signature": "pub fn is_resizable (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_window_active", "name": "is_window_active", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether this window is focused by the operating system (receiving key events).", "documentation": "Returns whether this window is focused by the operating system (receiving key events).", "signature": "pub fn is_window_active (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::is_window_hovered", "name": "is_window_hovered", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether this window is considered to be the window that currently owns the mouse cursor. On mac, this is equivalent to `is_window_active`.", "documentation": "Returns whether this window is considered to be the window\nthat currently owns the mouse cursor.\nOn mac, this is equivalent to `is_window_active`.", "signature": "pub fn is_window_hovered (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::keystroke_text_for", "name": "keystroke_text_for", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Return a key binding string for an action, to display in the UI. Uses the highest precedence binding for the action (last binding added to the keymap).", "documentation": "Return a key binding string for an action, to display in the UI. Uses the highest precedence\nbinding for the action (last binding added to the keymap).", "signature": "pub fn keystroke_text_for (& self, action : & dyn Action) -> String", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::last_input_was_keyboard", "name": "last_input_was_keyboard", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns true if the last input event was keyboard-based (key press, tab navigation, etc.) This is used for focus-visible styling to show focus indicators only for keyboard navigation.", "documentation": "Returns true if the last input event was keyboard-based (key press, tab navigation, etc.)\nThis is used for focus-visible styling to show focus indicators only for keyboard navigation.", "signature": "pub fn last_input_was_keyboard (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::layout_bounds", "name": "layout_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtain the bounds computed for the given LayoutId relative to the window. This method will usually be invoked by GPUI itself automatically in order to pass your element its `Bounds` automatically.", "documentation": "Obtain the bounds computed for the given LayoutId relative to the window. This method will usually be invoked by\nGPUI itself automatically in order to pass your element its `Bounds` automatically.\n\nThis method should only be called as part of element drawing.", "signature": "pub fn layout_bounds (& mut self, layout_id : LayoutId) -> Bounds", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::line_height", "name": "line_height", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The line height associated with the current text style.", "documentation": "The line height associated with the current text style.", "signature": "pub fn line_height (& self) -> Pixels", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::listener_for", "name": "listener_for", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns a generic event listener that invokes the given listener with the view and context associated with the given view handle.", "documentation": "Returns a generic event listener that invokes the given listener with the view and context associated with the given view handle.", "signature": "pub fn listener_for (& self, view : & Entity, f : impl Fn (& mut T, & E, & mut Window, & mut Context) + 'static,) -> impl Fn (& E, & mut Window, & mut App) + 'static", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::merge_all_windows", "name": "merge_all_windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Merges all open windows into a single tabbed window. This is macOS specific.", "documentation": "Merges all open windows into a single tabbed window.\nThis is macOS specific.", "signature": "pub fn merge_all_windows (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::minimize_window", "name": "minimize_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Minimize the current window at the platform level. May do nothing on mobile; use [`Self::try_minimize_window`].", "documentation": "Minimize the current window at the platform level.\nMay do nothing on mobile; use [`Self::try_minimize_window`].", "signature": "pub fn minimize_window (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::modifiers", "name": "modifiers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The current state of the keyboard's modifiers", "documentation": "The current state of the keyboard's modifiers", "signature": "pub fn modifiers (& self) -> Modifiers", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::mouse_position", "name": "mouse_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The position of the mouse relative to the window.", "documentation": "The position of the mouse relative to the window.", "signature": "pub fn mouse_position (& self) -> Point", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::move_tab_to_new_window", "name": "move_tab_to_new_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Moves the tab to a new containing window. This is macOS specific.", "documentation": "Moves the tab to a new containing window.\nThis is macOS specific.", "signature": "pub fn move_tab_to_new_window (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::native_context_menu_tracking", "name": "native_context_menu_tracking", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Observes the current revision only while inside its native OS menu tracking call. Queued presentations and simulated menus return `None`; a replaced revision may still be leaving its loop when this is `None`. Only native smoke tests should use this; await session completion to determine closure in application code.", "documentation": "Observes the current revision only while inside its native OS menu\ntracking call. Queued presentations and simulated menus return `None`;\na replaced revision may still be leaving its loop when this is `None`.\nOnly native smoke tests should use this; await session completion to\ndetermine closure in application code.", "signature": "pub fn native_context_menu_tracking (& self) -> Option", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::observe", "name": "observe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Subscribe to events emitted by a entity. The entity to which you're subscribing must implement the [`EventEmitter`] trait. The callback will be invoked a handle to the emitting entity, the event, and a window context for the current window.", "documentation": "Subscribe to events emitted by a entity.\nThe entity to which you're subscribing must implement the [`EventEmitter`] trait.\nThe callback will be invoked a handle to the emitting entity, the event, and a window context for the current window.", "signature": "pub fn observe (& mut self, observed : & Entity, cx : & mut App, mut on_notify : impl FnMut (Entity, & mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::observe_button_layout_changed", "name": "observe_button_layout_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Registers a callback to be invoked when the window button layout changes.", "documentation": "Registers a callback to be invoked when the window button layout changes.", "signature": "pub fn observe_button_layout_changed (& self, mut callback : impl FnMut (& mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::observe_global", "name": "observe_global", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register the given handler to be invoked whenever the global of the given type is updated.", "documentation": "Register the given handler to be invoked whenever the global of the given type\nis updated.", "signature": "pub fn observe_global (& mut self, cx : & mut App, f : impl Fn (& mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::observe_release", "name": "observe_release", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a callback to be invoked when the given `Entity` is released.", "documentation": "Register a callback to be invoked when the given `Entity` is released.", "signature": "pub fn observe_release (& self, entity : & Entity, cx : & mut App, mut on_release : impl FnOnce (& mut T, & mut Window, & mut App) + 'static,) -> Subscription where T : 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::observe_window_appearance", "name": "observe_window_appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Registers a callback to be invoked when the window appearance changes.", "documentation": "Registers a callback to be invoked when the window appearance changes.", "signature": "pub fn observe_window_appearance (& self, mut callback : impl FnMut (& mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_a11y_action", "name": "on_a11y_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a listener for an accessibility action on a specific node. The listener will be called when a screen reader requests the given action on the node identified by `node_id`.", "documentation": "Register a listener for an accessibility action on a specific node.\nThe listener will be called when a screen reader requests the given\naction on the node identified by `node_id`.\n\nRegistration is ignored when accessibility is inactive for the current\nframe. Activating accessibility forces a redraw before actions can be\ndelivered, so retaining listeners from inactive frames is unnecessary.\n\nSee the [accessibility guide](crate::_accessibility) for an overview.", "signature": "pub fn on_a11y_action (& mut self, node_id : accesskit::NodeId, action : accesskit::Action, mut listener : impl FnMut (Option<& accesskit::ActionData>, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_action", "name": "on_action", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register an action listener on this node for the next frame. The type of action is determined by the first parameter of the given listener. When the next frame is rendered the listener will be cleared.", "documentation": "Register an action listener on this node for the next frame. The type of action\nis determined by the first parameter of the given listener. When the next frame is rendered\nthe listener will be cleared.\n\nThis is a fairly low-level method, so prefer using action handlers on elements unless you have\na specific need to register a listener yourself.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn on_action (& mut self, action_type : TypeId, listener : impl Fn (& dyn Any, DispatchPhase, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_action_when", "name": "on_action_when", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a capturing action listener on this node for the next frame if the condition is true. The type of action is determined by the first parameter of the given listener. When the next frame is rendered the listener will be cleared.", "documentation": "Register a capturing action listener on this node for the next frame if the condition is true.\nThe type of action is determined by the first parameter of the given listener. When the next\nframe is rendered the listener will be cleared.\n\nThis is a fairly low-level method, so prefer using action handlers on elements unless you have\na specific need to register a listener yourself.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn on_action_when (& mut self, condition : bool, action_type : TypeId, listener : impl Fn (& dyn Any, DispatchPhase, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_focus_in", "name": "on_focus_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a listener to be called when the given focus handle or one of its descendants receives focus. This does not fire if the given focus handle - or one of its descendants - was previously focused. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when the given focus handle or one of its descendants receives focus.\nThis does not fire if the given focus handle - or one of its descendants - was previously focused.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_focus_in (& mut self, handle : & FocusHandle, cx : & mut App, mut listener : impl FnMut (& mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_focus_out", "name": "on_focus_out", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a listener to be called when the given focus handle or one of its descendants loses focus. Returns a subscription and persists until the subscription is dropped.", "documentation": "Register a listener to be called when the given focus handle or one of its descendants loses focus.\nReturns a subscription and persists until the subscription is dropped.", "signature": "pub fn on_focus_out (& mut self, handle : & FocusHandle, cx : & mut App, mut listener : impl FnMut (FocusOutEvent, & mut Window, & mut App) + 'static,) -> Subscription", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_key_event", "name": "on_key_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a key event listener on this node for the next frame. The type of event is determined by the first parameter of the given listener. When the next frame is rendered the listener will be cleared.", "documentation": "Register a key event listener on this node for the next frame. The type of event\nis determined by the first parameter of the given listener. When the next frame is rendered\nthe listener will be cleared.\n\nThis is a fairly low-level method, so prefer using event handlers on elements unless you have\na specific need to register a listener yourself.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn on_key_event (& mut self, listener : impl Fn (& Event, DispatchPhase, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_modifiers_changed", "name": "on_modifiers_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a modifiers changed event listener on the window for the next frame.", "documentation": "Register a modifiers changed event listener on the window for the next frame.\n\nThis is a fairly low-level method, so prefer using event handlers on elements unless you have\na specific need to register a global listener.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn on_modifiers_changed (& mut self, listener : impl Fn (& ModifiersChangedEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_mouse_event", "name": "on_mouse_event", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a mouse event listener on the window for the next frame. The type of event is determined by the first parameter of the given listener. When the next frame is rendered the listener will be cleared.", "documentation": "Register a mouse event listener on the window for the next frame. The type of event\nis determined by the first parameter of the given listener. When the next frame is rendered\nthe listener will be cleared.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn on_mouse_event (& mut self, mut listener : impl FnMut (& Event, DispatchPhase, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_next_frame", "name": "on_next_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Schedule the given closure to be run directly after the current frame is rendered.", "documentation": "Schedule the given closure to be run directly after the current frame is rendered.", "signature": "pub fn on_next_frame (& self, callback : impl FnOnce (& mut Window, & mut App) + 'static)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_touch_pan", "name": "on_touch_pan", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register an exclusive direction-aware touch manipulation listener during paint. `id` must be stable and unique in this window across frames. On `Started`, reject points outside your prepaint bounds, then call `prevent_default` to acquire. Offers bubble inner-first; acquisition automatically stops propagation. Only the acquiring ID receives later phases, even outside its original bounds. Keep that listener registered until the terminal event, or cancel touch input before removing it. See [`crate::TouchPanEvent`] for direction and scroll arbitration.", "documentation": "Register an exclusive direction-aware touch manipulation listener during\npaint. `id` must be stable and unique in this window across frames.\nOn `Started`, reject points outside your prepaint bounds, then call\n`prevent_default` to acquire. Offers bubble inner-first; acquisition\nautomatically stops propagation. Only the acquiring ID receives later\nphases, even outside its original bounds. Keep that listener registered\nuntil the terminal event, or cancel touch input before removing it.\nSee [`crate::TouchPanEvent`] for direction and scroll arbitration.", "signature": "pub fn on_touch_pan (& mut self, id : impl Into, mut listener : impl FnMut (& crate::TouchPanEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_touch_pinch", "name": "on_touch_pinch", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a captured portable or native pinch listener during paint. On `Started`, hit-test `position` against prepaint bounds and prevent default to own the stream. Only that stable window-unique ID receives subsequent events, regardless of the moving centroid. Use the same ID with `on_touch_pan` to allow that pan to cancel and promote into this pinch on a second contact. No other claimed direct manipulation is eligible for takeover. Keep the owner registered until its terminal phase or cancel before removal.", "documentation": "Register a captured portable or native pinch listener during paint. On `Started`,\nhit-test `position` against prepaint bounds and prevent default to own\nthe stream. Only that stable window-unique ID receives subsequent events,\nregardless of the moving centroid. Use the same ID with `on_touch_pan`\nto allow that pan to cancel and promote into this pinch on a second\ncontact. No other claimed direct manipulation is eligible for takeover.\nKeep the owner registered until its terminal phase or cancel before removal.", "signature": "pub fn on_touch_pinch (& mut self, id : impl Into, mut listener : impl FnMut (& crate::PinchEvent, & mut Window, & mut App) + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::on_window_should_close", "name": "on_window_should_close", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register a callback that can interrupt the closing of the current window based the returned boolean. If the callback returns false, the window won't be closed.", "documentation": "Register a callback that can interrupt the closing of the current window based the returned boolean.\nIf the callback returns false, the window won't be closed.", "signature": "pub fn on_window_should_close (& self, cx : & App, f : impl Fn (& mut Window, & mut App) -> bool + 'static,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_backdrop_blur", "name": "paint_backdrop_blur", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint a within-window backdrop blur: everything already painted beneath `bounds` is snapshotted and painted back gaussian-blurred inside the rounded rect (frosted-glass popovers). Metal, WGPU and DirectX renderers support it; invalid radii and blur regions beyond a renderer's bounded per-frame budget fall back to the sharp source. Frosted callers should keep a translucent fill over it. Content painted AFTER this call composites on top of the blur.", "documentation": "Paint a within-window backdrop blur: everything already painted\nbeneath `bounds` is snapshotted and painted back gaussian-blurred\ninside the rounded rect (frosted-glass popovers). Metal, WGPU and\nDirectX renderers support it; invalid radii and blur regions beyond a\nrenderer's bounded per-frame budget fall back to the sharp source.\nFrosted callers should keep a translucent fill over it.\nContent painted AFTER this call composites on top of the blur.\n\nThis is [`Window::paint_backdrop_glass`] with [`GlassMaterial::frosted`]\nand no lobes: the backdrop is blurred and nothing about it is bent,\nsplit or lit.", "signature": "pub fn paint_backdrop_blur (& mut self, bounds : Bounds, corner_radii : Corners, blur_radius : Pixels,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_backdrop_glass", "name": "paint_backdrop_glass", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint a within-window glass surface: everything already painted beneath `bounds` is snapshotted and painted back through the surface's shape and `material`. A zero [`GlassMaterial::blur_radius`] keeps the snapshot sharp; it does not disable refraction or the rest of the optics.", "documentation": "Paint a within-window glass surface: everything already painted beneath\n`bounds` is snapshotted and painted back through the surface's shape and\n`material`. A zero [`GlassMaterial::blur_radius`] keeps the snapshot\nsharp; it does not disable refraction or the rest of the optics.\n\n`lobes` is the shape. An empty slice means the surface is the single\nrounded rect named by `bounds` and `corner_radii`, which is the common\ncase; several lobes are joined by [`GlassMaterial::smoothing`] into one\nbody, and `bounds` must then be their union's bounding box because that\nis the region the renderer rasterizes and the blur is clipped to. Lobes\npast [`MAX_GLASS_LOBES`] are dropped.\n\nMetal, DirectX, and native/browser WGPU implement this complete\ncontract. A bounded renderer may discard requested scattering when it\nruns out of Gaussian work, but it must retain the sharp snapshot and\nevery other optical field. `material` is sanitized on the way in, so a\nvalue computed from an animation cannot produce a hole. The scene\nadmits at most [`crate::MAX_BACKDROP_GLASS_SURFACES_PER_FRAME`] surfaces;\ncallers without an ordinary fill should use\n[`Window::paint_backdrop_glass_with_fallback`] so rejection remains a\nlegible surface rather than a hole.\n\nContent painted AFTER this call composites on top.", "signature": "pub fn paint_backdrop_glass (& mut self, bounds : Bounds, corner_radii : Corners, material : GlassMaterial, lobes : & [GlassLobe],)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_backdrop_glass_with_fallback", "name": "paint_backdrop_glass_with_fallback", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint a within-window glass surface with an ordinary-fill fallback.", "documentation": "Paint a within-window glass surface with an ordinary-fill fallback.\n\nThis has the same optical contract as [`Window::paint_backdrop_glass`].\nWhen the surface is past\n[`crate::MAX_BACKDROP_GLASS_SURFACES_PER_FRAME`], however, the scene\npaints `fallback` through the same rounded-rect or lobe shape instead\nof asking a renderer for another full-frame snapshot. The decision is\nretained by scene replay, so cached subtrees cannot bypass the budget\nor lose their fallback when their paint order changes.", "signature": "pub fn paint_backdrop_glass_with_fallback (& mut self, bounds : Bounds, corner_radii : Corners, material : GlassMaterial, lobes : & [GlassLobe], fallback : impl Into,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_drop_shadows", "name": "paint_drop_shadows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint the drop (non-inset) shadows from `shadows` into the scene at the current z-index. Inset shadows are skipped; paint those with [`Self::paint_inset_shadows`] after the element's background so they layer on top of the fill.", "documentation": "Paint the drop (non-inset) shadows from `shadows` into the scene at the current\nz-index. Inset shadows are skipped; paint those with [`Self::paint_inset_shadows`]\nafter the element's background so they layer on top of the fill.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_drop_shadows (& mut self, bounds : Bounds, corner_radii : Corners, shadows : & [BoxShadow],)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_emoji", "name": "paint_emoji", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paints an emoji glyph into the scene for the next frame at the current z-index.", "documentation": "Paints an emoji glyph into the scene for the next frame at the current z-index.\n\nThe y component of the origin is the baseline of the glyph.\nYou should generally prefer to use the [`ShapedLine::paint`](crate::ShapedLine::paint) or\n[`WrappedLine::paint`](crate::WrappedLine::paint) methods in the [`TextSystem`](crate::TextSystem).\nThis method is only useful if you need to paint a single emoji that has already been shaped.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_emoji (& mut self, origin : Point, font_id : FontId, glyph_id : GlyphId, font_size : Pixels,) -> Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_glyph", "name": "paint_glyph", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paints a monochrome (non-emoji) glyph into the scene for the next frame at the current z-index.", "documentation": "Paints a monochrome (non-emoji) glyph into the scene for the next frame at the current z-index.\n\nThe y component of the origin is the baseline of the glyph.\nYou should generally prefer to use the [`ShapedLine::paint`](crate::ShapedLine::paint) or\n[`WrappedLine::paint`](crate::WrappedLine::paint) methods in the [`TextSystem`](crate::TextSystem).\nThis method is only useful if you need to paint a single glyph that has already been shaped.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_glyph (& mut self, origin : Point, font_id : FontId, glyph_id : GlyphId, font_size : Pixels, color : Hsla,) -> Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_image", "name": "paint_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint an image into the scene for the next frame at the current z-index. This method will panic if the frame_index is not valid.", "documentation": "Paint an image into the scene for the next frame at the current z-index.\nThis method will panic if the frame_index is not valid.\n\nThis method should only be called as part of the paint phase of element drawing.\nPaint an image into `bounds`, positioning and scaling it according to `image_bounds`.\n\nThe visible region rendered is `bounds.intersect(&image_bounds)`, with `corner_radii`\napplied to `bounds`.", "signature": "pub fn paint_image (& mut self, bounds : Bounds, image_bounds : Bounds, corner_radii : Corners, data : Arc, frame_index : usize, grayscale : bool,) -> Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_inset_shadows", "name": "paint_inset_shadows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint the inset shadows from `shadows` into the scene at the current z-index. Should be called after the element's background so the shadow layers on top of the fill. Drop shadows are skipped; paint those with [`Self::paint_drop_shadows`] before the background.", "documentation": "Paint the inset shadows from `shadows` into the scene at the current z-index. Should\nbe called after the element's background so the shadow layers on top of the fill.\nDrop shadows are skipped; paint those with [`Self::paint_drop_shadows`] before the background.", "signature": "pub fn paint_inset_shadows (& mut self, bounds : Bounds, corner_radii : Corners, shadows : & [BoxShadow],)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_layer", "name": "paint_layer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates a new painting layer for the specified bounds. A \"layer\" is a batch of geometry that are non-overlapping and have the same draw order. This is typically used for performance reasons.", "documentation": "Creates a new painting layer for the specified bounds. A \"layer\" is a batch\nof geometry that are non-overlapping and have the same draw order. This is typically used\nfor performance reasons.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_layer (& mut self, bounds : Bounds, f : impl FnOnce (& mut Self) -> R) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_mark", "name": "paint_mark", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Marks the start of live GPUI painting, without retaining any element. Pair with [`Self::record_paint_since`] in this same paint call.", "documentation": "Marks the start of live GPUI painting, without retaining any element.\nPair with [`Self::record_paint_since`] in this same paint call.", "signature": "pub fn paint_mark (& self) -> crate::PaintMark", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_particle_batch", "name": "paint_particle_batch", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Samples deterministic CPU particle emitters and paints the live sprites in one atlas-backed batch.", "documentation": "Samples deterministic CPU particle emitters and paints the live sprites\nin one atlas-backed batch.\n\n`elapsed` is absolute time since the semantic effect began, not a frame\ndelta. Re-sampling the same emitters at the same instant yields the same\ninstances regardless of prior frames. All emitter definitions and the\naggregate slot ceiling are validated before the scene is modified. The\nreturned count is the number of live instances painted at this instant.\nThis method installs no hitbox or accessibility node.", "signature": "pub fn paint_particle_batch (& mut self, data : Arc, frame_index : usize, elapsed : Duration, emitters : & [ParticleEmitter],) -> Result", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_path", "name": "paint_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint the given `Path` into the scene for the next frame at the current z-index.", "documentation": "Paint the given `Path` into the scene for the next frame at the current z-index.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_path (& mut self, mut path : Path, color : impl Into)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_platform_view", "name": "paint_platform_view", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Registers a natively hosted view to occupy `bounds` for the frame being painted. The platform layer attaches and positions the view once the frame is complete, and hides any view that stops being painted.", "documentation": "Registers a natively hosted view to occupy `bounds` for the frame being\npainted. The platform layer attaches and positions the view once the\nframe is complete, and hides any view that stops being painted.\n\nPrefer the [`crate::platform_view`] element; this is its paint step.\n\nThis method should only be called as part of the paint phase of element\ndrawing.", "signature": "pub fn paint_platform_view (& mut self, bounds : Bounds, handle : PlatformViewHandle)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_quad", "name": "paint_quad", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint one or more quads into the scene for the next frame at the current stacking context. Quads are colored rectangular regions with an optional background, border, and corner radius. see [`fill`], [`outline`], and [`quad`] to construct this type.", "documentation": "Paint one or more quads into the scene for the next frame at the current stacking context.\nQuads are colored rectangular regions with an optional background, border, and corner radius.\nsee [`fill`], [`outline`], and [`quad`] to construct this type.\n\nThis method should only be called as part of the paint phase of element drawing.\n\nNote that the `quad.corner_radii` are allowed to exceed the bounds, creating sharp corners\nwhere the circular arcs meet. This will not display well when combined with dashed borders.\nUse `Corners::clamp_radii_for_quad_size` if the radii should fit within the bounds.", "signature": "pub fn paint_quad (& mut self, quad : PaintQuad)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_recording", "name": "paint_recording", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Replays frozen visual paint only, replacing capture-time ambient uniform transform/opacity with the current scope. The captured visible clipping moves with the picture and intersects current clipping; previously culled content never reappears. No live element authority returns.", "documentation": "Replays frozen visual paint only, replacing capture-time ambient uniform\ntransform/opacity with the current scope. The captured visible clipping\nmoves with the picture and intersects current clipping; previously culled\ncontent never reappears. No live element authority returns.", "signature": "pub fn paint_recording (& mut self, recording : & crate::PaintRecording,) -> Result<(), crate::PaintRecordingError>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_recording_with_offset", "name": "paint_recording_with_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Replays as [`Self::paint_recording`], translated by `offset` in current local replay coordinates. The ambient visual scale applies to this offset exactly once. Current ancestor clipping does not move with the offset.", "documentation": "Replays as [`Self::paint_recording`], translated by `offset` in current\nlocal replay coordinates. The ambient visual scale applies to this offset\nexactly once. Current ancestor clipping does not move with the offset.", "signature": "pub fn paint_recording_with_offset (& mut self, recording : & crate::PaintRecording, offset : Point,) -> Result<(), crate::PaintRecordingError>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_sprite_batch", "name": "paint_sprite_batch", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paints a batch of independently transformed samples from one image frame.", "documentation": "Paints a batch of independently transformed samples from one image frame.\n\nThe frame is uploaded to the atlas once. Each [`SpriteInstance`] then\nnarrows its own half-open source rectangle, applies a center-relative\ntransform and rounded/source-alpha mask, and selects normal, additive,\nor screen compositing. Invalid source geometry returns an error instead\nof sampling another atlas tile. This method installs no hitbox or\naccessibility node.", "signature": "pub fn paint_sprite_batch (& mut self, data : Arc, frame_index : usize, instances : & [SpriteInstance],) -> Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_strikethrough", "name": "paint_strikethrough", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint a strikethrough into the scene for the next frame at the current z-index.", "documentation": "Paint a strikethrough into the scene for the next frame at the current z-index.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_strikethrough (& mut self, origin : Point, width : Pixels, style : & StrikethroughStyle,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_surface", "name": "paint_surface", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint a surface into the scene for the next frame at the current z-index.", "documentation": "Paint a surface into the scene for the next frame at the current z-index.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_surface (& mut self, bounds : Bounds, image_buffer : CVPixelBuffer)", "cfg": [ "cfg (target_os = \"macos\")" ], "target": "Window" }, { "id": "gpui::window::Window::paint_svg", "name": "paint_svg", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint a monochrome SVG into the scene for the next frame at the current stacking context.", "documentation": "Paint a monochrome SVG into the scene for the next frame at the current stacking context.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_svg (& mut self, bounds : Bounds, path : SharedString, mut data : Option<& [u8]>, transformation : TransformationMatrix, color : Hsla, cx : & App,) -> Result<()>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::paint_underline", "name": "paint_underline", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Paint an underline into the scene for the next frame at the current z-index.", "documentation": "Paint an underline into the scene for the next frame at the current z-index.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn paint_underline (& mut self, origin : Point, width : Pixels, style : & UnderlineStyle,)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::pending_input_keystrokes", "name": "pending_input_keystrokes", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the currently pending input keystrokes that might result in a multi-stroke key binding.", "documentation": "Returns the currently pending input keystrokes that might result in a multi-stroke key binding.", "signature": "pub fn pending_input_keystrokes (& self) -> Option<& [Keystroke]>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::pixel_snap", "name": "pixel_snap", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Rounds a logical value to the nearest device pixel.", "documentation": "Rounds a logical value to the nearest device pixel.", "signature": "pub fn pixel_snap (& self, value : Pixels) -> Pixels", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::pixel_snap_bounds", "name": "pixel_snap_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Snaps a bounds' origin and size to the nearest device pixel.", "documentation": "Snaps a bounds' origin and size to the nearest device pixel.", "signature": "pub fn pixel_snap_bounds (& self, bounds : Bounds) -> Bounds", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::pixel_snap_f64", "name": "pixel_snap_f64", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "f64 variant of [`Self::pixel_snap`].", "documentation": "f64 variant of [`Self::pixel_snap`].", "signature": "pub fn pixel_snap_f64 (& self, value : f64) -> f64", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::pixel_snap_point", "name": "pixel_snap_point", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Snaps a point's coordinates to the nearest device pixel.", "documentation": "Snaps a point's coordinates to the nearest device pixel.", "signature": "pub fn pixel_snap_point (& self, position : Point) -> Point", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::play_system_bell", "name": "play_system_bell", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Request the OS to play an alert sound. On some platforms this is associated with the window, for others it's just a simple global function call.", "documentation": "Request the OS to play an alert sound. On some platforms this is associated\nwith the window, for others it's just a simple global function call.", "signature": "pub fn play_system_bell (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::possible_bindings_for_input", "name": "possible_bindings_for_input", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Find the bindings that can follow the current input sequence for the current context stack.", "documentation": "Find the bindings that can follow the current input sequence for the current context stack.", "signature": "pub fn possible_bindings_for_input (& self, input : & [Keystroke]) -> Vec", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::present_if_needed", "name": "present_if_needed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Submits the most recently drawn frame if it hasn't been submitted yet.", "documentation": "Submits the most recently drawn frame if it hasn't been submitted yet.\n\nBenchmarks drive drawing synchronously rather than through a platform\nframe-request loop, so they call this after each measured update to\nsubmit the frame like the production frame loop would.", "signature": "pub fn present_if_needed (& mut self)", "cfg": [ "cfg (feature = \"bench\")" ], "target": "Window" }, { "id": "gpui::window::Window::prevent_default", "name": "prevent_default", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Call to prevent the default action of an event. Currently only used to prevent parent elements from becoming focused on mouse down.", "documentation": "Call to prevent the default action of an event. Currently only used to prevent\nparent elements from becoming focused on mouse down.", "signature": "pub fn prevent_default (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::prompt", "name": "prompt", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Present a platform dialog. The provided message will be presented, along with buttons for each answer. When a button is clicked, the returned Receiver will receive the index of the clicked button.", "documentation": "Present a platform dialog.\nThe provided message will be presented, along with buttons for each answer.\nWhen a button is clicked, the returned Receiver will receive the index of the clicked button.", "signature": "pub fn prompt (& mut self, level : PromptLevel, message : & str, detail : Option<& str>, answers : & [T], cx : & mut App,) -> oneshot::Receiver where T : Clone + Into,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::record_paint_since", "name": "record_paint_since", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Freezes paint emitted since `mark`. This never runs element callbacks. Capture refuses unsupported content as a whole; callers should retire it immediately. Deferred draws anywhere in the frame conservatively refuse capture because their eventual paint is outside this range.", "documentation": "Freezes paint emitted since `mark`. This never runs element callbacks.\nCapture refuses unsupported content as a whole; callers should retire\nit immediately. Deferred draws anywhere in the frame conservatively\nrefuse capture because their eventual paint is outside this range.", "signature": "pub fn record_paint_since (& mut self, mark : crate::PaintMark,) -> Result", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::record_semantic_node", "name": "record_semantic_node", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Records one product semantic node published during the active frame.", "documentation": "Records one product semantic node published during the active frame.\n\nSemantic libraries call this from their paint-time probe. GPUI keeps\nthe counter at the window boundary without depending on any particular\nsemantic vocabulary.", "signature": "pub fn record_semantic_node (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::refresh", "name": "refresh", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Mark the window as dirty, scheduling it to be redrawn on the next frame.", "documentation": "Mark the window as dirty, scheduling it to be redrawn on the next frame.", "signature": "pub fn refresh (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::register_selection_participant", "name": "register_selection_participant", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Declares a text element as part of this window's document selection for the frame being prepainted.", "documentation": "Declares a text element as part of this window's document selection for\nthe frame being prepainted.\n\nA participant marked [`SelectionParticipant::sensitive`] is refused, so\nits bytes can never reach the aggregate copy path.", "signature": "pub fn register_selection_participant (& mut self, participant : & SelectionParticipant)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::release_pointer", "name": "release_pointer", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Releases any active pointer capture.", "documentation": "Releases any active pointer capture.", "signature": "pub fn release_pointer (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::rem_size", "name": "rem_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The size of an em for the base font of the application. Adjusting this value allows the UI to scale, just like zooming a web page.", "documentation": "The size of an em for the base font of the application. Adjusting this value allows the\nUI to scale, just like zooming a web page.", "signature": "pub fn rem_size (& self) -> Pixels", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::remove_window", "name": "remove_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Close this window.", "documentation": "Close this window.", "signature": "pub fn remove_window (& mut self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::render_to_image", "name": "render_to_image", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Renders the current frame's scene to a texture and returns the pixel data as an RGBA image. This does not present the frame to screen - useful for visual testing where we want to capture what would be rendered without displaying it or requiring the window to be visible.", "documentation": "Renders the current frame's scene to a texture and returns the pixel data as an RGBA image.\nThis does not present the frame to screen - useful for visual testing where we want\nto capture what would be rendered without displaying it or requiring the window to be visible.", "signature": "pub fn render_to_image (& self) -> anyhow::Result", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::replace_root", "name": "replace_root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Replaces the root entity of the window with a new one.", "documentation": "Replaces the root entity of the window with a new one.", "signature": "pub fn replace_root (& mut self, cx : & mut App, build_view : impl FnOnce (& mut Window, & mut Context) -> E,) -> Entity where E : 'static + Render,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_animation_frame", "name": "request_animation_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Schedule a frame to be drawn on the next animation frame.", "documentation": "Schedule a frame to be drawn on the next animation frame.\n\nThis is useful for elements that need to animate continuously, such as a video player or an animated GIF.\nIt will cause the window to redraw on the next frame, even if no other changes have occurred.\n\nIf called from within a view, it will notify that view on the next frame. Otherwise, it will refresh the entire window.\n\nCallers driving purely decorative animations (spinners, pulses, and the\nlike) should prefer [`AnimationExt::with_animation`](crate::AnimationExt::with_animation),\nwhich automatically respects [`App::reduce_motion`]. When using this\nmethod directly for decorative motion, check [`App::reduce_motion`]\nand skip the frame request when it is set.", "signature": "pub fn request_animation_frame (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_attention", "name": "request_attention", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Requests that the operating system draw attention to this window.", "documentation": "Requests that the operating system draw attention to this window.", "signature": "pub fn request_attention (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_autoscroll", "name": "request_autoscroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "When you call this method during [`Element::prepaint`], containing elements will attempt to scroll to cause the specified bounds to become visible. When they decide to autoscroll, they will call [`Element::prepaint`] again with a new set of bounds. See [`crate::List`] for an example of an element that supports this method being called on the elements it contains. This method should only be called during the prepaint phase of element drawing.", "documentation": "When you call this method during [`Element::prepaint`], containing elements will attempt to\nscroll to cause the specified bounds to become visible. When they decide to autoscroll, they will call\n[`Element::prepaint`] again with a new set of bounds. See [`crate::List`] for an example of an element\nthat supports this method being called on the elements it contains. This method should only be\ncalled during the prepaint phase of element drawing.", "signature": "pub fn request_autoscroll (& mut self, bounds : Bounds)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_close", "name": "request_close", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Requests that the platform close this window through its normal close path, including any callback registered with [`Self::on_window_should_close`].", "documentation": "Requests that the platform close this window through its normal close\npath, including any callback registered with\n[`Self::on_window_should_close`].", "signature": "pub fn request_close (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_decorations", "name": "request_decorations", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "request a certain window decoration (Wayland)", "documentation": "request a certain window decoration (Wayland)", "signature": "pub fn request_decorations (& self, decorations : WindowDecorations)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_intrinsic_layout", "name": "request_intrinsic_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Request a leaf with natural content dimensions, such as an image. Authored or parent-assigned dimensions win; the natural aspect ratio derives only an unassigned axis. This is distinct from arbitrary text measurement and never imposes a minimum aspect-ratio height on a box whose two dimensions have already been resolved.", "documentation": "Request a leaf with natural content dimensions, such as an image.\nAuthored or parent-assigned dimensions win; the natural aspect ratio\nderives only an unassigned axis. This is distinct from arbitrary text\nmeasurement and never imposes a minimum aspect-ratio height on a box\nwhose two dimensions have already been resolved.\n\nNatural dimensions must be finite and non-negative; a zero-size asset\nhas no natural aspect ratio. Call during layout\nrequest or prepaint, as with [`Self::request_measured_layout`].", "signature": "pub fn request_intrinsic_layout (& mut self, style : Style, intrinsic : Size) -> LayoutId", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_layout", "name": "request_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Add a node to the layout tree for the current frame. Takes the `Style` of the element for which layout is being requested, along with the layout ids of any children. This method is called during calls to the [`Element::request_layout`] trait method and enables any element to participate in layout.", "documentation": "Add a node to the layout tree for the current frame. Takes the `Style` of the element for which\nlayout is being requested, along with the layout ids of any children. This method is called during\ncalls to the [`Element::request_layout`] trait method and enables any element to participate in layout.\n\nThis method should only be called as part of the request_layout or prepaint phase of element drawing.", "signature": "pub fn request_layout (& mut self, style : Style, children : impl IntoIterator, cx : & mut App,) -> LayoutId", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::request_measured_layout", "name": "request_measured_layout", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Add a node to the layout tree for the current frame. Instead of taking a `Style` and children, this variant takes a function that is invoked during layout so you can use arbitrary logic to determine the element's size. One place this is used internally is when measuring text.", "documentation": "Add a node to the layout tree for the current frame. Instead of taking a `Style` and children,\nthis variant takes a function that is invoked during layout so you can use arbitrary logic to\ndetermine the element's size. One place this is used internally is when measuring text.\n\nThe given closure is invoked at layout time with the known dimensions and available space and\nreturns a `Size`.\n\nThis method should only be called as part of the request_layout or prepaint phase of element drawing.", "signature": "pub fn request_measured_layout (& mut self, style : Style, measure : F) -> LayoutId where F : Fn (Size>, Size, & mut Window, & mut App) -> Size + 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::resize", "name": "resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Set the content size of the window. May do nothing on mobile; use [`Self::try_resize`] to receive a refusal.", "documentation": "Set the content size of the window.\nMay do nothing on mobile; use [`Self::try_resize`] to receive a refusal.", "signature": "pub fn resize (& mut self, size : Size)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::root", "name": "root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the root entity of the window, if it has one.", "documentation": "Returns the root entity of the window, if it has one.", "signature": "pub fn root (& self) -> Option>> where E : 'static + Render,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::scale_factor", "name": "scale_factor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The scale factor of the display associated with the window. For example, it could return 2.0 for a \"retina\" display, indicating that each logical pixel should actually be rendered as two pixels on screen.", "documentation": "The scale factor of the display associated with the window. For example, it could\nreturn 2.0 for a \"retina\" display, indicating that each logical pixel should actually\nbe rendered as two pixels on screen.", "signature": "pub fn scale_factor (& self) -> f32", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::select_all_in_selection_scope", "name": "select_all_in_selection_scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Selects every participant of one scope, end to end.", "documentation": "Selects every participant of one scope, end to end.", "signature": "pub fn select_all_in_selection_scope (& mut self, scope : SelectionScopeId)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::selection_participant_contains", "name": "selection_participant_contains", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Whether a window position lands inside a participant of `scope`.", "documentation": "Whether a window position lands inside a participant of `scope`.\n\nA press that lands nowhere is how a document selection is dismissed,\nso this answers a question about the gesture rather than about paint.", "signature": "pub fn selection_participant_contains (& self, scope : SelectionScopeId, position : Point,) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::selection_scope", "name": "selection_scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The selection scope the element currently being drawn belongs to.", "documentation": "The selection scope the element currently being drawn belongs to.", "signature": "pub fn selection_scope (& self) -> SelectionScopeId", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_app_id", "name": "set_app_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the application identifier.", "documentation": "Sets the application identifier.", "signature": "pub fn set_app_id (& mut self, app_id : & str)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_back_enabled", "name": "set_back_enabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Declare whether the host can currently consume system back.", "documentation": "Declare whether the host can currently consume system back.", "signature": "pub fn set_back_enabled (& self, enabled : bool)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_back_handler", "name": "set_back_handler", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Register the host's system-back action. The backend has no source on platforms without system back; this does not install an edge gesture.", "documentation": "Register the host's system-back action. The backend has no source on\nplatforms without system back; this does not install an edge gesture.", "signature": "pub fn set_back_handler (& self, callback : impl FnMut () + 'static)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_background_appearance", "name": "set_background_appearance", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the window background appearance.", "documentation": "Sets the window background appearance.", "signature": "pub fn set_background_appearance (& self, background_appearance : WindowBackgroundAppearance)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_client_inset", "name": "set_client_inset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "When using client side decorations, set this to the width of the invisible decorations (Wayland and X11)", "documentation": "When using client side decorations, set this to the width of the invisible decorations (Wayland and X11)", "signature": "pub fn set_client_inset (& mut self, inset : Pixels)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_cursor_style", "name": "set_cursor_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the cursor style at the platform level. This method should only be called during the paint phase of element drawing.", "documentation": "Updates the cursor style at the platform level. This method should only be called\nduring the paint phase of element drawing.", "signature": "pub fn set_cursor_style (& mut self, style : CursorStyle, hitbox : & Hitbox)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_document_path", "name": "set_document_path", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Set the path of the file this window represents. On macOS, this sets the window's accessibility document property (AXDocument).", "documentation": "Set the path of the file this window represents.\nOn macOS, this sets the window's accessibility document property (AXDocument).", "signature": "pub fn set_document_path (& self, path : Option<& std::path::Path>)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_exclusive_edge", "name": "set_exclusive_edge", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Set which anchored edge a layer-shell surface's exclusive zone applies to. This is only needed to disambiguate a corner-anchored surface; otherwise the edge is deduced from the anchor. The edge must be a single edge the surface is anchored to, or it is ignored. (Wayland layer-shell windows only)", "documentation": "Set which anchored edge a layer-shell surface's exclusive zone applies to.\nThis is only needed to disambiguate a corner-anchored surface; otherwise the\nedge is deduced from the anchor. The edge must be a single edge the surface\nis anchored to, or it is ignored. (Wayland layer-shell windows only)", "signature": "pub fn set_exclusive_edge (& self, edge : crate::layer_shell::Anchor)", "cfg": [ "cfg (all (target_os = \"linux\", feature = \"wayland\"))" ], "target": "Window" }, { "id": "gpui::window::Window::set_exclusive_zone", "name": "set_exclusive_zone", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Set the exclusive zone for a layer-shell surface: how much screen space it reserves so other surfaces avoid occluding it (e.g. a panel reserving space). Positive values reserve that distance from the anchored edge, 0 lets the surface be moved out of others' exclusive zones, and -1 ignores reserved space and may extend under other surfaces. (Wayland layer-shell windows only)", "documentation": "Set the exclusive zone for a layer-shell surface: how much screen space it\nreserves so other surfaces avoid occluding it (e.g. a panel reserving space).\nPositive values reserve that distance from the anchored edge, 0 lets the\nsurface be moved out of others' exclusive zones, and -1 ignores reserved\nspace and may extend under other surfaces. (Wayland layer-shell windows only)", "signature": "pub fn set_exclusive_zone (& self, zone : Pixels)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_focus_handle", "name": "set_focus_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the focus handle for the current element. This handle will be used to manage focus state and keyboard event dispatch for the element.", "documentation": "Sets the focus handle for the current element. This handle will be used to manage focus state\nand keyboard event dispatch for the element.\n\nThis method should only be called as part of the prepaint phase of element drawing.", "signature": "pub fn set_focus_handle (& mut self, focus_handle : & FocusHandle, _ : & App)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_input_region", "name": "set_input_region", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Linux (wayland) only: Set the window's input region, the area that receives pointer and touch input. Events outside it pass through to whatever is below the window.", "documentation": "Linux (wayland) only: Set the window's input region, the area that receives pointer\nand touch input. Events outside it pass through to whatever is below the window.\n\n- `Some(rects)` restricts input to the union of `rects`, in window coordinates.\n- `Some(&[])` is an empty region, so the window receives no pointer or touch input.\n- `None` resets the region to the default, so the whole window receives input again.", "signature": "pub fn set_input_region (& self, region : Option<& [Bounds]>)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_key_context", "name": "set_key_context", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the key context for the current element. This context will be used to translate keybindings into actions.", "documentation": "Sets the key context for the current element. This context will be used to translate\nkeybindings into actions.\n\nThis method should only be called as part of the paint phase of element drawing.", "signature": "pub fn set_key_context (& mut self, context : KeyContext)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_modifiers", "name": "set_modifiers", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "For testing: set the current modifier keys state. This does not generate any events.", "documentation": "For testing: set the current modifier keys state.\nThis does not generate any events.", "signature": "pub fn set_modifiers (& mut self, modifiers : Modifiers)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::set_rem_size", "name": "set_rem_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the size of an em for the base font of the application. Adjusting this value allows the UI to scale, just like zooming a web page.", "documentation": "Sets the size of an em for the base font of the application. Adjusting this value allows the\nUI to scale, just like zooming a web page.", "signature": "pub fn set_rem_size (& mut self, rem_size : impl Into)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_scale_factor", "name": "set_scale_factor", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Overrides the display scale factor for tests.", "documentation": "Overrides the display scale factor for tests.", "signature": "pub fn set_scale_factor (& mut self, scale_factor : f32)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::set_tabbing_identifier", "name": "set_tabbing_identifier", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the tabbing identifier for the window. This is macOS specific.", "documentation": "Sets the tabbing identifier for the window.\nThis is macOS specific.", "signature": "pub fn set_tabbing_identifier (& self, tabbing_identifier : Option)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_tooltip", "name": "set_tooltip", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets a tooltip to be rendered for the upcoming frame. This method should only be called during the paint phase of element drawing.", "documentation": "Sets a tooltip to be rendered for the upcoming frame. This method should only be called\nduring the paint phase of element drawing.", "signature": "pub fn set_tooltip (& mut self, tooltip : AnyTooltip) -> TooltipId", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_touch_prediction_enabled", "name": "set_touch_prediction_enabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets whether recognized touch pans may use the platform's predicted touch positions. Disabling drops [`TouchEvent::predicted_position`] before gesture recognition, so pans track only raw touch positions.", "documentation": "Sets whether recognized touch pans may use the platform's predicted\ntouch positions. Disabling drops [`TouchEvent::predicted_position`]\nbefore gesture recognition, so pans track only raw touch positions.", "signature": "pub fn set_touch_prediction_enabled (& mut self, enabled : bool)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_traffic_light_position", "name": "set_traffic_light_position", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the position of the macOS traffic light buttons.", "documentation": "Sets the position of the macOS traffic light buttons.", "signature": "pub fn set_traffic_light_position (& self, position : Point)", "cfg": [ "cfg (target_os = \"macos\")" ], "target": "Window" }, { "id": "gpui::window::Window::set_view_id", "name": "set_view_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Sets the view id for the current element, which will be used to manage view caching.", "documentation": "Sets the view id for the current element, which will be used to manage view caching.\n\nThis method should only be called as part of element prepaint. We plan on removing this\nmethod eventually when we solve some issues that require us to construct editor elements\ndirectly instead of always using editors via views.", "signature": "pub fn set_view_id (& mut self, view_id : EntityId)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_window_cursor_style", "name": "set_window_cursor_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the cursor style for the entire window at the platform level. A cursor style using this method will have precedence over any cursor style set using `set_cursor_style`. This method should only be called during the paint phase of element drawing.", "documentation": "Updates the cursor style for the entire window at the platform level. A cursor\nstyle using this method will have precedence over any cursor style set using\n`set_cursor_style`. This method should only be called during the paint\nphase of element drawing.", "signature": "pub fn set_window_cursor_style (& mut self, style : CursorStyle)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_window_edited", "name": "set_window_edited", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Mark the window as dirty at the platform level.", "documentation": "Mark the window as dirty at the platform level.", "signature": "pub fn set_window_edited (& mut self, edited : bool)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::set_window_title", "name": "set_window_title", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the window's title at the platform level.", "documentation": "Updates the window's title at the platform level.", "signature": "pub fn set_window_title (& mut self, title : & str)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::show_character_palette", "name": "show_character_palette", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Show the platform character palette.", "documentation": "Show the platform character palette.", "signature": "pub fn show_character_palette (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::show_context_menu", "name": "show_context_menu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Presents `menu` as an operating-system context menu at a position in this window's logical coordinate space.", "documentation": "Presents `menu` as an operating-system context menu at a position in\nthis window's logical coordinate space.\n\nThe native tracking loop begins after the current GPUI callback has\nreturned. Selection dispatches the item's [`Action`] through the focus\nand explicit EffectOwner captured here, then resolves the returned\nsession. Each session is a fresh revision: cancel it before changing its\nsource actions. Cancelled/replaced revisions cannot dispatch queued\ncommands. Only [`crate::NativeMenuError::NotSupported`] permits fallback.\nNative failure/transport loss reports Unavailable, never fake dismissal.", "signature": "pub fn show_context_menu (& mut self, menu : crate::Menu, position : Point, cx : & mut App,) -> std::result::Result", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::show_window_menu", "name": "show_window_menu", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Opens the native title bar context menu, useful when implementing client side decorations (Wayland and X11)", "documentation": "Opens the native title bar context menu, useful when implementing client side decorations (Wayland and X11)", "signature": "pub fn show_window_menu (& self, position : Point)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::simulate_mouse_move", "name": "simulate_mouse_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "For testing: simulate a mouse move event to the given position. This dispatches the event through the normal event handling path, which will trigger hover states and tooltips.", "documentation": "For testing: simulate a mouse move event to the given position.\nThis dispatches the event through the normal event handling path,\nwhich will trigger hover states and tooltips.", "signature": "pub fn simulate_mouse_move (& mut self, position : Point, cx : & mut App)", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::simulate_next_frame", "name": "simulate_next_frame", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Runs all callbacks scheduled via [`Self::on_next_frame`], returning how many ran.", "documentation": "Runs all callbacks scheduled via [`Self::on_next_frame`], returning how many ran.\n\nTests have no platform frame loop, so this simulates the delivery of the\nnext frame.", "signature": "pub fn simulate_next_frame (& mut self, cx : & mut App) -> usize", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::spawn", "name": "spawn", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Spawn the future returned by the given closure on the application thread pool. The closure is provided a handle to the current window and an `AsyncWindowContext` for use within your future.", "documentation": "Spawn the future returned by the given closure on the application thread pool.\nThe closure is provided a handle to the current window and an `AsyncWindowContext` for\nuse within your future.", "signature": "pub fn spawn (& self, cx : & App, f : AsyncFn) -> Task where R : 'static, AsyncFn : AsyncFnOnce (& mut AsyncWindowContext) -> R + 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::spawn_with_priority", "name": "spawn_with_priority", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Spawn the future returned by the given closure on the application thread pool, with the given priority. The closure is provided a handle to the current window and an `AsyncWindowContext` for use within your future.", "documentation": "Spawn the future returned by the given closure on the application thread\npool, with the given priority. The closure is provided a handle to the\ncurrent window and an `AsyncWindowContext` for use within your future.", "signature": "pub fn spawn_with_priority (& self, priority : Priority, cx : & App, f : AsyncFn,) -> Task where R : 'static, AsyncFn : AsyncFnOnce (& mut AsyncWindowContext) -> R + 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::start_window_move", "name": "start_window_move", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Handle window movement for Linux and macOS. Tells the compositor to take control of window movement (Wayland and X11)", "documentation": "Handle window movement for Linux and macOS.\nTells the compositor to take control of window movement (Wayland and X11)\n\nEvents may not be received during a move operation.", "signature": "pub fn start_window_move (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::start_window_resize", "name": "start_window_resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Start an interactive window resize operation if this window is resizable.", "documentation": "Start an interactive window resize operation if this window is resizable.", "signature": "pub fn start_window_resize (& self, edge : ResizeEdge)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::subscribe", "name": "subscribe", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Subscribe to events emitted by a entity. The entity to which you're subscribing must implement the [`EventEmitter`] trait. The callback will be invoked a handle to the emitting entity, the event, and a window context for the current window.", "documentation": "Subscribe to events emitted by a entity.\nThe entity to which you're subscribing must implement the [`EventEmitter`] trait.\nThe callback will be invoked a handle to the emitting entity, the event, and a window context for the current window.", "signature": "pub fn subscribe (& mut self, entity : & Entity, cx : & mut App, mut on_event : impl FnMut (Entity, & Evt, & mut Window, & mut App) + 'static,) -> Subscription where Emitter : EventEmitter, Evt : 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::tab_bar_visible", "name": "tab_bar_visible", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the tab bar visibility. This is macOS specific.", "documentation": "Returns the tab bar visibility.\nThis is macOS specific.", "signature": "pub fn tab_bar_visible (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::tabbed_windows", "name": "tabbed_windows", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns a list of all tabbed windows and their titles. This is macOS specific.", "documentation": "Returns a list of all tabbed windows and their titles.\nThis is macOS specific.", "signature": "pub fn tabbed_windows (& self) -> Option>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::take_autoscroll", "name": "take_autoscroll", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "This method can be called from a containing element such as [`crate::List`] to support the autoscroll behavior described in [`Self::request_autoscroll`].", "documentation": "This method can be called from a containing element such as [`crate::List`] to support the autoscroll behavior\ndescribed in [`Self::request_autoscroll`].", "signature": "pub fn take_autoscroll (& mut self) -> Option>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::text_input_state_changed", "name": "text_input_state_changed", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Notify native text services after caller-owned content or selection changes. Focus and keyboard-options changes are tracked during paint.", "documentation": "Notify native text services after caller-owned content or selection\nchanges. Focus and keyboard-options changes are tracked during paint.", "signature": "pub fn text_input_state_changed (& self, change : crate::TextInputStateChange)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::text_style", "name": "text_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The current text style. Which is composed of all the style refinements provided to `with_text_style`.", "documentation": "The current text style. Which is composed of all the style refinements provided to `with_text_style`.", "signature": "pub fn text_style (& self) -> TextStyle", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::text_system", "name": "text_system", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Accessor for the text system.", "documentation": "Accessor for the text system.", "signature": "pub fn text_system (& self) -> & Arc", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::titlebar_double_click", "name": "titlebar_double_click", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Perform titlebar double-click action. This is macOS specific.", "documentation": "Perform titlebar double-click action.\nThis is macOS specific.", "signature": "pub fn titlebar_double_click (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::to_async", "name": "to_async", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates an [`AsyncWindowContext`], which has a static lifetime and can be held across await points in async code.", "documentation": "Creates an [`AsyncWindowContext`], which has a static lifetime and can be held across\nawait points in async code.", "signature": "pub fn to_async (& self, cx : & App) -> AsyncWindowContext", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::toggle_fullscreen", "name": "toggle_fullscreen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Toggle full screen status on the current window at the platform level. May do nothing on mobile; use [`Self::try_toggle_fullscreen`].", "documentation": "Toggle full screen status on the current window at the platform level.\nMay do nothing on mobile; use [`Self::try_toggle_fullscreen`].", "signature": "pub fn toggle_fullscreen (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::toggle_inspector", "name": "toggle_inspector", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Toggles the inspector mode on this window.", "documentation": "Toggles the inspector mode on this window.", "signature": "pub fn toggle_inspector (& mut self, cx : & mut App)", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ], "target": "Window" }, { "id": "gpui::window::Window::toggle_window_tab_overview", "name": "toggle_window_tab_overview", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Shows or hides the window tab overview. This is macOS specific.", "documentation": "Shows or hides the window tab overview.\nThis is macOS specific.", "signature": "pub fn toggle_window_tab_overview (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::touch_prediction_enabled", "name": "touch_prediction_enabled", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Whether recognized touch pans may use the platform's predicted touch positions ([`TouchEvent::predicted_position`]) to compensate for input latency. Defaults to true.", "documentation": "Whether recognized touch pans may use the platform's predicted touch\npositions ([`TouchEvent::predicted_position`]) to compensate for input\nlatency. Defaults to true.", "signature": "pub fn touch_prediction_enabled (& self) -> bool", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::transact", "name": "transact", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Perform prepaint on child elements in a \"retryable\" manner, so that any side effects of prepaints can be discarded before prepainting again. This is used to support autoscroll where we need to prepaint children to detect the autoscroll bounds, then adjust the element offset and prepaint again. See [`crate::List`] for an example. This method should only be called during the prepaint phase of element drawing.", "documentation": "Perform prepaint on child elements in a \"retryable\" manner, so that any side effects\nof prepaints can be discarded before prepainting again. This is used to support autoscroll\nwhere we need to prepaint children to detect the autoscroll bounds, then adjust the\nelement offset and prepaint again. See [`crate::List`] for an example. This method should only be\ncalled during the prepaint phase of element drawing.", "signature": "pub fn transact (& mut self, f : impl FnOnce (& mut Self) -> Result) -> Result", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::try_minimize_window", "name": "try_minimize_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks and requests native minimization on the owner UI thread.", "documentation": "Checks and requests native minimization on the owner UI thread.", "signature": "pub fn try_minimize_window (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::try_resize", "name": "try_resize", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks and requests a content size on the owner UI thread. Success means accepted, not that an asynchronous native resize has completed.", "documentation": "Checks and requests a content size on the owner UI thread. Success means\naccepted, not that an asynchronous native resize has completed.", "signature": "pub fn try_resize (& mut self, size : Size) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::try_toggle_fullscreen", "name": "try_toggle_fullscreen", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks and requests a fullscreen transition on the owner UI thread.", "documentation": "Checks and requests a fullscreen transition on the owner UI thread.", "signature": "pub fn try_toggle_fullscreen (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::try_zoom_window", "name": "try_zoom_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Checks and requests native zoom on the owner UI thread.", "documentation": "Checks and requests native zoom on the owner UI thread.", "signature": "pub fn try_zoom_window (& self) -> Result<(), crate::PlatformOperationError>", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::use_asset", "name": "use_asset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Asynchronously load an asset, if the asset hasn't finished loading this will return None. Your view will be re-drawn once the asset has finished loading.", "documentation": "Asynchronously load an asset, if the asset hasn't finished loading this will return None.\nYour view will be re-drawn once the asset has finished loading.\n\nNote that the multiple calls to this method will only result in one `Asset::load` call at a\ntime.", "signature": "pub fn use_asset (& mut self, source : & A::Source, cx : & mut App) -> Option", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::use_keyed_state", "name": "use_keyed_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Use a piece of state that exists as long this element is being rendered in consecutive frames.", "documentation": "Use a piece of state that exists as long this element is being rendered in consecutive frames.", "signature": "pub fn use_keyed_state (& mut self, key : impl Into, cx : & mut App, init : impl FnOnce (& mut Self, & mut Context) -> S,) -> Entity", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::use_state", "name": "use_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Use a piece of state that exists as long this element is being rendered in consecutive frames, without needing to specify a key", "documentation": "Use a piece of state that exists as long this element is being rendered in consecutive frames, without needing to specify a key\n\nNOTE: This method uses the location of the caller to generate an ID for this state.\nIf this is not sufficient to identify your state (e.g. you're rendering a list item),\nyou can provide a custom ElementID using the `use_keyed_state` method.", "signature": "pub fn use_state (& mut self, cx : & mut App, init : impl FnOnce (& mut Self, & mut Context) -> S,) -> Entity", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::viewport_size", "name": "viewport_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the size of the drawable area within the window.", "documentation": "Returns the size of the drawable area within the window.", "signature": "pub fn viewport_size (& self) -> Size", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::visual_transform", "name": "visual_transform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "The inherited layout-to-display mapping. Capture during prepaint for semantic measurement (`map_bounds`) or pointer handlers (`unmap_point`). Layout callbacks and event positions are not implicitly rewritten.", "documentation": "The inherited layout-to-display mapping. Capture during prepaint for\nsemantic measurement (`map_bounds`) or pointer handlers (`unmap_point`).\nLayout callbacks and event positions are not implicitly rewritten.", "signature": "pub fn visual_transform (& self) -> crate::VisualTransform", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::window_bounds", "name": "window_bounds", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Return the `WindowBounds` to indicate that how a window should be opened after it has been closed", "documentation": "Return the `WindowBounds` to indicate that how a window should be opened\nafter it has been closed", "signature": "pub fn window_bounds (& self) -> WindowBounds", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::window_control_area_at", "name": "window_control_area_at", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the custom window-control area at `position` in the latest rendered frame.", "documentation": "Returns the custom window-control area at `position` in the latest\nrendered frame.\n\nThis test-support API verifies client title-bar hit testing without a\nnative compositor. Later-painted nested areas take precedence over an\nenclosing drag area, matching the platform callback.", "signature": "pub fn window_control_area_at (& self, position : Point) -> Option", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "Window" }, { "id": "gpui::window::Window::window_controls", "name": "window_controls", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns the controls supported by the platform.", "documentation": "Returns the controls supported by the platform.", "signature": "pub fn window_controls (& self) -> WindowControls", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::window_decorations", "name": "window_decorations", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Returns whether the title bar window controls need to be rendered by the application (Wayland and X11)", "documentation": "Returns whether the title bar window controls need to be rendered by the application (Wayland and X11)", "signature": "pub fn window_decorations (& self) -> Decorations", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::window_handle", "name": "window_handle", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Obtain GPUI's [`AnyWindowHandle`] for the window that belongs to this context.", "documentation": "Obtain GPUI's [`AnyWindowHandle`] for the window that belongs to this\ncontext.\n\nThis is not the operating system window handle. [`Window`] also\nimplements [`raw_window_handle::HasWindowHandle`]; because this inherent\nmethod has the same name as that trait method, callers that need a raw\nhandle must use its fully qualified form:\n`raw_window_handle::HasWindowHandle::window_handle(window)`.", "signature": "pub fn window_handle (& self) -> AnyWindowHandle", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::window_title", "name": "window_title", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Gets the window's title at the platform level. This is macOS specific.", "documentation": "Gets the window's title at the platform level.\nThis is macOS specific.", "signature": "pub fn window_title (& self) -> String", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_absolute_element_offset", "name": "with_absolute_element_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the global element offset based on the given offset. This is used to implement drag handles and other manual painting of elements. This method should only be called during the prepaint phase of element drawing.", "documentation": "Updates the global element offset based on the given offset. This is used to implement\ndrag handles and other manual painting of elements. This method should only be called during\nthe prepaint phase of element drawing.", "signature": "pub fn with_absolute_element_offset (& mut self, offset : Point, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_content_mask", "name": "with_content_mask", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Invoke the given function with the given content mask after intersecting it with the current mask. This method should only be called during element drawing.", "documentation": "Invoke the given function with the given content mask after intersecting it\nwith the current mask. This method should only be called during element drawing.", "signature": "pub fn with_content_mask (& mut self, mask : Option>, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_edge_fade", "name": "with_edge_fade", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Executes the provided function with a vertical [`EdgeFade`] applied: every primitive painted inside is additionally faded by its vertical position — full alpha in the region's body, ramping to zero across `fade.band` at each active edge. Granularity is per-primitive (each quad/glyph/sprite takes the ramp value at its own position), which reads as a smooth gradient for text and small marks.", "documentation": "Executes the provided function with a vertical [`EdgeFade`] applied:\nevery primitive painted inside is additionally faded by its vertical\nposition — full alpha in the region's body, ramping to zero across\n`fade.band` at each active edge. Granularity is per-primitive (each\nquad/glyph/sprite takes the ramp value at its own position), which\nreads as a smooth gradient for text and small marks.", "signature": "pub fn with_edge_fade (& mut self, fade : Option, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_element_namespace", "name": "with_element_namespace", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Provide elements in the called function with a new namespace in which their identifiers must be unique. This can be used within a custom element to distinguish multiple sets of child elements.", "documentation": "Provide elements in the called function with a new namespace in which their identifiers must be unique.\nThis can be used within a custom element to distinguish multiple sets of child elements.", "signature": "pub fn with_element_namespace (& mut self, element_id : impl Into, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_element_offset", "name": "with_element_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the global element offset relative to the current offset. This is used to implement scrolling. This method should only be called during the prepaint phase of element drawing.", "documentation": "Updates the global element offset relative to the current offset. This is used to implement\nscrolling. This method should only be called during the prepaint phase of element drawing.", "signature": "pub fn with_element_offset (& mut self, offset : Point, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_element_state", "name": "with_element_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates or initializes state for an element with the given id that lives across multiple frames. If an element with this ID existed in the rendered frame, its state will be passed to the given closure. The state returned by the closure will be stored so it can be referenced when drawing the next frame. This method should only be called as part of element drawing.", "documentation": "Updates or initializes state for an element with the given id that lives across multiple\nframes. If an element with this ID existed in the rendered frame, its state will be passed\nto the given closure. The state returned by the closure will be stored so it can be referenced\nwhen drawing the next frame. This method should only be called as part of element drawing.", "signature": "pub fn with_element_state (& mut self, global_id : & GlobalElementId, f : impl FnOnce (Option, & mut Self) -> (R, S),) -> R where S : 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_global_id", "name": "with_global_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Acquire a globally unique identifier for the given ElementId. Only valid for the duration of the provided closure.", "documentation": "Acquire a globally unique identifier for the given ElementId.\nOnly valid for the duration of the provided closure.", "signature": "pub fn with_global_id (& mut self, element_id : ElementId, f : impl FnOnce (& GlobalElementId, & mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_id", "name": "with_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Calls the provided closure with the element ID pushed on the stack.", "documentation": "Calls the provided closure with the element ID pushed on the stack.", "signature": "pub fn with_id (& mut self, element_id : impl Into, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_image_cache", "name": "with_image_cache", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Executes the provided function with the specified image cache.", "documentation": "Executes the provided function with the specified image cache.", "signature": "pub fn with_image_cache (& mut self, image_cache : Option, f : F) -> R where F : FnOnce (& mut Self) -> R,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_inspector_state", "name": "with_inspector_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Executes the provided function with mutable access to an inspector state.", "documentation": "Executes the provided function with mutable access to an inspector state.", "signature": "pub fn with_inspector_state (& mut self, _inspector_id : Option<& crate::InspectorElementId>, cx : & mut App, f : impl FnOnce (& mut Option, & mut Self) -> R,) -> R", "cfg": [ "cfg (any (feature = \"inspector\", debug_assertions))" ], "target": "Window" }, { "id": "gpui::window::Window::with_optional_element_state", "name": "with_optional_element_state", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A variant of `with_element_state` that allows the element's id to be optional. This is a convenience method for elements where the element id may or may not be assigned. Prefer using `with_element_state` when the element is guaranteed to have an id.", "documentation": "A variant of `with_element_state` that allows the element's id to be optional. This is a convenience\nmethod for elements where the element id may or may not be assigned. Prefer using `with_element_state`\nwhen the element is guaranteed to have an id.\n\nThe first option means 'no ID provided'\nThe second option means 'not yet initialized'", "signature": "pub fn with_optional_element_state (& mut self, global_id : Option<& GlobalElementId>, f : impl FnOnce (Option>, & mut Self) -> (R, Option),) -> R where S : 'static,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_placed_element_offset", "name": "with_placed_element_offset", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Places a root-laid-out subtree at `origin`, identifying `scroll_offset` as ambient scrolling rather than layout placement. Virtualizers supply their actual slot origin and scroll offset, not a second layout estimate.", "documentation": "Places a root-laid-out subtree at `origin`, identifying `scroll_offset`\nas ambient scrolling rather than layout placement. Virtualizers supply\ntheir actual slot origin and scroll offset, not a second layout estimate.\n\nRendering, clipping, input and accessibility use the same absolute\nplacement as `with_absolute_element_offset`. The additional metadata lets\nlayout motion distinguish a reordered slot from scrolling or ancestor\nslides. Nested placement composes in the parent's content coordinates.\nCall only during prepaint.", "signature": "pub fn with_placed_element_offset (& mut self, origin : Point, scroll_offset : Point, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_rem_size", "name": "with_rem_size", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Executes the provided function with the specified rem size.", "documentation": "Executes the provided function with the specified rem size.\n\nThis method must only be called as part of element drawing.", "signature": "pub fn with_rem_size (& mut self, rem_size : Option>, f : F) -> R where F : FnOnce (& mut Self) -> R,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_rounded_content_mask", "name": "with_rounded_content_mask", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Clips all descendants to a rounded rectangle in window coordinates. Enter the same scope in prepaint and paint. Pointer input evaluates the full inherited chain; accessibility exposes its conservative rectangle. This affects primitive writes, never the source sampled by backdrop optics.", "documentation": "Clips all descendants to a rounded rectangle in window coordinates.\nEnter the same scope in prepaint and paint. Pointer input evaluates the\nfull inherited chain; accessibility exposes its conservative rectangle.\nThis affects primitive writes, never the source sampled by backdrop optics.", "signature": "pub fn with_rounded_content_mask (& mut self, clip : crate::RoundedClip, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_selection_scope", "name": "with_selection_scope", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Draws `f` inside an isolated text-selection scope.", "documentation": "Draws `f` inside an isolated text-selection scope.\n\nA drag started inside the scope never reaches text outside it, and text\noutside it never joins a selection started within. This is what keeps a\ndialog mounted over a document from being selected together with it.", "signature": "pub fn with_selection_scope (& mut self, scope : SelectionScopeId, f : F) -> R where F : FnOnce (& mut Self) -> R,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_tab_group", "name": "with_tab_group", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Executes the given closure within the context of a tab group.", "documentation": "Executes the given closure within the context of a tab group.", "signature": "pub fn with_tab_group (& mut self, index : Option, f : impl FnOnce (& mut Self) -> R) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_text_style", "name": "with_text_style", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Push a text style onto the stack, and call a function with that style active. Use [`Window::text_style`] to get the current, combined text style. This method should only be called as part of element drawing.", "documentation": "Push a text style onto the stack, and call a function with that style active.\nUse [`Window::text_style`] to get the current, combined text style. This method\nshould only be called as part of element drawing.", "signature": "pub fn with_text_style (& mut self, style : Option, f : F) -> R where F : FnOnce (& mut Self) -> R,", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::with_visual_scale", "name": "with_visual_scale", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Uniformly scales descendant visuals, not layout, about an origin in this scope's layout/window coordinates. Enter identical scopes during prepaint and paint. Nested transforms apply inner first, then outer. Clips introduced outside stay fixed; clips introduced inside move with the scope. Hitboxes and accessibility follow displayed geometry. Glyph and SVG raster resolution includes the effective scale, without reshaping. Cached/deferred elements retain the mapping. Native hosted views refuse nonidentity transforms rather than resizing/reflowing their native frames. Events remain window-global: handlers comparing layout bounds must capture `visual_transform()` during prepaint and inverse-map event positions.", "documentation": "Uniformly scales descendant visuals, not layout, about an origin in\nthis scope's layout/window coordinates. Enter identical scopes during\nprepaint and paint. Nested transforms apply inner first, then outer.\nClips introduced outside stay fixed; clips introduced inside move with\nthe scope. Hitboxes and accessibility follow displayed geometry. Glyph\nand SVG raster resolution includes the effective scale, without reshaping.\nCached/deferred elements retain the mapping. Native hosted views refuse\nnonidentity transforms rather than resizing/reflowing their native frames.\nEvents remain window-global: handlers comparing layout bounds must capture\n`visual_transform()` during prepaint and inverse-map event positions.", "signature": "pub fn with_visual_scale (& mut self, scale : f32, origin : Point, f : impl FnOnce (& mut Self) -> R,) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::without_content_masks", "name": "without_content_masks", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Temporarily removes inherited rectangular and rounded content masks. The window viewport remains the outer rendering/input boundary. Masks introduced inside the closure still apply; ancestor masks are restored afterwards. Use identical scopes in prepaint and paint so hit testing and conservative accessibility bounds agree with visible output.", "documentation": "Temporarily removes inherited rectangular and rounded content masks.\nThe window viewport remains the outer rendering/input boundary. Masks\nintroduced inside the closure still apply; ancestor masks are restored\nafterwards. Use identical scopes in prepaint and paint so hit testing\nand conservative accessibility bounds agree with visible output.\n\nThis does not change layout, element offsets, visual transforms, or\naccessibility ancestry. Bounds remain logical window coordinates and\nevents remain displayed window coordinates. Deferred draws scheduled\nhere capture the cleared rounded chain and the unchanged transform.", "signature": "pub fn without_content_masks (& mut self, f : impl FnOnce (& mut Self) -> R) -> R", "cfg": [], "target": "Window" }, { "id": "gpui::window::Window::zoom_window", "name": "zoom_window", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Toggle zoom on the window. May do nothing on mobile; use [`Self::try_zoom_window`].", "documentation": "Toggle zoom on the window.\nMay do nothing on mobile; use [`Self::try_zoom_window`].", "signature": "pub fn zoom_window (& self)", "cfg": [], "target": "Window" }, { "id": "gpui::window::WindowControlArea", "name": "WindowControlArea", "kind": "enum", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A type of window control area that corresponds to the platform window.", "documentation": "A type of window control area that corresponds to the platform window.", "signature": "# [doc = \" A type of window control area that corresponds to the platform window.\"] # [derive (Clone, Copy, Debug, Eq, PartialEq)] pub enum WindowControlArea { # [doc = \" An ordinary client area nested inside custom window chrome.\"] # [doc = \"\"] # [doc = \" Use this for interactive content inside a surrounding [`Self::Drag`]\"] # [doc = \" area so the operating system does not treat the nested content as a\"] # [doc = \" caption gesture.\"] Client, # [doc = \" An area that allows dragging of the platform window.\"] Drag, # [doc = \" An area that allows closing of the platform window.\"] Close, # [doc = \" An area that allows maximizing of the platform window.\"] Max, # [doc = \" An area that allows minimizing of the platform window.\"] Min, }", "cfg": [] }, { "id": "gpui::window::WindowFocusEvent::is_focus_in", "name": "is_focus_in", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn is_focus_in (& self, focus_id : FocusId) -> bool", "cfg": [], "target": "WindowFocusEvent" }, { "id": "gpui::window::WindowFocusEvent::is_focus_out", "name": "is_focus_out", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn is_focus_out (& self, focus_id : FocusId) -> bool", "cfg": [], "target": "WindowFocusEvent" }, { "id": "gpui::window::WindowHandle", "name": "WindowHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "A handle to a window with a specific root view type. Note that this does not keep the window alive on its own.", "documentation": "A handle to a window with a specific root view type.\nNote that this does not keep the window alive on its own.", "signature": "# [doc = \" A handle to a window with a specific root view type.\"] # [doc = \" Note that this does not keep the window alive on its own.\"] # [derive (Deref, DerefMut)] pub struct WindowHandle { # [deref] # [deref_mut] pub (crate) any_handle : AnyWindowHandle, state_type : PhantomData V>, }", "cfg": [] }, { "id": "gpui::window::WindowHandle::entity", "name": "entity", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Read the root view pointer off of this window.", "documentation": "Read the root view pointer off of this window.\n\nThis will fail if the window is closed or if the root view's type does not match `V`.", "signature": "pub fn entity (& self, cx : & C) -> Result> where C : AppContext,", "cfg": [], "target": "WindowHandle" }, { "id": "gpui::window::WindowHandle::is_active", "name": "is_active", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Check if this window is 'active'.", "documentation": "Check if this window is 'active'.\n\nWill return `None` if the window is closed or currently\nborrowed.", "signature": "pub fn is_active (& self, cx : & mut App) -> Option", "cfg": [], "target": "WindowHandle" }, { "id": "gpui::window::WindowHandle::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates a new handle from a window ID. This does not check if the root type of the window is `V`.", "documentation": "Creates a new handle from a window ID.\nThis does not check if the root type of the window is `V`.", "signature": "pub fn new (id : WindowId) -> Self", "cfg": [], "target": "WindowHandle" }, { "id": "gpui::window::WindowHandle::read", "name": "read", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Read the root view out of this window.", "documentation": "Read the root view out of this window.\n\nThis will fail if the window is closed or if the root view's type does not match `V`.", "signature": "pub fn read<'a> (& self, cx : & 'a App) -> Result<& 'a V>", "cfg": [], "target": "WindowHandle" }, { "id": "gpui::window::WindowHandle::read_with", "name": "read_with", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Read the root view out of this window, with a callback", "documentation": "Read the root view out of this window, with a callback\n\nThis will fail if the window is closed or if the root view's type does not match `V`.", "signature": "pub fn read_with (& self, cx : & C, read_with : impl FnOnce (& V, & App) -> R) -> Result where C : AppContext,", "cfg": [], "target": "WindowHandle" }, { "id": "gpui::window::WindowHandle::root", "name": "root", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Get the root view out of this window.", "documentation": "Get the root view out of this window.\n\nThis will fail if the window is closed or if the root view's type does not match `V`.", "signature": "pub fn root (& self, cx : & mut C) -> Result> where C : AppContext,", "cfg": [ "cfg (any (test, feature = \"test-support\"))" ], "target": "WindowHandle" }, { "id": "gpui::window::WindowHandle::update", "name": "update", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Updates the root view of this window.", "documentation": "Updates the root view of this window.\n\nThis will fail if the window has been closed or if the root view's type does not match", "signature": "pub fn update (& self, cx : & mut C, update : impl FnOnce (& mut V, & mut Window, & mut Context) -> R,) -> Result where C : AppContext,", "cfg": [], "target": "WindowHandle" }, { "id": "gpui::window::WindowId::as_u64", "name": "as_u64", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Converts this window ID to a `u64`.", "documentation": "Converts this window ID to a `u64`.", "signature": "pub fn as_u64 (& self) -> u64", "cfg": [], "target": "WindowId" }, { "id": "gpui::window::WindowInvalidator::debug_assert_paint", "name": "debug_assert_paint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn debug_assert_paint (& self)", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::debug_assert_paint_or_prepaint", "name": "debug_assert_paint_or_prepaint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn debug_assert_paint_or_prepaint (& self)", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::debug_assert_prepaint", "name": "debug_assert_prepaint", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn debug_assert_prepaint (& self)", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::invalidate_view", "name": "invalidate_view", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn invalidate_view (& self, entity : EntityId, cx : & mut App) -> bool", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::is_dirty", "name": "is_dirty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn is_dirty (& self) -> bool", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::new", "name": "new", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn new () -> Self", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::not_drawing", "name": "not_drawing", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn not_drawing (& self) -> bool", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::replace_views", "name": "replace_views", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn replace_views (& self, views : FxHashSet)", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::set_dirty", "name": "set_dirty", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn set_dirty (& self, dirty : bool)", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::set_phase", "name": "set_phase", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn set_phase (& self, phase : DrawPhase)", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::take_views", "name": "take_views", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn take_views (& self) -> FxHashSet", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::WindowInvalidator::update_count", "name": "update_count", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub fn update_count (& self) -> usize", "cfg": [], "target": "WindowInvalidator" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder", "name": "A11ySubtreeBuilder", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Builder API for synthetic children. See the docs for [`Element::a11y_synthetic_children`].", "documentation": "Builder API for synthetic children. See the docs for\n[`Element::a11y_synthetic_children`].", "signature": "# [doc = \" Builder API for synthetic children. See the docs for\"] # [doc = \" [`Element::a11y_synthetic_children`].\"] pub struct A11ySubtreeBuilder<'a> { parent_id : NodeId, nodes : & 'a mut A11yNodeBuilder, bounds_clip : Option, bounds_transform : crate::TransformationMatrix, # [doc = \" Provenance of the real element whose `a11y_synthetic_children` is\"] # [doc = \" running.\"] # [cfg (debug_assertions)] creator : debug::NodeCreator, }", "cfg": [] }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::bounds_clip", "name": "bounds_clip", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Physical-pixel clip applied to synthetic node bounds. A retained geometry cache must invalidate when this changes, even when its unclipped source cells are unchanged.", "documentation": "Physical-pixel clip applied to synthetic node bounds. A retained\ngeometry cache must invalidate when this changes, even when its\nunclipped source cells are unchanged.", "signature": "pub fn bounds_clip (& self) -> Option", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::bounds_transform", "name": "bounds_transform", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Physical-pixel visual mapping applied on publication. Retained geometry caches must invalidate when this changes, even if the clip stays fixed.", "documentation": "Physical-pixel visual mapping applied on publication. Retained geometry\ncaches must invalidate when this changes, even if the clip stays fixed.", "signature": "pub fn bounds_transform (& self) -> crate::TransformationMatrix", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::parent_node", "name": "parent_node", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "A mutable reference to the parent node.", "documentation": "A mutable reference to the parent node.", "signature": "pub fn parent_node (& mut self) -> & mut accesskit::Node", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::push_child", "name": "push_child", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Append a synthetic leaf node as a child of this element's node.", "documentation": "Append a synthetic leaf node as a child of this element's node.\n\nReturns `false` if a node with this id is already present in the tree,\nin which case the node is discarded. Bounds follow the real parent's\nactive content clip, but fully clipped logical nodes remain in the tree\nwith zero-area bounds at the nearest clip edge. Synthetic text and\nvirtualized collections must not lose content merely because it is\noutside the current viewport. Supply untransformed physical-pixel bounds\nand character geometry: the inherited visual transform is applied here.", "signature": "pub fn push_child (& mut self, id : NodeId, mut node : accesskit::Node) -> bool", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::retain_child", "name": "retain_child", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Keeps an unchanged synthetic leaf connected without retransmitting its payload. Returns false when it was not published in the preceding active frame; the caller must then provide a complete node with `push_child`. Never use this for a node whose clipped geometry or properties changed. Removed nodes must be republished on reattachment.", "documentation": "Keeps an unchanged synthetic leaf connected without retransmitting its\npayload. Returns false when it was not published in the preceding\nactive frame; the caller must then provide a complete node with\n`push_child`. Never use this for a node whose clipped geometry or\nproperties changed. Removed nodes must be republished on reattachment.", "signature": "pub fn retain_child (& mut self, id : NodeId) -> bool", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::set_parent_text_selection", "name": "set_parent_text_selection", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Updates the parent's selection without forcing its shared value into owned storage before the final node-retention comparison.", "documentation": "Updates the parent's selection without forcing its shared value into\nowned storage before the final node-retention comparison.", "signature": "pub fn set_parent_text_selection (& mut self, selection : accesskit::TextSelection)", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11ySubtreeBuilder::synthetic_node_id", "name": "synthetic_node_id", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Derive a [`NodeId`] for a synthetic child.", "documentation": "Derive a [`NodeId`] for a synthetic child.\n\nThe generated ID is based on the hash of `key`, as well as the parent's\nID. This means that `key`s must be unique within the same\n[`Element::a11y_synthetic_children`] call, but may be duplicated across\ndifferent calls.", "signature": "pub fn synthetic_node_id (& self, key : impl Hash) -> NodeId", "cfg": [], "target": "A11ySubtreeBuilder<'a>" }, { "id": "gpui::window::a11y::A11yValueWork", "name": "A11yValueWork", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Actual native-value copying in the last completed accessibility frame. These counters exclude geometry/child metadata, source flattening, native adapter copies and explicit platform value queries.", "documentation": "Actual native-value copying in the last completed accessibility frame.\nThese counters exclude geometry/child metadata, source flattening, native\nadapter copies and explicit platform value queries.", "signature": "# [doc = \" Actual native-value copying in the last completed accessibility frame.\"] # [doc = \" These counters exclude geometry/child metadata, source flattening, native\"] # [doc = \" adapter copies and explicit platform value queries.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct A11yValueWork { # [doc = \" UTF-8 bytes materialized from shared element values for changed nodes.\"] pub materialized_bytes : usize, # [doc = \" Complete value bytes retained natively without retransmission.\"] pub retained_bytes : usize, # [doc = \" Value bytes cloned to maintain the complete debug/inspection tree.\"] pub debug_clone_bytes : usize, # [doc = \" Bytes copied to resolve accessible label/description relationships.\"] pub relationship_bytes : usize, }", "cfg": [] }, { "id": "gpui::window::a11y::Window::accessibility_value_work", "name": "accessibility_value_work", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::a11y", "path": "gpui::window::a11y", "source": "crates/gpui/src/window/a11y.rs", "summary": "Value-copy work for the last completed native accessibility frame.", "documentation": "Value-copy work for the last completed native accessibility frame.", "signature": "pub fn accessibility_value_work (& self) -> A11yValueWork", "cfg": [], "target": "Window" }, { "id": "gpui::window::fill", "name": "fill", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates a filled quad with the given bounds and background color.", "documentation": "Creates a filled quad with the given bounds and background color.", "signature": "pub fn fill (bounds : impl Into>, background : impl Into) -> PaintQuad", "cfg": [] }, { "id": "gpui::window::outline", "name": "outline", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates a rectangle outline with the given bounds, border color, and a 1px border width", "documentation": "Creates a rectangle outline with the given bounds, border color, and a 1px border width", "signature": "pub fn outline (bounds : impl Into>, border_color : impl Into, border_style : BorderStyle,) -> PaintQuad", "cfg": [] }, { "id": "gpui::window::prompts::FallbackPromptRenderer", "name": "FallbackPromptRenderer", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "The default GPUI fallback for rendering prompts, when the platform doesn't support it.", "documentation": "The default GPUI fallback for rendering prompts, when the platform doesn't support it.", "signature": "# [doc = \" The default GPUI fallback for rendering prompts, when the platform doesn't support it.\"] pub struct FallbackPromptRenderer { _level : PromptLevel, message : String, detail : Option, actions : Vec, focus : FocusHandle, }", "cfg": [] }, { "id": "gpui::window::prompts::Prompt", "name": "Prompt", "kind": "trait", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "A prompt that can be rendered in the window.", "documentation": "A prompt that can be rendered in the window.", "signature": "# [doc = \" A prompt that can be rendered in the window.\"] pub trait Prompt : EventEmitter + Focusable { }", "cfg": [] }, { "id": "gpui::window::prompts::PromptHandle", "name": "PromptHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "A handle to a prompt that can be used to interact with it.", "documentation": "A handle to a prompt that can be used to interact with it.", "signature": "# [doc = \" A handle to a prompt that can be used to interact with it.\"] pub struct PromptHandle { sender : oneshot::Sender, }", "cfg": [] }, { "id": "gpui::window::prompts::PromptHandle::with_view", "name": "with_view", "kind": "method", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "Construct a new prompt handle from a view of the appropriate types", "documentation": "Construct a new prompt handle from a view of the appropriate types", "signature": "pub fn with_view (self, view : Entity, window : & mut Window, cx : & mut App,) -> RenderablePromptHandle", "cfg": [], "target": "PromptHandle" }, { "id": "gpui::window::prompts::PromptResponse", "name": "PromptResponse", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "The event emitted when a prompt's option is selected. The usize is the index of the selected option, from the actions passed to the prompt.", "documentation": "The event emitted when a prompt's option is selected.\nThe usize is the index of the selected option, from the actions\npassed to the prompt.", "signature": "# [doc = \" The event emitted when a prompt's option is selected.\"] # [doc = \" The usize is the index of the selected option, from the actions\"] # [doc = \" passed to the prompt.\"] pub struct PromptResponse (pub usize);", "cfg": [] }, { "id": "gpui::window::prompts::RenderablePromptHandle", "name": "RenderablePromptHandle", "kind": "struct", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "A prompt handle capable of being rendered in a window.", "documentation": "A prompt handle capable of being rendered in a window.", "signature": "# [doc = \" A prompt handle capable of being rendered in a window.\"] pub struct RenderablePromptHandle { pub (crate) view : Box, pub (crate) effect_owner : Option, }", "cfg": [] }, { "id": "gpui::window::prompts::fallback_prompt_renderer", "name": "fallback_prompt_renderer", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "window::prompts", "path": "gpui::window::prompts", "source": "crates/gpui/src/window/prompts.rs", "summary": "Use this function in conjunction with [App::set_prompt_builder] to force GPUI to always use the fallback prompt renderer.", "documentation": "Use this function in conjunction with [App::set_prompt_builder] to force\nGPUI to always use the fallback prompt renderer.", "signature": "pub fn fallback_prompt_renderer (level : PromptLevel, message : & str, detail : Option<& str>, actions : & [PromptButton], handle : PromptHandle, window : & mut Window, cx : & mut App,) -> RenderablePromptHandle", "cfg": [] }, { "id": "gpui::window::quad", "name": "quad", "kind": "function", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "Creates a quad with the given parameters.", "documentation": "Creates a quad with the given parameters.", "signature": "pub fn quad (bounds : Bounds, corner_radii : impl Into>, background : impl Into, border_widths : impl Into>, border_color : impl Into, border_style : BorderStyle,) -> PaintQuad", "cfg": [] }, { "id": "gpui::window::reexport-1", "name": "a11y :: { A11ySubtreeBuilder , A11yValueWork }", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub use a11y::{ A11ySubtreeBuilder, A11yValueWork };", "cfg": [] }, { "id": "gpui::window::reexport-2", "name": "prompts :: *", "kind": "reexport", "package": "gpui-box", "crate": "gpui", "module": "window", "path": "gpui::window", "source": "crates/gpui/src/window.rs", "summary": "", "documentation": "", "signature": "pub use prompts::*;", "cfg": [] }, { "id": "gpui_android::accessibility::Accessibility::action", "name": "action", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "accessibility", "path": "gpui_android::accessibility", "source": "crates/gpui_android/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn action (& self, virtual_id : i32, action : i32, value : Option,) -> Option", "cfg": [], "target": "Accessibility" }, { "id": "gpui_android::accessibility::Accessibility::json", "name": "json", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "accessibility", "path": "gpui_android::accessibility", "source": "crates/gpui_android/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn json (& self) -> String", "cfg": [], "target": "Accessibility" }, { "id": "gpui_android::accessibility::Accessibility::update", "name": "update", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "accessibility", "path": "gpui_android::accessibility", "source": "crates/gpui_android/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn update (& mut self, update : TreeUpdate)", "cfg": [], "target": "Accessibility" }, { "id": "gpui_android::native::AndroidPlatform", "name": "AndroidPlatform", "kind": "struct", "package": "gpui-box-android", "crate": "gpui_android", "module": "native", "path": "gpui_android::native", "source": "crates/gpui_android/src/native.rs", "summary": "One Android Activity and one top-level GPUI window. Desktop-only APIs fail explicitly; Activity identity, task placement and permissions belong to the host.", "documentation": "One Android Activity and one top-level GPUI window. Desktop-only APIs fail\nexplicitly; Activity identity, task placement and permissions belong to the host.", "signature": "# [doc = \" One Android Activity and one top-level GPUI window. Desktop-only APIs fail\"] # [doc = \" explicitly; Activity identity, task placement and permissions belong to the host.\"] pub struct AndroidPlatform { java : Arc, dispatcher : Arc, text : Arc, window : RefCell>>, display : Rc, launch : Callback, lifecycle : Callback, memory : Callback, quit : Callback, menu_action : ActionCallback<()>, menu_open : Callback, menu_validate : ActionCallback, thermal_changed : Callback, keyboard_changed : Callback, presentation : RefCell, gpu : GpuContext, surface : RefCell>, size : Cell>, scale : Cell, active : Cell, appearance : Cell, }", "cfg": [] }, { "id": "gpui_android::native::AndroidPlatform::current", "name": "current", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "native", "path": "gpui_android::native", "source": "crates/gpui_android/src/native.rs", "summary": "Returns the Activity's installed platform on its UI thread. An Android platform cannot be created without an Activity or in headless mode.", "documentation": "Returns the Activity's installed platform on its UI thread. An Android\nplatform cannot be created without an Activity or in headless mode.", "signature": "pub fn current () -> Result>", "cfg": [], "target": "AndroidPlatform" }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeAccessibility", "name": "Java_dev_gpui_box_GpuiActivity_nativeAccessibility", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeAccessibility (mut env : JNIEnv, _ : JObject, enabled : jboolean,)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeAccessibilityAction", "name": "Java_dev_gpui_box_GpuiActivity_nativeAccessibilityAction", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeAccessibilityAction (mut env : JNIEnv, _ : JObject, id : i32, action : i32, value : JString,) -> jboolean", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeBack", "name": "Java_dev_gpui_box_GpuiActivity_nativeBack", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeBack (mut env : JNIEnv, _ : JObject,) -> jboolean", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeDestroy", "name": "Java_dev_gpui_box_GpuiActivity_nativeDestroy", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeDestroy (mut env : JNIEnv, _ : JObject)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeDetach", "name": "Java_dev_gpui_box_GpuiActivity_nativeDetach", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeDetach (mut env : JNIEnv, _ : JObject)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeDrain", "name": "Java_dev_gpui_box_GpuiActivity_nativeDrain", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeDrain (mut env : JNIEnv, _ : JObject)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeEdit", "name": "Java_dev_gpui_box_GpuiActivity_nativeEdit", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "Commands operate on the authoritative GPUI UTF-16 document, not a shadow text model: 0 commit, 1 compose, 2 selection, 3 finish, 4 composing region, 5 delete range. Java BaseInputConnection calculates deletion ranges.", "documentation": "Commands operate on the authoritative GPUI UTF-16 document, not a shadow\ntext model: 0 commit, 1 compose, 2 selection, 3 finish, 4 composing region,\n5 delete range. Java BaseInputConnection calculates deletion ranges.", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeEdit (mut env : JNIEnv, _ : JObject, command : i32, text : JString, start : i32, end : i32, cursor : i32, generation : i64,) -> jboolean", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeFrame", "name": "Java_dev_gpui_box_GpuiActivity_nativeFrame", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeFrame (mut env : JNIEnv, _ : JObject)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeInputSnapshot", "name": "Java_dev_gpui_box_GpuiActivity_nativeInputSnapshot", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeInputSnapshot (mut env : JNIEnv, _ : JObject, generation : i64,) -> jstring", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeInsets", "name": "Java_dev_gpui_box_GpuiActivity_nativeInsets", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeInsets (mut env : JNIEnv, _ : JObject, values : JIntArray,)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeLifecycle", "name": "Java_dev_gpui_box_GpuiActivity_nativeLifecycle", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeLifecycle (mut env : JNIEnv, _ : JObject, phase : i32,)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeMemory", "name": "Java_dev_gpui_box_GpuiActivity_nativeMemory", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeMemory (mut env : JNIEnv, _ : JObject)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativePresentedFrames", "name": "Java_dev_gpui_box_GpuiActivity_nativePresentedFrames", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativePresentedFrames (mut env : JNIEnv, _ : JObject,) -> i64", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeSettingsChanged", "name": "Java_dev_gpui_box_GpuiActivity_nativeSettingsChanged", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeSettingsChanged (mut env : JNIEnv, _ : JObject, thermal : jboolean,)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeSurface", "name": "Java_dev_gpui_box_GpuiActivity_nativeSurface", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeSurface (mut env : JNIEnv, _ : JObject, surface : JObject, width : i32, height : i32, scale : f32,)", "cfg": [] }, { "id": "gpui_android::native::events::Java_dev_gpui_box_GpuiActivity_nativeTouch", "name": "Java_dev_gpui_box_GpuiActivity_nativeTouch", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::events", "path": "gpui_android::native::events", "source": "crates/gpui_android/src/native/events.rs", "summary": "", "documentation": "", "signature": "pub extern \"system\" fn Java_dev_gpui_box_GpuiActivity_nativeTouch (mut env : JNIEnv, _ : JObject, action : i32, ids : JIntArray, xs : JFloatArray, ys : JFloatArray, pressures : JFloatArray,)", "cfg": [] }, { "id": "gpui_android::native::initialize", "name": "initialize", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "native", "path": "gpui_android::native", "source": "crates/gpui_android/src/native.rs", "summary": "Installs one Activity on its Android UI thread. The Activity must use the accompanying GpuiActivity Java class. Call once from its nativeCreate method. Return Application::run_embedded's handle; this host retains it until Activity destruction. Android continues owning the run loop.", "documentation": "Installs one Activity on its Android UI thread. The Activity must use the\naccompanying GpuiActivity Java class. Call once from its nativeCreate method.\nReturn Application::run_embedded's handle; this host retains it until\nActivity destruction. Android continues owning the run loop.", "signature": "pub fn initialize (env : & mut JNIEnv<'_>, activity : JObject<'_>, launch : impl FnOnce (Rc) -> ApplicationHandle,) -> Result<()>", "cfg": [] }, { "id": "gpui_android::native::window::AndroidWindow::cancel_contacts", "name": "cancel_contacts", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::window", "path": "gpui_android::native::window", "source": "crates/gpui_android/src/native/window.rs", "summary": "", "documentation": "", "signature": "pub fn cancel_contacts (& self)", "cfg": [], "target": "AndroidWindow" }, { "id": "gpui_android::native::window::AndroidWindow::emit", "name": "emit", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::window", "path": "gpui_android::native::window", "source": "crates/gpui_android/src/native/window.rs", "summary": "", "documentation": "", "signature": "pub fn emit (& self, event : PlatformInput) -> DispatchEventResult", "cfg": [], "target": "AndroidWindow" }, { "id": "gpui_android::native::window::AndroidWindow::new", "name": "new", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::window", "path": "gpui_android::native::window", "source": "crates/gpui_android/src/native/window.rs", "summary": "", "documentation": "", "signature": "pub fn new (handle : AnyWindowHandle, renderer : WgpuRenderer, surface : NativeSurface) -> Self", "cfg": [], "target": "AndroidWindow" }, { "id": "gpui_android::native::window::AndroidWindow::with_input", "name": "with_input", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "native::window", "path": "gpui_android::native::window", "source": "crates/gpui_android/src/native/window.rs", "summary": "", "documentation": "", "signature": "pub fn with_input (& self, f : impl FnOnce (& mut PlatformInputHandler) -> T) -> Option", "cfg": [], "target": "AndroidWindow" }, { "id": "gpui_android::reexport-1", "name": "state :: *", "kind": "reexport", "package": "gpui-box-android", "crate": "gpui_android", "module": "", "path": "gpui_android", "source": "crates/gpui_android/src/lib.rs", "summary": "", "documentation": "", "signature": "pub use state::*;", "cfg": [] }, { "id": "gpui_android::reexport-2", "name": "native :: { AndroidPlatform , initialize }", "kind": "reexport", "package": "gpui-box-android", "crate": "gpui_android", "module": "", "path": "gpui_android", "source": "crates/gpui_android/src/lib.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (target_os = \"android\", feature = \"host-check\"))] pub use native::{ AndroidPlatform, initialize };", "cfg": [ "cfg (any (target_os = \"android\", feature = \"host-check\"))" ] }, { "id": "gpui_android::state::PointerAction", "name": "PointerAction", "kind": "enum", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Android MotionEvent actions, after removing the pointer-index bits.", "documentation": "Android MotionEvent actions, after removing the pointer-index bits.", "signature": "# [doc = \" Android MotionEvent actions, after removing the pointer-index bits.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum PointerAction { Down, Up, Move, Cancel, }", "cfg": [] }, { "id": "gpui_android::state::SurfaceLifecycle", "name": "SurfaceLifecycle", "kind": "struct", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Draw eligibility is independent of Activity existence. A resumed Activity can temporarily have no Surface, and a Surface can precede onResume.", "documentation": "Draw eligibility is independent of Activity existence. A resumed Activity\ncan temporarily have no Surface, and a Surface can precede onResume.", "signature": "# [doc = \" Draw eligibility is independent of Activity existence. A resumed Activity\"] # [doc = \" can temporarily have no Surface, and a Surface can precede onResume.\"] # [derive (Default, Debug)] pub struct SurfaceLifecycle { active : bool, size : Option<(u32, u32)>, generation : u64, }", "cfg": [] }, { "id": "gpui_android::state::SurfaceLifecycle::attach", "name": "attach", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "", "documentation": "", "signature": "pub fn attach (& mut self, width : u32, height : u32) -> u64", "cfg": [], "target": "SurfaceLifecycle" }, { "id": "gpui_android::state::SurfaceLifecycle::can_draw", "name": "can_draw", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "", "documentation": "", "signature": "pub fn can_draw (& self) -> bool", "cfg": [], "target": "SurfaceLifecycle" }, { "id": "gpui_android::state::SurfaceLifecycle::detach", "name": "detach", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "", "documentation": "", "signature": "pub fn detach (& mut self)", "cfg": [], "target": "SurfaceLifecycle" }, { "id": "gpui_android::state::SurfaceLifecycle::pause", "name": "pause", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "", "documentation": "", "signature": "pub fn pause (& mut self)", "cfg": [], "target": "SurfaceLifecycle" }, { "id": "gpui_android::state::SurfaceLifecycle::resume", "name": "resume", "kind": "method", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "", "documentation": "", "signature": "pub fn resume (& mut self)", "cfg": [], "target": "SurfaceLifecycle" }, { "id": "gpui_android::state::android_appearance", "name": "android_appearance", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Configuration.UI_MODE_NIGHT_MASK / UI_MODE_NIGHT_YES. An undefined night mode follows Android's non-night default; unrelated uiMode bits are ignored.", "documentation": "Configuration.UI_MODE_NIGHT_MASK / UI_MODE_NIGHT_YES. An undefined night\nmode follows Android's non-night default; unrelated uiMode bits are ignored.", "signature": "pub fn android_appearance (ui_mode : i32) -> gpui::WindowAppearance", "cfg": [] }, { "id": "gpui_android::state::android_selection", "name": "android_selection", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Android selection endpoints are anchor/head UTF-16 offsets, not a sorted range. Android supplies no visual affinity, so use downstream explicitly.", "documentation": "Android selection endpoints are anchor/head UTF-16 offsets, not a sorted\nrange. Android supplies no visual affinity, so use downstream explicitly.", "signature": "pub fn android_selection (text : & str, start : i32, end : i32) -> Option", "cfg": [] }, { "id": "gpui_android::state::insertion_cursor", "name": "insertion_cursor", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Android's cursor offset is relative to the end of the insertion for positive values, or its start otherwise. All values here count UTF-16 code units.", "documentation": "Android's cursor offset is relative to the end of the insertion for positive\nvalues, or its start otherwise. All values here count UTF-16 code units.", "signature": "pub fn insertion_cursor (start : usize, inserted : usize, cursor : i32, total : usize) -> usize", "cfg": [] }, { "id": "gpui_android::state::motion_pointers", "name": "motion_pointers", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Returns the affected pointer indexes. Android's POINTER_DOWN/UP applies to the action index only; MOVE and CANCEL apply to every current pointer.", "documentation": "Returns the affected pointer indexes. Android's POINTER_DOWN/UP applies to\nthe action index only; MOVE and CANCEL apply to every current pointer.", "signature": "pub fn motion_pointers (action : i32, count : usize) -> Vec<(usize, PointerAction)>", "cfg": [] }, { "id": "gpui_android::state::native_selection_after_deletion", "name": "native_selection_after_deletion", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Preserve endpoint direction and each existing affinity when surrounding text is removed. Deletion changes offsets, not which endpoint is moving.", "documentation": "Preserve endpoint direction and each existing affinity when surrounding\ntext is removed. Deletion changes offsets, not which endpoint is moving.", "signature": "pub fn native_selection_after_deletion (mut selection : gpui::NativeTextSelection, deleted : Range,) -> gpui::NativeTextSelection", "cfg": [] }, { "id": "gpui_android::state::selection_after_deletion", "name": "selection_after_deletion", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Rebase a UTF-16 selection or composing span after deleting another span. Surrounding-text deletion must not collapse an untouched selected range.", "documentation": "Rebase a UTF-16 selection or composing span after deleting another span.\nSurrounding-text deletion must not collapse an untouched selected range.", "signature": "pub fn selection_after_deletion (selection : Range, deleted : Range) -> Range", "cfg": [] }, { "id": "gpui_android::state::utf16_range", "name": "utf16_range", "kind": "function", "package": "gpui-box-android", "crate": "gpui_android", "module": "state", "path": "gpui_android::state", "source": "crates/gpui_android/src/state.rs", "summary": "Validates UTF-16 boundaries, rejecting a selection inside a surrogate pair.", "documentation": "Validates UTF-16 boundaries, rejecting a selection inside a surrogate pair.", "signature": "pub fn utf16_range (text : & str, range : Range) -> Option>", "cfg": [] }, { "id": "gpui_ios::accessibility::AccessibilityTree::action", "name": "action", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "accessibility", "path": "gpui_ios::accessibility", "source": "crates/gpui_ios/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn action (& self, id : u64, action : u32) -> Option", "cfg": [], "target": "AccessibilityTree" }, { "id": "gpui_ios::accessibility::AccessibilityTree::project", "name": "project", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "accessibility", "path": "gpui_ios::accessibility", "source": "crates/gpui_ios/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn project (& mut self, scale : f64) -> Vec", "cfg": [], "target": "AccessibilityTree" }, { "id": "gpui_ios::accessibility::AccessibilityTree::update", "name": "update", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "accessibility", "path": "gpui_ios::accessibility", "source": "crates/gpui_ios/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn update (& mut self, update : TreeUpdate, focused : bool) -> anyhow::Result<()>", "cfg": [], "target": "AccessibilityTree" }, { "id": "gpui_ios::accessibility::ProjectedNode::native", "name": "native", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "accessibility", "path": "gpui_ios::accessibility", "source": "crates/gpui_ios/src/accessibility.rs", "summary": "", "documentation": "", "signature": "pub fn native (& self) -> AccessibilityNode", "cfg": [], "target": "ProjectedNode" }, { "id": "gpui_ios::application", "name": "application", "kind": "function", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "", "path": "gpui_ios", "source": "crates/gpui_ios/src/lib.rs", "summary": "Creates a UIKit application with an explicit caller-owned font authority.", "documentation": "Creates a UIKit application with an explicit caller-owned font authority.\n\nCall on the native main thread before entering UIKit's application loop.\nInitialization is fallible: there is no empty-font or desktop fallback.\nThe selected family must be supplied by `fonts`. Native system-font discovery\nand headless UIKit application construction are not supported.", "signature": "pub fn application (fallback_family : & str, fonts : Vec>,) -> anyhow::Result", "cfg": [ "cfg (any (target_os = \"ios\", feature = \"platform-check\"))" ] }, { "id": "gpui_ios::ffi::AccessibilityNode", "name": "AccessibilityNode", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [repr (C)] pub struct AccessibilityNode { pub id : u64, pub bounds : Rect, pub label : * const c_char, pub value : * const c_char, pub role : u32, pub disabled : bool, pub selected : bool, }", "cfg": [] }, { "id": "gpui_ios::ffi::Callbacks", "name": "Callbacks", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "All text callbacks are required for an editable host, including an empty document. `text` returns required UTF-8 bytes; a zero-capacity call is a length query. `mark`'s selection is relative to the new marked text.", "documentation": "All text callbacks are required for an editable host, including an empty\ndocument. `text` returns required UTF-8 bytes; a zero-capacity call is a\nlength query. `mark`'s selection is relative to the new marked text.", "signature": "# [doc = \" All text callbacks are required for an editable host, including an empty\"] # [doc = \" document. `text` returns required UTF-8 bytes; a zero-capacity call is a\"] # [doc = \" length query. `mark`'s selection is relative to the new marked text.\"] # [derive (Clone, Copy)] # [repr (C)] pub struct Callbacks { pub context : * mut c_void, pub launched : Option, pub lifecycle : Option, pub memory_warning : Option, pub frame : Option, pub geometry : Option, pub touch : Option, pub cancel_input : Option, pub text : unsafe extern \"C\" fn (* mut c_void, TextRange, * mut c_char, usize) -> usize, pub text_length : unsafe extern \"C\" fn (* mut c_void) -> usize, pub selection : unsafe extern \"C\" fn (* mut c_void) -> TextRange, pub marked : unsafe extern \"C\" fn (* mut c_void) -> TextRange, pub select : unsafe extern \"C\" fn (* mut c_void, TextRange), pub replace : unsafe extern \"C\" fn (* mut c_void, TextRange, * const c_char, usize), pub mark : unsafe extern \"C\" fn (* mut c_void, * const c_char, usize, TextRange), pub unmark : unsafe extern \"C\" fn (* mut c_void), pub text_bounds : unsafe extern \"C\" fn (* mut c_void, TextRange) -> Rect, pub text_hit_test : unsafe extern \"C\" fn (* mut c_void, f64, f64) -> usize, pub accessibility_action : Option bool>, pub system_event : Option, pub text_action : Option bool>, pub native_selection : Option NativeSelection>, pub set_native_selection : Option bool>, pub move_position : Option NativePosition>, pub farthest_position : Option NativePosition>, pub position_bounds : Option bool>, pub selection_rects : Option usize>, pub grapheme : Option TextRange>, pub writing_direction : Option i32>, pub set_writing_direction : Option bool>, pub position_for_point : Option NativePosition>, }", "cfg": [] }, { "id": "gpui_ios::ffi::Edges", "name": "Edges", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug, Default, PartialEq)] # [repr (C)] pub struct Edges { pub top : f64, pub right : f64, pub bottom : f64, pub left : f64, }", "cfg": [] }, { "id": "gpui_ios::ffi::NativePosition", "name": "NativePosition", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Default)] # [repr (C)] pub struct NativePosition { pub offset : usize, pub upstream : bool, pub valid : bool, }", "cfg": [] }, { "id": "gpui_ios::ffi::NativeSelection", "name": "NativeSelection", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Default)] # [repr (C)] pub struct NativeSelection { pub anchor : NativePosition, pub head : NativePosition, }", "cfg": [] }, { "id": "gpui_ios::ffi::Rect", "name": "Rect", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug, Default, PartialEq)] # [repr (C)] pub struct Rect { pub x : f64, pub y : f64, pub width : f64, pub height : f64, }", "cfg": [] }, { "id": "gpui_ios::ffi::SelectionRect", "name": "SelectionRect", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy)] # [repr (C)] pub struct SelectionRect { pub bounds : Rect, pub rtl : bool, pub contains_start : bool, pub contains_end : bool, pub vertical : bool, }", "cfg": [] }, { "id": "gpui_ios::ffi::TextRange", "name": "TextRange", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "# [derive (Clone, Copy, Debug, Default, PartialEq)] # [repr (C)] pub struct TextRange { pub location : usize, pub length : usize, pub valid : bool, }", "cfg": [] }, { "id": "gpui_ios::ffi::TextRange::into_range", "name": "into_range", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "ffi", "path": "gpui_ios::ffi", "source": "crates/gpui_ios/src/ffi.rs", "summary": "", "documentation": "", "signature": "pub fn into_range (self) -> Option>", "cfg": [], "target": "TextRange" }, { "id": "gpui_ios::platform::IosPlatform", "name": "IosPlatform", "kind": "struct", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "platform", "path": "gpui_ios::platform", "source": "crates/gpui_ios/src/platform.rs", "summary": "UIKit application host. Construct and run on the main thread.", "documentation": "UIKit application host. Construct and run on the main thread.\n\nFonts are caller-owned assets, shared by shaping and rasterization through\nthe existing GPUI wgpu text system. The fallback family must be present in\n`fonts`; no AppKit system-font authority is silently assumed on iOS.", "signature": "# [doc = \" UIKit application host. Construct and run on the main thread.\"] # [doc = \"\"] # [doc = \" Fonts are caller-owned assets, shared by shaping and rasterization through\"] # [doc = \" the existing GPUI wgpu text system. The fallback family must be present in\"] # [doc = \" `fonts`; no AppKit system-font authority is silently assumed on iOS.\"] pub struct IosPlatform { state : Rc, foreground : ForegroundExecutor, background : BackgroundExecutor, text : Arc, }", "cfg": [] }, { "id": "gpui_ios::platform::IosPlatform::last_error", "name": "last_error", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "platform", "path": "gpui_ios::platform", "source": "crates/gpui_ios/src/platform.rs", "summary": "Most recent native surface failure. A failed resume never permits draw.", "documentation": "Most recent native surface failure. A failed resume never permits draw.", "signature": "pub fn last_error (& self) -> Option", "cfg": [], "target": "IosPlatform" }, { "id": "gpui_ios::platform::IosPlatform::new", "name": "new", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "platform", "path": "gpui_ios::platform", "source": "crates/gpui_ios/src/platform.rs", "summary": "", "documentation": "", "signature": "pub fn new (fallback_family : & str, fonts : Vec>) -> Result", "cfg": [], "target": "IosPlatform" }, { "id": "gpui_ios::platform::IosPlatform::verify_next_frame", "name": "verify_next_frame", "kind": "method", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "platform", "path": "gpui_ios::platform", "source": "crates/gpui_ios/src/platform.rs", "summary": "Verifies completion of the next successfully submitted GPUI window frame.", "documentation": "Verifies completion of the next successfully submitted GPUI window frame.\n\nDiagnostic use only: waits up to five seconds for GPU work after a real\ndraw, reports pending validation/device errors, and delivers the callback\non the main queue after the GPUI window borrow ends. No callback means no\nsuccessful draw occurred; the harness must impose its own overall timeout.\nThis proves submission/completion, not displayed pixels or input behavior.", "signature": "pub fn verify_next_frame (& self, callback : impl FnOnce (Result<()>) + 'static) -> Result<()>", "cfg": [], "target": "IosPlatform" }, { "id": "gpui_ios::reexport-1", "name": "platform :: IosPlatform", "kind": "reexport", "package": "gpui-box-ios", "crate": "gpui_ios", "module": "", "path": "gpui_ios", "source": "crates/gpui_ios/src/lib.rs", "summary": "", "documentation": "", "signature": "# [cfg (any (target_os = \"ios\", feature = \"platform-check\"))] pub use platform::IosPlatform;", "cfg": [ "cfg (any (target_os = \"ios\", feature = \"platform-check\"))" ] }, { "id": "gpui_kit::agent::approval::AlwaysScope", "name": "AlwaysScope", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "What a standing approval covers.", "documentation": "What a standing approval covers.\n\nThere is deliberately no bare `Always`. A caller states which of these\nfour kinds of \"always\" it is offering, and the control words itself from\nthat, so an unscoped standing permission has no representation.", "signature": "# [doc = \" What a standing approval covers.\"] # [doc = \"\"] # [doc = \" There is deliberately no bare `Always`. A caller states which of these\"] # [doc = \" four kinds of \\\"always\\\" it is offering, and the control words itself from\"] # [doc = \" that, so an unscoped standing permission has no representation.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum AlwaysScope { # [doc = \" Until this session ends. The session is the scope, so it names nothing\"] # [doc = \" further.\"] Session, # [doc = \" Every future use of one named tool.\"] Tool (SharedString), # [doc = \" Anything under one named place on disk.\"] Path (SharedString), # [doc = \" Every future request to one named host.\"] Host (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::approval::AlwaysScope::host", "name": "host", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn host (host : impl Into) -> Self", "cfg": [], "target": "AlwaysScope" }, { "id": "gpui_kit::agent::approval::AlwaysScope::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "The wording that appears on the control, which always states the scope.", "documentation": "The wording that appears on the control, which always states the\nscope.", "signature": "pub fn label (& self, cx : & App) -> SharedString", "cfg": [], "target": "AlwaysScope" }, { "id": "gpui_kit::agent::approval::AlwaysScope::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "The stable name of the kind of scope, used for the control's id and published in the semantic tree.", "documentation": "The stable name of the kind of scope, used for the control's id and\npublished in the semantic tree.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "AlwaysScope" }, { "id": "gpui_kit::agent::approval::AlwaysScope::path", "name": "path", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn path (path : impl Into) -> Self", "cfg": [], "target": "AlwaysScope" }, { "id": "gpui_kit::agent::approval::AlwaysScope::subject", "name": "subject", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "The thing the scope covers, when it is one named thing.", "documentation": "The thing the scope covers, when it is one named thing.", "signature": "pub fn subject (& self) -> Option<& SharedString>", "cfg": [], "target": "AlwaysScope" }, { "id": "gpui_kit::agent::approval::AlwaysScope::tool", "name": "tool", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn tool (name : impl Into) -> Self", "cfg": [], "target": "AlwaysScope" }, { "id": "gpui_kit::agent::approval::ApprovalDecision", "name": "ApprovalDecision", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "How far an approval reaches.", "documentation": "How far an approval reaches.", "signature": "# [doc = \" How far an approval reaches.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ApprovalDecision { # [doc = \" This request and nothing else.\"] Once, # [doc = \" A standing permission, which always states what it covers.\"] Always (AlwaysScope), }", "cfg": [] }, { "id": "gpui_kit::agent::approval::ApprovalDecision::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "The wording for the reach of the decision, for the sentence a resolved prompt shows.", "documentation": "The wording for the reach of the decision, for the sentence a resolved\nprompt shows.", "signature": "pub fn label (& self, cx : & App) -> SharedString", "cfg": [], "target": "ApprovalDecision" }, { "id": "gpui_kit::agent::approval::ApprovalEvent", "name": "ApprovalEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "What the prompt reports. It applies none of it.", "documentation": "What the prompt reports. It applies none of it.", "signature": "# [doc = \" What the prompt reports. It applies none of it.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ApprovalEvent { # [doc = \" The typist approved, and this is how far the approval reaches.\"] Approved (ApprovalDecision), # [doc = \" The typist declined. Also what escape and a stray return key report.\"] Declined, }", "cfg": [] }, { "id": "gpui_kit::agent::approval::ApprovalPrompt", "name": "ApprovalPrompt", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "One request for permission, with the answer left to the caller.", "documentation": "One request for permission, with the answer left to the caller.\n\nIt is a view rather than a builder because where the keyboard is has to\nsurvive a frame, and where the keyboard is *is* the safety property.", "signature": "# [doc = \" One request for permission, with the answer left to the caller.\"] # [doc = \"\"] # [doc = \" It is a view rather than a builder because where the keyboard is has to\"] # [doc = \" survive a frame, and where the keyboard is *is* the safety property.\"] pub struct ApprovalPrompt { ident : Ident, focus_handle : FocusHandle, decline_focus : FocusHandle, approve_focus : FocusHandle, always_focus : Vec, # [doc = \" Exactly what is being asked for, in the caller's words. Required by\"] # [doc = \" the constructor: a prompt with nothing specific to say is not one this\"] # [doc = \" component can render.\"] action : SharedString, details : Vec, always : Vec, status : ApprovalStatus, # [doc = \" Cleared by the first frame that can act on it, as in `Dialog`.\"] pending_focus : bool, }", "cfg": [] }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::always", "name": "always", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "Offers a standing approval. The scope is part of the argument, so the control cannot be worded without it.", "documentation": "Offers a standing approval. The scope is part of the argument, so the\ncontrol cannot be worded without it.", "signature": "pub fn always (mut self, scope : AlwaysScope) -> Self", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::approve", "name": "approve", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "Reports an approval. Refused unless the prompt is still pending, so a host calling this on a resolved prompt cannot resurrect it.", "documentation": "Reports an approval. Refused unless the prompt is still pending, so a\nhost calling this on a resolved prompt cannot resurrect it.", "signature": "pub fn approve (& mut self, decision : ApprovalDecision, cx : & mut Context)", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::current_status", "name": "current_status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn current_status (& self) -> & ApprovalStatus", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::decline", "name": "decline", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn decline (& mut self, cx : & mut Context)", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::detail", "name": "detail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "One more specific fact about the request: the exact path, the exact command, the exact host.", "documentation": "One more specific fact about the request: the exact path, the exact\ncommand, the exact host.", "signature": "pub fn detail (mut self, detail : DescriptionItem) -> Self", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::details", "name": "details", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn details (mut self, details : impl IntoIterator) -> Self", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "`action` is what is about to happen, stated specifically. There is no way to describe the request as a category instead.", "documentation": "`action` is what is about to happen, stated specifically. There is no\nway to describe the request as a category instead.", "signature": "pub fn new (ident : impl Into, action : impl Into, _window : & mut Window, cx : & mut Context,) -> Self", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::set_status", "name": "set_status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "Records what happened to the request. A host that expires or supersedes a prompt says so through here rather than by removing it, so the reader finds out why the controls went away.", "documentation": "Records what happened to the request. A host that expires or supersedes\na prompt says so through here rather than by removing it, so the reader\nfinds out why the controls went away.", "signature": "pub fn set_status (& mut self, status : ApprovalStatus, cx : & mut Context)", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalPrompt::status", "name": "status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "", "documentation": "", "signature": "pub fn status (mut self, status : ApprovalStatus) -> Self", "cfg": [], "target": "ApprovalPrompt" }, { "id": "gpui_kit::agent::approval::ApprovalStatus", "name": "ApprovalStatus", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "What has happened to this request.", "documentation": "What has happened to this request.\n\nDeclined, expired and superseded are three different things and are never\ncollapsed into one another.", "signature": "# [doc = \" What has happened to this request.\"] # [doc = \"\"] # [doc = \" Declined, expired and superseded are three different things and are never\"] # [doc = \" collapsed into one another.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum ApprovalStatus { # [doc = \" Nobody has answered yet. The only status that offers controls.\"] # [default] Pending, # [doc = \" Somebody answered, and the answer was no.\"] Declined, # [doc = \" Somebody answered, and said how far the answer reaches.\"] Approved (ApprovalDecision), # [doc = \" The window in which this could be answered closed. Nobody refused it.\"] Expired, # [doc = \" A later request took this one's place. The wording naming the\"] # [doc = \" replacement belongs to the host and is shown verbatim.\"] Superseded { by : SharedString }, }", "cfg": [] }, { "id": "gpui_kit::agent::approval::ApprovalStatus::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::approval", "path": "gpui_kit::agent::approval", "source": "crates/gpui-kit/src/agent/approval.rs", "summary": "The stable name published in the semantic tree.", "documentation": "The stable name published in the semantic tree.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "ApprovalStatus" }, { "id": "gpui_kit::agent::artifact::ArtifactKind", "name": "ArtifactKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "What kind of artifact the host is showing.", "documentation": "What kind of artifact the host is showing.", "signature": "# [doc = \" What kind of artifact the host is showing.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum ArtifactKind { Code, Document, Markup, }", "cfg": [] }, { "id": "gpui_kit::agent::artifact::ArtifactKind::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "ArtifactKind" }, { "id": "gpui_kit::agent::artifact::ArtifactPreview", "name": "ArtifactPreview", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "A titled pane for a generated artifact.", "documentation": "A titled pane for a generated artifact.", "signature": "# [doc = \" A titled pane for a generated artifact.\"] # [derive (IntoElement)] pub struct ArtifactPreview { ident : Ident, title : SharedString, kind : ArtifactKind, body : SharedString, language : Option, state : ArtifactPreviewState, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::agent::artifact::ArtifactPreview::body", "name": "body", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "", "documentation": "", "signature": "pub fn body (mut self, body : impl Into) -> Self", "cfg": [], "target": "ArtifactPreview" }, { "id": "gpui_kit::agent::artifact::ArtifactPreview::kind", "name": "kind", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "", "documentation": "", "signature": "pub fn kind (mut self, kind : ArtifactKind) -> Self", "cfg": [], "target": "ArtifactPreview" }, { "id": "gpui_kit::agent::artifact::ArtifactPreview::language", "name": "language", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "What the body is written in, when the host knows.", "documentation": "What the body is written in, when the host knows.\n\nOnly what a caller says is read, the same rule a fenced block in\n[`crate::prelude::Markdown`] keeps: an artifact whose language nobody\nnamed is set in the same face at the same size and left uncoloured,\nrather than coloured against a grammar somebody guessed at.", "signature": "pub fn language (mut self, language : Language) -> Self", "cfg": [], "target": "ArtifactPreview" }, { "id": "gpui_kit::agent::artifact::ArtifactPreview::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, title : impl Into) -> Self", "cfg": [], "target": "ArtifactPreview" }, { "id": "gpui_kit::agent::artifact::ArtifactPreview::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : ArtifactPreviewState) -> Self", "cfg": [], "target": "ArtifactPreview" }, { "id": "gpui_kit::agent::artifact::ArtifactPreviewState", "name": "ArtifactPreviewState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "How the artifact was asked for.", "documentation": "How the artifact was asked for.", "signature": "# [doc = \" How the artifact was asked for.\"] # [derive (Debug, Clone, PartialEq)] pub enum ArtifactPreviewState { Loading, Ready, Empty, Unavailable (SharedString), Error (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::artifact::ArtifactPreviewState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::artifact", "path": "gpui_kit::agent::artifact", "source": "crates/gpui-kit/src/agent/artifact.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "ArtifactPreviewState" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas", "name": "AgentRunCanvas", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "A typed, read-mostly view of an [`AgentRunSnapshot`] on a node canvas.", "documentation": "A typed, read-mostly view of an [`AgentRunSnapshot`] on a node canvas.\n\nThe default inspection mode supports pan, zoom, and selection but never\ninstalls topology editing or deletion. [`AgentRunCanvas::arrangeable`]\nadditionally reports node moves while still keeping links immutable.", "signature": "# [doc = \" A typed, read-mostly view of an [`AgentRunSnapshot`] on a node canvas.\"] # [doc = \"\"] # [doc = \" The default inspection mode supports pan, zoom, and selection but never\"] # [doc = \" installs topology editing or deletion. [`AgentRunCanvas::arrangeable`]\"] # [doc = \" additionally reports node moves while still keeping links immutable.\"] # [derive (IntoElement)] pub struct AgentRunCanvas { ident : Ident, run : AgentRunSnapshot, layout : AgentRunLayout, positions : Vec<(RunSubjectId, Point)>, selected : Vec, viewport : GraphViewport, arrangeable : bool, on_event : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::arrangeable", "name": "arrangeable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "Allows position proposals without enabling deletion or topology edits.", "documentation": "Allows position proposals without enabling deletion or topology edits.", "signature": "pub fn arrangeable (mut self, arrangeable : bool) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::layout", "name": "layout", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "Chooses one of the built-in deterministic layered arrangements.", "documentation": "Chooses one of the built-in deterministic layered arrangements.", "signature": "pub fn layout (mut self, layout : AgentRunLayout) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, run : AgentRunSnapshot) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& AgentRunCanvasEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::position", "name": "position", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "Overrides one built-in position with caller-owned world coordinates. A later override for the same subject wins.", "documentation": "Overrides one built-in position with caller-owned world coordinates.\nA later override for the same subject wins.", "signature": "pub fn position (mut self, subject : RunSubjectId, x : f32, y : f32) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "Supplies the complete caller-owned subject selection.", "documentation": "Supplies the complete caller-owned subject selection.", "signature": "pub fn selected (mut self, selected : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvas::viewport", "name": "viewport", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "Supplies the caller-owned pan and zoom value.", "documentation": "Supplies the caller-owned pan and zoom value.", "signature": "pub fn viewport (mut self, viewport : GraphViewport) -> Self", "cfg": [], "target": "AgentRunCanvas" }, { "id": "gpui_kit::agent::canvas::AgentRunCanvasEvent", "name": "AgentRunCanvasEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "A controlled change proposed by [`AgentRunCanvas`].", "documentation": "A controlled change proposed by [`AgentRunCanvas`].", "signature": "# [doc = \" A controlled change proposed by [`AgentRunCanvas`].\"] # [derive (Debug, Clone, PartialEq)] pub enum AgentRunCanvasEvent { # [doc = \" Proposes the complete caller-owned subject selection.\"] SelectionChanged (Vec), # [doc = \" Proposes a new pan or zoom value.\"] ViewportChanged (GraphViewport), # [doc = \" Proposes an arranged world-space position for one subject.\"] PositionChanged { subject : RunSubjectId, position : Point, }, }", "cfg": [] }, { "id": "gpui_kit::agent::canvas::AgentRunLayout", "name": "AgentRunLayout", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::canvas", "path": "gpui_kit::agent::canvas", "source": "crates/gpui-kit/src/agent/canvas.rs", "summary": "The reading axis used by the built-in deterministic run layout.", "documentation": "The reading axis used by the built-in deterministic run layout.", "signature": "# [doc = \" The reading axis used by the built-in deterministic run layout.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum AgentRunLayout { # [doc = \" Roots precede dependants in reading order. Right-to-left locales mirror\"] # [doc = \" the columns without changing caller-owned identities or relationships.\"] # [default] LayeredHorizontal, # [doc = \" Roots sit above dependants. Nodes within a layer follow snapshot order.\"] LayeredVertical, }", "cfg": [] }, { "id": "gpui_kit::agent::clarification::ClarificationEvent", "name": "ClarificationEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "What the panel reports without applying it.", "documentation": "What the panel reports without applying it.", "signature": "# [doc = \" What the panel reports without applying it.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ClarificationEvent { # [doc = \" The ids that were picked, in the order they were picked.\"] Answered (Vec), # [doc = \" The reader chose to let the agent decide.\"] Skipped, }", "cfg": [] }, { "id": "gpui_kit::agent::clarification::ClarificationOption", "name": "ClarificationOption", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "One candidate answer the agent is offering.", "documentation": "One candidate answer the agent is offering.", "signature": "# [doc = \" One candidate answer the agent is offering.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct ClarificationOption { id : SharedString, label : SharedString, detail : Option, # [doc = \" Why this candidate cannot presently be picked, in the host's words.\"] # [doc = \" `None` is the available case, so an unavailable option cannot be built\"] # [doc = \" without saying what is wrong with it.\"] unavailable : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::clarification::ClarificationOption::detail", "name": "detail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "One more line about this candidate: the path it resolves to, the version it means, what picking it would cost.", "documentation": "One more line about this candidate: the path it resolves to, the\nversion it means, what picking it would cost.", "signature": "pub fn detail (mut self, detail : impl Into) -> Self", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::detail_text", "name": "detail_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "The extra line about this candidate, if the caller gave one.", "documentation": "The extra line about this candidate, if the caller gave one.", "signature": "pub fn detail_text (& self) -> Option<& SharedString>", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::is_available", "name": "is_available", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn is_available (& self) -> bool", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn label (& self) -> & SharedString", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "`id` is the business identity of the candidate, which is what the panel reports and what its semantic id derives from. It is never the position: reordering the candidates must not rename them.", "documentation": "`id` is the business identity of the candidate, which is what the panel\nreports and what its semantic id derives from. It is never the\nposition: reordering the candidates must not rename them.", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::unavailable", "name": "unavailable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Marks the candidate as one that cannot be picked, and says why. The reason is shown; the option keeps its place and installs no handler.", "documentation": "Marks the candidate as one that cannot be picked, and says why. The\nreason is shown; the option keeps its place and installs no handler.", "signature": "pub fn unavailable (mut self, reason : impl Into) -> Self", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationOption::unavailable_reason", "name": "unavailable_reason", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Why this candidate cannot be picked, if it cannot.", "documentation": "Why this candidate cannot be picked, if it cannot.", "signature": "pub fn unavailable_reason (& self) -> Option<& SharedString>", "cfg": [], "target": "ClarificationOption" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel", "name": "ClarificationPanel", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "One clarifying question, with the answer left to the caller.", "documentation": "One clarifying question, with the answer left to the caller.\n\nIt is a view rather than a builder because a multiple-answer question\naccumulates a selection across frames, and because where the keyboard is\nhas to survive one.", "signature": "# [doc = \" One clarifying question, with the answer left to the caller.\"] # [doc = \"\"] # [doc = \" It is a view rather than a builder because a multiple-answer question\"] # [doc = \" accumulates a selection across frames, and because where the keyboard is\"] # [doc = \" has to survive one.\"] pub struct ClarificationPanel { ident : Ident, focus_handle : FocusHandle, option_focus : Vec, answer_focus : FocusHandle, skip_focus : FocusHandle, # [doc = \" What the agent needs to know, in its own words. Required by the\"] # [doc = \" constructor: a clarification with no question is not one this component\"] # [doc = \" can render.\"] question : SharedString, options : Vec, multiple : bool, skippable : bool, # [doc = \" The ids picked so far, in the order they were picked, which is the\"] # [doc = \" order they are reported in.\"] picked : Vec, status : ClarificationStatus, # [doc = \" Cleared by the first frame that can act on it, as in `ApprovalPrompt`.\"] pending_focus : bool, }", "cfg": [] }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::answer", "name": "answer", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Reports the accumulated answer. Refused while nothing is picked, so the question cannot be answered with silence.", "documentation": "Reports the accumulated answer. Refused while nothing is picked, so the\nquestion cannot be answered with silence.", "signature": "pub fn answer (& mut self, cx : & mut Context)", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::candidates", "name": "candidates", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "The candidates the panel was given.", "documentation": "The candidates the panel was given.", "signature": "pub fn candidates (& self) -> & [ClarificationOption]", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::choose", "name": "choose", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Picks a candidate: toggles it when the question takes several answers, and answers the question outright when it takes one.", "documentation": "Picks a candidate: toggles it when the question takes several answers,\nand answers the question outright when it takes one.\n\nRefused for an unavailable candidate, an unknown id, and a question\nthat is no longer pending, so a host driving the panel cannot reach a\nstate the pointer and the keyboard cannot.", "signature": "pub fn choose (& mut self, id : impl Into, cx : & mut Context)", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::chosen", "name": "chosen", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "What is filled right now: the answer once there is one, and the selection in progress until then. One question, one place it is answered from.", "documentation": "What is filled right now: the answer once there is one, and the\nselection in progress until then. One question, one place it is\nanswered from.", "signature": "pub fn chosen (& self) -> & [SharedString]", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::current_status", "name": "current_status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn current_status (& self) -> & ClarificationStatus", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::multiple", "name": "multiple", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Accepts more than one answer, which is what adds the confirming control. Without it the question takes exactly one answer and picking is answering.", "documentation": "Accepts more than one answer, which is what adds the confirming\ncontrol. Without it the question takes exactly one answer and picking\nis answering.", "signature": "pub fn multiple (mut self) -> Self", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "`question` is what the agent needs to know, stated in full. There is no way to render the question as a category instead.", "documentation": "`question` is what the agent needs to know, stated in full. There is no\nway to render the question as a category instead.", "signature": "pub fn new (ident : impl Into, question : impl Into, _window : & mut Window, cx : & mut Context,) -> Self", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::option", "name": "option", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn option (mut self, option : ClarificationOption) -> Self", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::options", "name": "options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn options (mut self, options : impl IntoIterator) -> Self", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::set_status", "name": "set_status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Records what happened to the question. A host that withdraws or supersedes one says so through here rather than by removing the panel, so the reader finds out why the controls went away.", "documentation": "Records what happened to the question. A host that withdraws or\nsupersedes one says so through here rather than by removing the panel,\nso the reader finds out why the controls went away.", "signature": "pub fn set_status (& mut self, status : ClarificationStatus, cx : & mut Context)", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::skip", "name": "skip", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Reports that the reader would rather the agent decided. Refused unless the caller offered the choice.", "documentation": "Reports that the reader would rather the agent decided. Refused unless\nthe caller offered the choice.", "signature": "pub fn skip (& mut self, cx : & mut Context)", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::skippable", "name": "skippable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "Offers the reader a way to decline to choose and let the agent decide. Off by default, because a question the agent cannot proceed without is the ordinary case and a skip control on one is a lie.", "documentation": "Offers the reader a way to decline to choose and let the agent decide.\nOff by default, because a question the agent cannot proceed without is\nthe ordinary case and a skip control on one is a lie.", "signature": "pub fn skippable (mut self) -> Self", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationPanel::status", "name": "status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn status (mut self, status : ClarificationStatus) -> Self", "cfg": [], "target": "ClarificationPanel" }, { "id": "gpui_kit::agent::clarification::ClarificationStatus", "name": "ClarificationStatus", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "What happened to the question.", "documentation": "What happened to the question.\n\nAnswered, skipped, withdrawn and superseded are four different facts and\nare kept apart for the same reason approval keeps declined, expired and\nsuperseded apart: a question nobody answered was not answered, and a\nquestion the agent stopped needing was not skipped by the reader.", "signature": "# [doc = \" What happened to the question.\"] # [doc = \"\"] # [doc = \" Answered, skipped, withdrawn and superseded are four different facts and\"] # [doc = \" are kept apart for the same reason approval keeps declined, expired and\"] # [doc = \" superseded apart: a question nobody answered was not answered, and a\"] # [doc = \" question the agent stopped needing was not skipped by the reader.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum ClarificationStatus { # [doc = \" Still waiting on the reader.\"] # [default] Pending, # [doc = \" Answered, with the ids that were picked.\"] Answered (Vec), # [doc = \" The reader declined to choose and let the agent decide for itself.\"] # [doc = \" Only reachable when the panel is\"] # [doc = \" [`skippable`](ClarificationPanel::skippable).\"] Skipped, # [doc = \" The agent stopped needing the answer, in its own words.\"] Withdrawn (SharedString), # [doc = \" A later question took this one's place.\"] Superseded { by : SharedString }, }", "cfg": [] }, { "id": "gpui_kit::agent::clarification::ClarificationStatus::answer", "name": "answer", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "The ids that were picked, if the question was answered.", "documentation": "The ids that were picked, if the question was answered.", "signature": "pub fn answer (& self) -> Option<& [SharedString]>", "cfg": [], "target": "ClarificationStatus" }, { "id": "gpui_kit::agent::clarification::ClarificationStatus::is_pending", "name": "is_pending", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "", "documentation": "", "signature": "pub fn is_pending (& self) -> bool", "cfg": [], "target": "ClarificationStatus" }, { "id": "gpui_kit::agent::clarification::ClarificationStatus::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::clarification", "path": "gpui_kit::agent::clarification", "source": "crates/gpui-kit/src/agent/clarification.rs", "summary": "The stable name published on the semantic node, so a test tells the five apart without reading a colour.", "documentation": "The stable name published on the semantic node, so a test tells the\nfive apart without reading a colour.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "ClarificationStatus" }, { "id": "gpui_kit::agent::cost::Basis", "name": "Basis", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "How a number was arrived at.", "documentation": "How a number was arrived at.\n\nThere is no third variant meaning \"unspecified\": a caller that cannot say\nwhich of these two it has does not have a number, it has\n[`Reading::Unavailable`].", "signature": "# [doc = \" How a number was arrived at.\"] # [doc = \"\"] # [doc = \" There is no third variant meaning \\\"unspecified\\\": a caller that cannot say\"] # [doc = \" which of these two it has does not have a number, it has\"] # [doc = \" [`Reading::Unavailable`].\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum Basis { # [doc = \" Counted by whoever owns the meter.\"] Measured, # [doc = \" Worked out from something else, and said so everywhere it appears.\"] Estimated, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::Basis::is_estimate", "name": "is_estimate", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn is_estimate (self) -> bool", "cfg": [], "target": "Basis" }, { "id": "gpui_kit::agent::cost::Basis::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The stable name published in the semantic tree.", "documentation": "The stable name published in the semantic tree.", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "Basis" }, { "id": "gpui_kit::agent::cost::ContextGauge", "name": "ContextGauge", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "How much of a context window a run has used.", "documentation": "How much of a context window a run has used.\n\nThe gauge draws a proportion only when it has both a reading and a limit,\nand says which of the two it is missing when it does not.", "signature": "# [doc = \" How much of a context window a run has used.\"] # [doc = \"\"] # [doc = \" The gauge draws a proportion only when it has both a reading and a limit,\"] # [doc = \" and says which of the two it is missing when it does not.\"] # [derive (Debug, Clone, IntoElement)] pub struct ContextGauge { ident : Ident, label : Option, used : Reading, limit : Limit, stale : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::ContextGauge::fraction", "name": "fraction", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The proportion, when there is one to draw.", "documentation": "The proportion, when there is one to draw.\n\n`None` whenever the limit is unknown or the reading is unavailable: a\nproportion of an unknown total, or of a number nobody has, is invented.", "signature": "pub fn fraction (& self) -> Option", "cfg": [], "target": "ContextGauge" }, { "id": "gpui_kit::agent::cost::ContextGauge::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "ContextGauge" }, { "id": "gpui_kit::agent::cost::ContextGauge::limit", "name": "limit", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn limit (mut self, limit : Limit) -> Self", "cfg": [], "target": "ContextGauge" }, { "id": "gpui_kit::agent::cost::ContextGauge::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "`used` carries its own basis, so a gauge cannot be given a bare number.", "documentation": "`used` carries its own basis, so a gauge cannot be given a bare number.", "signature": "pub fn new (ident : impl Into, used : Reading) -> Self", "cfg": [], "target": "ContextGauge" }, { "id": "gpui_kit::agent::cost::ContextGauge::stale", "name": "stale", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The reading is the last verified one, from the moment stated.", "documentation": "The reading is the last verified one, from the moment stated.", "signature": "pub fn stale (mut self, verified : LastVerified) -> Self", "cfg": [], "target": "ContextGauge" }, { "id": "gpui_kit::agent::cost::CostLine", "name": "CostLine", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "One line of a [`CostMeter`].", "documentation": "One line of a [`CostMeter`].", "signature": "# [doc = \" One line of a [`CostMeter`].\"] # [derive (Debug, Clone, PartialEq)] pub struct CostLine { id : SharedString, label : SharedString, reading : Reading, stale : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::CostLine::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "CostLine" }, { "id": "gpui_kit::agent::cost::CostLine::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into, reading : Reading,) -> Self", "cfg": [], "target": "CostLine" }, { "id": "gpui_kit::agent::cost::CostLine::reading", "name": "reading", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn reading (& self) -> & Reading", "cfg": [], "target": "CostLine" }, { "id": "gpui_kit::agent::cost::CostLine::stale", "name": "stale", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The refresh that should have replaced this reading did not. The value stays on screen and says when it was from.", "documentation": "The refresh that should have replaced this reading did not. The value\nstays on screen and says when it was from.", "signature": "pub fn stale (mut self, verified : LastVerified) -> Self", "cfg": [], "target": "CostLine" }, { "id": "gpui_kit::agent::cost::CostMeter", "name": "CostMeter", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "What a run has cost so far, line by line.", "documentation": "What a run has cost so far, line by line.", "signature": "# [doc = \" What a run has cost so far, line by line.\"] # [derive (Debug, Clone, IntoElement)] pub struct CostMeter { ident : Ident, label : Option, lines : Vec, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::CostMeter::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "CostMeter" }, { "id": "gpui_kit::agent::cost::CostMeter::line", "name": "line", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn line (mut self, line : CostLine) -> Self", "cfg": [], "target": "CostMeter" }, { "id": "gpui_kit::agent::cost::CostMeter::lines", "name": "lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn lines (mut self, lines : impl IntoIterator) -> Self", "cfg": [], "target": "CostMeter" }, { "id": "gpui_kit::agent::cost::CostMeter::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "CostMeter" }, { "id": "gpui_kit::agent::cost::LastVerified", "name": "LastVerified", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "When a reading was last verified, for a reading that is no longer current.", "documentation": "When a reading was last verified, for a reading that is no longer current.\n\nMarking a value stale and saying when it was from is one call, because a\nvalue marked stale without a date is a warning nobody can act on. The\nwording of the date is the caller's, as in\n[`Timeline`](crate::display::timeline::Timeline).", "signature": "# [doc = \" When a reading was last verified, for a reading that is no longer current.\"] # [doc = \"\"] # [doc = \" Marking a value stale and saying when it was from is one call, because a\"] # [doc = \" value marked stale without a date is a warning nobody can act on. The\"] # [doc = \" wording of the date is the caller's, as in\"] # [doc = \" [`Timeline`](crate::display::timeline::Timeline).\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct LastVerified (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::cost::LastVerified::at", "name": "at", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn at (when : impl Into) -> Self", "cfg": [], "target": "LastVerified" }, { "id": "gpui_kit::agent::cost::Limit", "name": "Limit", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The ceiling a gauge measures against.", "documentation": "The ceiling a gauge measures against.", "signature": "# [doc = \" The ceiling a gauge measures against.\"] # [derive (Debug, Clone, PartialEq, Default)] pub enum Limit { # [doc = \" A stated ceiling, which may itself be an estimate.\"] Known (Quantity), # [doc = \" Nobody stated one. No proportion is drawn.\"] # [default] Unknown, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::Limit::estimated", "name": "estimated", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn estimated (amount : f64, text : impl Into) -> Self", "cfg": [], "target": "Limit" }, { "id": "gpui_kit::agent::cost::Limit::is_known", "name": "is_known", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn is_known (& self) -> bool", "cfg": [], "target": "Limit" }, { "id": "gpui_kit::agent::cost::Limit::measured", "name": "measured", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn measured (amount : f64, text : impl Into) -> Self", "cfg": [], "target": "Limit" }, { "id": "gpui_kit::agent::cost::Limit::quantity", "name": "quantity", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn quantity (& self) -> Option<& Quantity>", "cfg": [], "target": "Limit" }, { "id": "gpui_kit::agent::cost::Quantity", "name": "Quantity", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "A number, the caller's wording for it, and how it was arrived at.", "documentation": "A number, the caller's wording for it, and how it was arrived at.", "signature": "# [doc = \" A number, the caller's wording for it, and how it was arrived at.\"] # [derive (Debug, Clone, PartialEq)] pub struct Quantity { basis : Basis, amount : f64, text : SharedString, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::Quantity::amount", "name": "amount", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The bare number, used only for proportions against a known limit.", "documentation": "The bare number, used only for proportions against a known limit.", "signature": "pub fn amount (& self) -> f64", "cfg": [], "target": "Quantity" }, { "id": "gpui_kit::agent::cost::Quantity::basis", "name": "basis", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn basis (& self) -> Basis", "cfg": [], "target": "Quantity" }, { "id": "gpui_kit::agent::cost::Quantity::display", "name": "display", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "What a reader reads and what the node publishes: the caller's wording, carrying its basis when the basis is one a reader must know about.", "documentation": "What a reader reads and what the node publishes: the caller's wording,\ncarrying its basis when the basis is one a reader must know about.", "signature": "pub fn display (& self, cx : & App) -> SharedString", "cfg": [], "target": "Quantity" }, { "id": "gpui_kit::agent::cost::Quantity::estimated", "name": "estimated", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "An estimate. Every rendering of it carries the estimate mark.", "documentation": "An estimate. Every rendering of it carries the estimate mark.", "signature": "pub fn estimated (amount : f64, text : impl Into) -> Self", "cfg": [], "target": "Quantity" }, { "id": "gpui_kit::agent::cost::Quantity::measured", "name": "measured", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "A counted number. `text` is the caller's own formatting of it.", "documentation": "A counted number. `text` is the caller's own formatting of it.", "signature": "pub fn measured (amount : f64, text : impl Into) -> Self", "cfg": [], "target": "Quantity" }, { "id": "gpui_kit::agent::cost::Quantity::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The caller's wording, without the estimate label.", "documentation": "The caller's wording, without the estimate label.", "signature": "pub fn text (& self) -> & SharedString", "cfg": [], "target": "Quantity" }, { "id": "gpui_kit::agent::cost::Reading", "name": "Reading", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "What is known about a number right now.", "documentation": "What is known about a number right now.", "signature": "# [doc = \" What is known about a number right now.\"] # [derive (Debug, Clone, PartialEq)] pub enum Reading { # [doc = \" A number, with its basis.\"] Known (Quantity), # [doc = \" Nobody could say. Never drawn as zero, and never counted into a\"] # [doc = \" proportion.\"] Unavailable { reason : Option }, }", "cfg": [] }, { "id": "gpui_kit::agent::cost::Reading::estimated", "name": "estimated", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn estimated (amount : f64, text : impl Into) -> Self", "cfg": [], "target": "Reading" }, { "id": "gpui_kit::agent::cost::Reading::measured", "name": "measured", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn measured (amount : f64, text : impl Into) -> Self", "cfg": [], "target": "Reading" }, { "id": "gpui_kit::agent::cost::Reading::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "The stable name published in the semantic tree.", "documentation": "The stable name published in the semantic tree.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "Reading" }, { "id": "gpui_kit::agent::cost::Reading::quantity", "name": "quantity", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn quantity (& self) -> Option<& Quantity>", "cfg": [], "target": "Reading" }, { "id": "gpui_kit::agent::cost::Reading::unavailable", "name": "unavailable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "", "documentation": "", "signature": "pub fn unavailable () -> Self", "cfg": [], "target": "Reading" }, { "id": "gpui_kit::agent::cost::Reading::unavailable_because", "name": "unavailable_because", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::cost", "path": "gpui_kit::agent::cost", "source": "crates/gpui-kit/src/agent/cost.rs", "summary": "Unavailable, in the host's own words, which are shown verbatim.", "documentation": "Unavailable, in the host's own words, which are shown verbatim.", "signature": "pub fn unavailable_because (reason : impl Into) -> Self", "cfg": [], "target": "Reading" }, { "id": "gpui_kit::agent::disclosure::AgentDisclosurePresentation", "name": "AgentDisclosurePresentation", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::disclosure", "path": "gpui_kit::agent::disclosure", "source": "crates/gpui-kit/src/agent/disclosure.rs", "summary": "How agent evidence is presented when a disclosure is open.", "documentation": "How agent evidence is presented when a disclosure is open.", "signature": "# [doc = \" How agent evidence is presented when a disclosure is open.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum AgentDisclosurePresentation { # [doc = \" Evidence sits on a distinct inset body surface.\"] # [default] Inset, # [doc = \" Evidence remains inline in the surrounding information flow.\"] Flow, }", "cfg": [] }, { "id": "gpui_kit::agent::feedback::FeedbackRating", "name": "FeedbackRating", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "A helpful / not-helpful control with optional host-owned reason tags.", "documentation": "A helpful / not-helpful control with optional host-owned reason tags.", "signature": "# [doc = \" A helpful / not-helpful control with optional host-owned reason tags.\"] # [derive (IntoElement)] pub struct FeedbackRating { ident : Ident, vote : Option, tags : Vec<(SharedString, SharedString)>, current_tag : Option, disabled : bool, on_vote : Option, on_tag : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::feedback::FeedbackRating::current_tag", "name": "current_tag", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "", "documentation": "", "signature": "pub fn current_tag (mut self, tag : impl Into) -> Self", "cfg": [], "target": "FeedbackRating" }, { "id": "gpui_kit::agent::feedback::FeedbackRating::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "FeedbackRating" }, { "id": "gpui_kit::agent::feedback::FeedbackRating::on_tag", "name": "on_tag", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "", "documentation": "", "signature": "pub fn on_tag (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "FeedbackRating" }, { "id": "gpui_kit::agent::feedback::FeedbackRating::on_vote", "name": "on_vote", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "", "documentation": "", "signature": "pub fn on_vote (mut self, handler : impl Fn (FeedbackVote, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "FeedbackRating" }, { "id": "gpui_kit::agent::feedback::FeedbackRating::tags", "name": "tags", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "Reason tags as `(id, label)` pairs. Identity is the host's.", "documentation": "Reason tags as `(id, label)` pairs. Identity is the host's.", "signature": "pub fn tags (mut self, tags : impl IntoIterator, impl Into)>,) -> Self", "cfg": [], "target": "FeedbackRating" }, { "id": "gpui_kit::agent::feedback::FeedbackRating::vote", "name": "vote", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "", "documentation": "", "signature": "pub fn vote (mut self, vote : Option) -> Self", "cfg": [], "target": "FeedbackRating" }, { "id": "gpui_kit::agent::feedback::FeedbackRatingEvent", "name": "FeedbackRatingEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "What the rating reported.", "documentation": "What the rating reported.", "signature": "# [doc = \" What the rating reported.\"] # [derive (Debug, Clone, PartialEq)] pub enum FeedbackRatingEvent { Voted (FeedbackVote), Tagged (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::feedback::FeedbackVote", "name": "FeedbackVote", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "The two-way vote a reader can cast.", "documentation": "The two-way vote a reader can cast.", "signature": "# [doc = \" The two-way vote a reader can cast.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum FeedbackVote { Up, Down, }", "cfg": [] }, { "id": "gpui_kit::agent::feedback::FeedbackVote::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::feedback", "path": "gpui_kit::agent::feedback", "source": "crates/gpui-kit/src/agent/feedback.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "FeedbackVote" }, { "id": "gpui_kit::agent::model::AgentActivity", "name": "AgentActivity", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "What useful work an active agent is visibly doing.", "documentation": "What useful work an active agent is visibly doing.", "signature": "# [doc = \" What useful work an active agent is visibly doing.\"] # [derive (Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] # [serde (tag = \"activity\", content = \"detail\", rename_all = \"kebab-case\")] pub enum AgentActivity { # [default] Idle, Planning, Thinking, UsingTool (SharedString), Speaking, Aggregating, Custom (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentActivity::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "AgentActivity" }, { "id": "gpui_kit::agent::model::AgentDescriptor", "name": "AgentDescriptor", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "Identity and caller-owned description of one agent.", "documentation": "Identity and caller-owned description of one agent.", "signature": "# [doc = \" Identity and caller-owned description of one agent.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] pub struct AgentDescriptor { pub id : AgentId, pub name : SharedString, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub role : Option, # [serde (default, skip_serializing_if = \"Vec::is_empty\")] pub capabilities : Vec, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentDescriptor::capabilities", "name": "capabilities", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn capabilities (mut self, capabilities : impl IntoIterator>,) -> Self", "cfg": [], "target": "AgentDescriptor" }, { "id": "gpui_kit::agent::model::AgentDescriptor::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "AgentDescriptor" }, { "id": "gpui_kit::agent::model::AgentDescriptor::role", "name": "role", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn role (mut self, role : impl Into) -> Self", "cfg": [], "target": "AgentDescriptor" }, { "id": "gpui_kit::agent::model::AgentExecutionState", "name": "AgentExecutionState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "Mutually exclusive execution state for an agent, task, or run.", "documentation": "Mutually exclusive execution state for an agent, task, or run.", "signature": "# [doc = \" Mutually exclusive execution state for an agent, task, or run.\"] # [derive (Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] # [serde (tag = \"state\", content = \"detail\", rename_all = \"kebab-case\")] pub enum AgentExecutionState { # [default] Idle, Queued, Starting, Active (AgentActivity), Waiting (WaitReason), Blocked (SharedString), Cancelling, Completed (AgentOutcome), Unavailable (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentExecutionState::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "AgentExecutionState" }, { "id": "gpui_kit::agent::model::AgentExecutionState::busy", "name": "busy", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn busy (& self) -> bool", "cfg": [], "target": "AgentExecutionState" }, { "id": "gpui_kit::agent::model::AgentExecutionState::terminal", "name": "terminal", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn terminal (& self) -> bool", "cfg": [], "target": "AgentExecutionState" }, { "id": "gpui_kit::agent::model::AgentId", "name": "AgentId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The stable identity of an agent, independent of its role or display name.", "documentation": "The stable identity of an agent, independent of its role or display name.", "signature": "# [doc = \" The stable identity of an agent, independent of its role or display name.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (transparent)] pub struct AgentId (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "AgentId" }, { "id": "gpui_kit::agent::model::AgentId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "AgentId" }, { "id": "gpui_kit::agent::model::AgentModelIssue", "name": "AgentModelIssue", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "A structural problem found in an [`AgentRunSnapshot`].", "documentation": "A structural problem found in an [`AgentRunSnapshot`].", "signature": "# [doc = \" A structural problem found in an [`AgentRunSnapshot`].\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum AgentModelIssue { MissingRoot (AgentId), DuplicateAgent (AgentId), DuplicateTask (TaskId), DuplicateLink (RunLinkId), MissingTaskOwner { task : TaskId, owner : AgentId, }, MissingLinkEndpoint { link : RunLinkId, endpoint : RunSubjectId, }, SelfLink (RunLinkId), }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentOutcome", "name": "AgentOutcome", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The terminal result of an agent, task, or run.", "documentation": "The terminal result of an agent, task, or run.", "signature": "# [doc = \" The terminal result of an agent, task, or run.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] # [serde (tag = \"outcome\", content = \"reason\", rename_all = \"kebab-case\")] pub enum AgentOutcome { Succeeded, Partial (SharedString), Failed (SharedString), Refused (SharedString), Cancelled, TimedOut (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentOutcome::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "AgentOutcome" }, { "id": "gpui_kit::agent::model::AgentPresence", "name": "AgentPresence", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "Whether the host can presently reach an agent.", "documentation": "Whether the host can presently reach an agent.", "signature": "# [doc = \" Whether the host can presently reach an agent.\"] # [derive (Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] # [serde (tag = \"state\", content = \"reason\", rename_all = \"kebab-case\")] pub enum AgentPresence { # [default] Unknown, Online, Away, Offline, Unavailable (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentPresence::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "AgentPresence" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot", "name": "AgentRunSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "A complete observed run. The caller replaces or updates it as facts change.", "documentation": "A complete observed run. The caller replaces or updates it as facts change.", "signature": "# [doc = \" A complete observed run. The caller replaces or updates it as facts change.\"] # [derive (Debug, Clone, PartialEq, Serialize, Deserialize)] pub struct AgentRunSnapshot { pub id : RunId, pub root : AgentId, # [serde (default)] pub execution : AgentExecutionState, # [serde (default)] pub agents : Vec, # [serde (default)] pub tasks : Vec, # [serde (default)] pub links : Vec, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub aggregation : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::agents", "name": "agents", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn agents (mut self, agents : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::aggregation", "name": "aggregation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn aggregation (mut self, aggregation : AggregationSnapshot) -> Self", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::execution", "name": "execution", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn execution (mut self, execution : AgentExecutionState) -> Self", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::issues", "name": "issues", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "Reports malformed identities without changing the caller's data.", "documentation": "Reports malformed identities without changing the caller's data.", "signature": "pub fn issues (& self) -> Vec", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::links", "name": "links", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn links (mut self, links : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, root : impl Into) -> Self", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentRunSnapshot::tasks", "name": "tasks", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn tasks (mut self, tasks : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRunSnapshot" }, { "id": "gpui_kit::agent::model::AgentSnapshot", "name": "AgentSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "One agent at one observed point in a run.", "documentation": "One agent at one observed point in a run.", "signature": "# [doc = \" One agent at one observed point in a run.\"] # [derive (Debug, Clone, PartialEq, Serialize, Deserialize)] pub struct AgentSnapshot { pub descriptor : AgentDescriptor, # [serde (default)] pub presence : AgentPresence, # [serde (default)] pub execution : AgentExecutionState, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub current_task : Option, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub progress : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentSnapshot::current_task", "name": "current_task", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn current_task (mut self, task : impl Into) -> Self", "cfg": [], "target": "AgentSnapshot" }, { "id": "gpui_kit::agent::model::AgentSnapshot::execution", "name": "execution", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn execution (mut self, execution : AgentExecutionState) -> Self", "cfg": [], "target": "AgentSnapshot" }, { "id": "gpui_kit::agent::model::AgentSnapshot::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (descriptor : AgentDescriptor) -> Self", "cfg": [], "target": "AgentSnapshot" }, { "id": "gpui_kit::agent::model::AgentSnapshot::presence", "name": "presence", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn presence (mut self, presence : AgentPresence) -> Self", "cfg": [], "target": "AgentSnapshot" }, { "id": "gpui_kit::agent::model::AgentSnapshot::progress", "name": "progress", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn progress (mut self, progress : f32) -> Self", "cfg": [], "target": "AgentSnapshot" }, { "id": "gpui_kit::agent::model::AgentTaskSnapshot", "name": "AgentTaskSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "One caller-owned task in a run.", "documentation": "One caller-owned task in a run.", "signature": "# [doc = \" One caller-owned task in a run.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] pub struct AgentTaskSnapshot { pub id : TaskId, pub label : SharedString, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub owner : Option, # [serde (default)] pub execution : AgentExecutionState, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentTaskSnapshot::execution", "name": "execution", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn execution (mut self, execution : AgentExecutionState) -> Self", "cfg": [], "target": "AgentTaskSnapshot" }, { "id": "gpui_kit::agent::model::AgentTaskSnapshot::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "AgentTaskSnapshot" }, { "id": "gpui_kit::agent::model::AgentTaskSnapshot::owner", "name": "owner", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn owner (mut self, owner : impl Into) -> Self", "cfg": [], "target": "AgentTaskSnapshot" }, { "id": "gpui_kit::agent::model::AgentUiAction", "name": "AgentUiAction", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "An action a multi-agent surface asks the host to consider.", "documentation": "An action a multi-agent surface asks the host to consider.\n\nThe component does not apply the action. In particular, requesting\ncancellation is not the same thing as observing `Cancelling` or\n`Cancelled` in a later snapshot.", "signature": "# [doc = \" An action a multi-agent surface asks the host to consider.\"] # [doc = \"\"] # [doc = \" The component does not apply the action. In particular, requesting\"] # [doc = \" cancellation is not the same thing as observing `Cancelling` or\"] # [doc = \" `Cancelled` in a later snapshot.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum AgentUiAction { SelectAgent (AgentId), OpenTask (TaskId), RequestCancel (RunSubjectId), RequestRetry (RunSubjectId), FocusResult (RunSubjectId), }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentVisualEvent", "name": "AgentVisualEvent", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "A semantic event ready for the shared effects policy.", "documentation": "A semantic event ready for the shared effects policy.\n\n`target` is the subject the event lands on. `origin`, when supplied, is the\nparent, delegator, or handoff source. `surface` scopes the automatic budget;\nall three identities remain host-owned facts.", "signature": "# [doc = \" A semantic event ready for the shared effects policy.\"] # [doc = \"\"] # [doc = \" `target` is the subject the event lands on. `origin`, when supplied, is the\"] # [doc = \" parent, delegator, or handoff source. `surface` scopes the automatic budget;\"] # [doc = \" all three identities remain host-owned facts.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] pub struct AgentVisualEvent { pub id : VisualEventId, pub surface : SharedString, pub kind : AgentVisualEventKind, pub target : RunSubjectId, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub origin : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentVisualEvent::effect_event", "name": "effect_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "Normalizes agent identities and meaning without choosing an effect.", "documentation": "Normalizes agent identities and meaning without choosing an effect.", "signature": "pub fn effect_event (& self) -> EffectEvent", "cfg": [], "target": "AgentVisualEvent" }, { "id": "gpui_kit::agent::model::AgentVisualEvent::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, surface : impl Into, kind : AgentVisualEventKind, target : RunSubjectId,) -> Self", "cfg": [], "target": "AgentVisualEvent" }, { "id": "gpui_kit::agent::model::AgentVisualEvent::origin", "name": "origin", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn origin (mut self, origin : RunSubjectId) -> Self", "cfg": [], "target": "AgentVisualEvent" }, { "id": "gpui_kit::agent::model::AgentVisualEventKind", "name": "AgentVisualEventKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The agent-domain meaning of one transient visual event.", "documentation": "The agent-domain meaning of one transient visual event.\n\nHosts report these facts instead of selecting an animation recipe. The\neffects policy maps them onto product-neutral [`VisualCue`]s, quality,\naccessibility, replay, and budget decisions.", "signature": "# [doc = \" The agent-domain meaning of one transient visual event.\"] # [doc = \"\"] # [doc = \" Hosts report these facts instead of selecting an animation recipe. The\"] # [doc = \" effects policy maps them onto product-neutral [`VisualCue`]s, quality,\"] # [doc = \" accessibility, replay, and budget decisions.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (rename_all = \"kebab-case\")] pub enum AgentVisualEventKind { AgentSpawned, DelegationStarted, HandoffCommitted, ResultAggregated, AgentSucceeded, AgentRefused, AgentFailed, RewardGranted, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AgentVisualEventKind::cue", "name": "cue", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn cue (self) -> VisualCue", "cfg": [], "target": "AgentVisualEventKind" }, { "id": "gpui_kit::agent::model::AggregationSnapshot", "name": "AggregationSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "A caller-owned count of the results being combined.", "documentation": "A caller-owned count of the results being combined.", "signature": "# [doc = \" A caller-owned count of the results being combined.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] pub struct AggregationSnapshot { pub expected : usize, pub received : usize, # [serde (default)] pub conflicts : usize, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub outcome : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::model::AggregationSnapshot::conflicts", "name": "conflicts", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn conflicts (mut self, conflicts : usize) -> Self", "cfg": [], "target": "AggregationSnapshot" }, { "id": "gpui_kit::agent::model::AggregationSnapshot::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (expected : usize, received : usize) -> Self", "cfg": [], "target": "AggregationSnapshot" }, { "id": "gpui_kit::agent::model::AggregationSnapshot::outcome", "name": "outcome", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn outcome (mut self, outcome : AgentOutcome) -> Self", "cfg": [], "target": "AggregationSnapshot" }, { "id": "gpui_kit::agent::model::InvocationId", "name": "InvocationId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The stable identity of one tool or capability invocation.", "documentation": "The stable identity of one tool or capability invocation.", "signature": "# [doc = \" The stable identity of one tool or capability invocation.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (transparent)] pub struct InvocationId (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::model::InvocationId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "InvocationId" }, { "id": "gpui_kit::agent::model::InvocationId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "InvocationId" }, { "id": "gpui_kit::agent::model::RunId", "name": "RunId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The stable identity of one run.", "documentation": "The stable identity of one run.", "signature": "# [doc = \" The stable identity of one run.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (transparent)] pub struct RunId (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::model::RunId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "RunId" }, { "id": "gpui_kit::agent::model::RunId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "RunId" }, { "id": "gpui_kit::agent::model::RunLink", "name": "RunLink", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "One typed relationship between two run subjects.", "documentation": "One typed relationship between two run subjects.", "signature": "# [doc = \" One typed relationship between two run subjects.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] pub struct RunLink { pub id : RunLinkId, pub from : RunSubjectId, pub to : RunSubjectId, pub kind : RunLinkKind, # [serde (default, skip_serializing_if = \"Option::is_none\")] pub label : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::model::RunLink::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "RunLink" }, { "id": "gpui_kit::agent::model::RunLink::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, from : RunSubjectId, to : RunSubjectId, kind : RunLinkKind,) -> Self", "cfg": [], "target": "RunLink" }, { "id": "gpui_kit::agent::model::RunLinkId", "name": "RunLinkId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The stable identity of a topology relationship.", "documentation": "The stable identity of a topology relationship.", "signature": "# [doc = \" The stable identity of a topology relationship.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (transparent)] pub struct RunLinkId (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::model::RunLinkId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "RunLinkId" }, { "id": "gpui_kit::agent::model::RunLinkId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "RunLinkId" }, { "id": "gpui_kit::agent::model::RunLinkKind", "name": "RunLinkKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The meaning of a topology relationship.", "documentation": "The meaning of a topology relationship.", "signature": "# [doc = \" The meaning of a topology relationship.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (rename_all = \"kebab-case\")] pub enum RunLinkKind { Spawn, Delegation, Dependency, Handoff, Report, Aggregation, Retry, }", "cfg": [] }, { "id": "gpui_kit::agent::model::RunLinkKind::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (self) -> & 'static str", "cfg": [], "target": "RunLinkKind" }, { "id": "gpui_kit::agent::model::RunSubjectId", "name": "RunSubjectId", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "What kind of thing one topology endpoint identifies.", "documentation": "What kind of thing one topology endpoint identifies.", "signature": "# [doc = \" What kind of thing one topology endpoint identifies.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (tag = \"kind\", content = \"id\", rename_all = \"kebab-case\")] pub enum RunSubjectId { Agent (AgentId), Task (TaskId), Invocation (InvocationId), }", "cfg": [] }, { "id": "gpui_kit::agent::model::RunSubjectId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "RunSubjectId" }, { "id": "gpui_kit::agent::model::TaskId", "name": "TaskId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The stable identity of one task in a run.", "documentation": "The stable identity of one task in a run.", "signature": "# [doc = \" The stable identity of one task in a run.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (transparent)] pub struct TaskId (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::model::TaskId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "TaskId" }, { "id": "gpui_kit::agent::model::TaskId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "TaskId" }, { "id": "gpui_kit::agent::model::VisualEventId", "name": "VisualEventId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "The stable identity of a transient visual event.", "documentation": "The stable identity of a transient visual event.\n\nAn effect player uses this to avoid replaying a celebration after a stream\nreconnects, and as the deterministic seed for any decorative particles.", "signature": "# [doc = \" The stable identity of a transient visual event.\"] # [doc = \"\"] # [doc = \" An effect player uses this to avoid replaying a celebration after a stream\"] # [doc = \" reconnects, and as the deterministic seed for any decorative particles.\"] # [derive (Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] # [serde (transparent)] pub struct VisualEventId (SharedString);", "cfg": [] }, { "id": "gpui_kit::agent::model::VisualEventId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "VisualEventId" }, { "id": "gpui_kit::agent::model::VisualEventId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "VisualEventId" }, { "id": "gpui_kit::agent::model::WaitReason", "name": "WaitReason", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "Why an agent or task is waiting rather than making progress.", "documentation": "Why an agent or task is waiting rather than making progress.", "signature": "# [doc = \" Why an agent or task is waiting rather than making progress.\"] # [derive (Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] # [serde (tag = \"reason\", content = \"detail\", rename_all = \"kebab-case\")] pub enum WaitReason { UserInput, Approval, Dependency (TaskId), RemoteAgent (AgentId), RateLimit, Custom (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::model::WaitReason::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::model", "path": "gpui_kit::agent::model", "source": "crates/gpui-kit/src/agent/model.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "WaitReason" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog", "name": "OfferingCatalog", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "A searchable, kind-filterable catalog of offerings from multiple servers.", "documentation": "A searchable, kind-filterable catalog of offerings from multiple servers.", "signature": "# [doc = \" A searchable, kind-filterable catalog of offerings from multiple servers.\"] # [derive (IntoElement)] pub struct OfferingCatalog { ident : Ident, sources : Vec, query : SharedString, kinds : Vec, selected : Option, size : ControlSize, disabled : bool, on_activate : Option, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::kinds", "name": "kinds", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "Included kinds. An empty collection includes all kinds.", "documentation": "Included kinds. An empty collection includes all kinds.", "signature": "pub fn kinds (mut self, kinds : impl IntoIterator) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::on_activate", "name": "on_activate", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "Reports activation with both identities. The component performs no action.", "documentation": "Reports activation with both identities. The component performs no action.", "signature": "pub fn on_activate (mut self, handler : impl Fn (OfferingIdentity, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::query", "name": "query", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "The caller-owned query matched against each offering's searchable text.", "documentation": "The caller-owned query matched against each offering's searchable text.", "signature": "pub fn query (mut self, query : impl Into) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, identity : OfferingIdentity) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::source", "name": "source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn source (mut self, source : OfferingSource) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingCatalog::sources", "name": "sources", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn sources (mut self, sources : impl IntoIterator) -> Self", "cfg": [], "target": "OfferingCatalog" }, { "id": "gpui_kit::agent::offering_catalog::OfferingIdentity", "name": "OfferingIdentity", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "Stable identity for one server-owned offering.", "documentation": "Stable identity for one server-owned offering.", "signature": "# [doc = \" Stable identity for one server-owned offering.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct OfferingIdentity { pub server_id : SharedString, pub offering_id : SharedString, }", "cfg": [] }, { "id": "gpui_kit::agent::offering_catalog::OfferingIdentity::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn new (server_id : impl Into, offering_id : impl Into) -> Self", "cfg": [], "target": "OfferingIdentity" }, { "id": "gpui_kit::agent::offering_catalog::OfferingSource", "name": "OfferingSource", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "One attributed source and its independently truthful state.", "documentation": "One attributed source and its independently truthful state.", "signature": "# [doc = \" One attributed source and its independently truthful state.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct OfferingSource { id : SharedString, name : SharedString, state : OfferingSourceState, }", "cfg": [] }, { "id": "gpui_kit::agent::offering_catalog::OfferingSource::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "OfferingSource" }, { "id": "gpui_kit::agent::offering_catalog::OfferingSource::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, name : impl Into, state : OfferingSourceState,) -> Self", "cfg": [], "target": "OfferingSource" }, { "id": "gpui_kit::agent::offering_catalog::OfferingSource::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn state (& self) -> & OfferingSourceState", "cfg": [], "target": "OfferingSource" }, { "id": "gpui_kit::agent::offering_catalog::OfferingSourceState", "name": "OfferingSourceState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "What is truthfully known about one source's offerings.", "documentation": "What is truthfully known about one source's offerings.", "signature": "# [doc = \" What is truthfully known about one source's offerings.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum OfferingSourceState { Loading, Empty, Unavailable (SharedString), Error (SharedString), Ready (Vec), # [doc = \" The source's last verified results remain visible beside the failure.\"] Stale { offerings : Vec, reason : SharedString, }, }", "cfg": [] }, { "id": "gpui_kit::agent::offering_catalog::OfferingSourceState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "OfferingSourceState" }, { "id": "gpui_kit::agent::offering_catalog::SearchableOffering", "name": "SearchableOffering", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "An offering and the caller-authored text used to search it.", "documentation": "An offering and the caller-authored text used to search it.", "signature": "# [doc = \" An offering and the caller-authored text used to search it.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct SearchableOffering { offering : Offering, searchable_text : SharedString, }", "cfg": [] }, { "id": "gpui_kit::agent::offering_catalog::SearchableOffering::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn new (offering : Offering, searchable_text : impl Into) -> Self", "cfg": [], "target": "SearchableOffering" }, { "id": "gpui_kit::agent::offering_catalog::SearchableOffering::offering", "name": "offering", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::offering_catalog", "path": "gpui_kit::agent::offering_catalog", "source": "crates/gpui-kit/src/agent/offering_catalog.rs", "summary": "", "documentation": "", "signature": "pub fn offering (& self) -> & Offering", "cfg": [], "target": "SearchableOffering" }, { "id": "gpui_kit::agent::permission::PermissionAction", "name": "PermissionAction", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "One column: an action, addressed by a stable key.", "documentation": "One column: an action, addressed by a stable key.", "signature": "# [doc = \" One column: an action, addressed by a stable key.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct PermissionAction { key : SharedString, label : SharedString, }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionAction::key", "name": "key", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn key (& self) -> & SharedString", "cfg": [], "target": "PermissionAction" }, { "id": "gpui_kit::agent::permission::PermissionAction::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn new (key : impl Into, label : impl Into) -> Self", "cfg": [], "target": "PermissionAction" }, { "id": "gpui_kit::agent::permission::PermissionChange", "name": "PermissionChange", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "What operating a cell asks for. Nothing is applied.", "documentation": "What operating a cell asks for. Nothing is applied.", "signature": "# [doc = \" What operating a cell asks for. Nothing is applied.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct PermissionChange { pub subject : SharedString, pub action : SharedString, pub next : PermissionState, }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionEntry", "name": "PermissionEntry", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "One cell: a state, and where it came from.", "documentation": "One cell: a state, and where it came from.", "signature": "# [doc = \" One cell: a state, and where it came from.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct PermissionEntry { state : PermissionState, source : PermissionSource, }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionEntry::inherited", "name": "inherited", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "A state a broader rule decided, naming that rule.", "documentation": "A state a broader rule decided, naming that rule.", "signature": "pub fn inherited (state : PermissionState, from : impl Into) -> Self", "cfg": [], "target": "PermissionEntry" }, { "id": "gpui_kit::agent::permission::PermissionEntry::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "A state decided in this matrix.", "documentation": "A state decided in this matrix.", "signature": "pub fn new (state : PermissionState) -> Self", "cfg": [], "target": "PermissionEntry" }, { "id": "gpui_kit::agent::permission::PermissionEntry::source", "name": "source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn source (& self) -> & PermissionSource", "cfg": [], "target": "PermissionEntry" }, { "id": "gpui_kit::agent::permission::PermissionEntry::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn state (& self) -> PermissionState", "cfg": [], "target": "PermissionEntry" }, { "id": "gpui_kit::agent::permission::PermissionMatrix", "name": "PermissionMatrix", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "A grid of subjects against actions.", "documentation": "A grid of subjects against actions.", "signature": "# [doc = \" A grid of subjects against actions.\"] # [derive (IntoElement)] pub struct PermissionMatrix { ident : Ident, actions : Vec, subjects : Vec, on_change : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionMatrix::action", "name": "action", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn action (mut self, action : PermissionAction) -> Self", "cfg": [], "target": "PermissionMatrix" }, { "id": "gpui_kit::agent::permission::PermissionMatrix::actions", "name": "actions", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn actions (mut self, actions : impl IntoIterator) -> Self", "cfg": [], "target": "PermissionMatrix" }, { "id": "gpui_kit::agent::permission::PermissionMatrix::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "PermissionMatrix" }, { "id": "gpui_kit::agent::permission::PermissionMatrix::on_change", "name": "on_change", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "Makes the matrix editable. Without a handler it is read-only, and a read-only cell installs nothing rather than installing a handler that does nothing.", "documentation": "Makes the matrix editable. Without a handler it is read-only, and a\nread-only cell installs nothing rather than installing a handler that\ndoes nothing.", "signature": "pub fn on_change (mut self, handler : impl Fn (PermissionChange, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "PermissionMatrix" }, { "id": "gpui_kit::agent::permission::PermissionMatrix::subject", "name": "subject", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn subject (mut self, subject : PermissionSubject) -> Self", "cfg": [], "target": "PermissionMatrix" }, { "id": "gpui_kit::agent::permission::PermissionMatrix::subjects", "name": "subjects", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn subjects (mut self, subjects : impl IntoIterator) -> Self", "cfg": [], "target": "PermissionMatrix" }, { "id": "gpui_kit::agent::permission::PermissionSource", "name": "PermissionSource", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "Where a cell's state was decided.", "documentation": "Where a cell's state was decided.", "signature": "# [doc = \" Where a cell's state was decided.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum PermissionSource { # [doc = \" Set on this subject, for this action.\"] # [default] Here, # [doc = \" Inherited from a broader rule, named in the host's own words.\"] Inherited (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionSource::inherited", "name": "inherited", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn inherited (from : impl Into) -> Self", "cfg": [], "target": "PermissionSource" }, { "id": "gpui_kit::agent::permission::PermissionSource::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn label (& self, cx : & App) -> SharedString", "cfg": [], "target": "PermissionSource" }, { "id": "gpui_kit::agent::permission::PermissionSource::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "The stable name published in the semantic tree.", "documentation": "The stable name published in the semantic tree.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "PermissionSource" }, { "id": "gpui_kit::agent::permission::PermissionState", "name": "PermissionState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "What a cell says about one subject and one action.", "documentation": "What a cell says about one subject and one action.", "signature": "# [doc = \" What a cell says about one subject and one action.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum PermissionState { # [doc = \" Goes ahead without asking.\"] Allowed, # [doc = \" Refused. Somebody decided this.\"] Denied, # [doc = \" Permitted only after somebody says so, every time.\"] # [default] Ask, # [doc = \" The question does not arise here. Never a refusal.\"] NotApplicable, }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionState::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "The localized state name published for assistive readers and help.", "documentation": "The localized state name published for assistive readers and help.", "signature": "pub fn label (self, cx : & App) -> SharedString", "cfg": [], "target": "PermissionState" }, { "id": "gpui_kit::agent::permission::PermissionState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "The stable name published in the semantic tree.", "documentation": "The stable name published in the semantic tree.", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "PermissionState" }, { "id": "gpui_kit::agent::permission::PermissionState::next", "name": "next", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "What operating the cell would ask for next.", "documentation": "What operating the cell would ask for next.\n\n`NotApplicable` has no next state: a question that does not arise\ncannot be answered by clicking.", "signature": "pub fn next (self) -> Option", "cfg": [], "target": "PermissionState" }, { "id": "gpui_kit::agent::permission::PermissionSubject", "name": "PermissionSubject", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "One row: whatever the permissions are about, and its cells.", "documentation": "One row: whatever the permissions are about, and its cells.", "signature": "# [doc = \" One row: whatever the permissions are about, and its cells.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct PermissionSubject { id : SharedString, label : SharedString, cells : Vec<(SharedString, PermissionEntry)>, }", "cfg": [] }, { "id": "gpui_kit::agent::permission::PermissionSubject::cell", "name": "cell", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "States one cell. An action this subject never states is rendered `NotApplicable`, which is the honest reading of a row that does not mention it — and is still not a refusal.", "documentation": "States one cell. An action this subject never states is rendered\n`NotApplicable`, which is the honest reading of a row that does not\nmention it — and is still not a refusal.", "signature": "pub fn cell (mut self, action : impl Into, entry : PermissionEntry) -> Self", "cfg": [], "target": "PermissionSubject" }, { "id": "gpui_kit::agent::permission::PermissionSubject::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "PermissionSubject" }, { "id": "gpui_kit::agent::permission::PermissionSubject::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::permission", "path": "gpui_kit::agent::permission", "source": "crates/gpui-kit/src/agent/permission.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "PermissionSubject" }, { "id": "gpui_kit::agent::persona::DialogueChoice", "name": "DialogueChoice", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "One caller-owned action offered after a dialogue turn.", "documentation": "One caller-owned action offered after a dialogue turn.", "signature": "# [doc = \" One caller-owned action offered after a dialogue turn.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct DialogueChoice { id : SharedString, label : SharedString, detail : Option, availability : DialogueChoiceAvailability, selected : bool, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::DialogueChoice::detail", "name": "detail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn detail (mut self, detail : impl Into) -> Self", "cfg": [], "target": "DialogueChoice" }, { "id": "gpui_kit::agent::persona::DialogueChoice::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "DialogueChoice" }, { "id": "gpui_kit::agent::persona::DialogueChoice::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "DialogueChoice" }, { "id": "gpui_kit::agent::persona::DialogueChoice::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : bool) -> Self", "cfg": [], "target": "DialogueChoice" }, { "id": "gpui_kit::agent::persona::DialogueChoice::unavailable", "name": "unavailable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn unavailable (mut self, reason : impl Into) -> Self", "cfg": [], "target": "DialogueChoice" }, { "id": "gpui_kit::agent::persona::DialogueChoiceAvailability", "name": "DialogueChoiceAvailability", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Whether a dialogue choice can presently be requested.", "documentation": "Whether a dialogue choice can presently be requested.", "signature": "# [doc = \" Whether a dialogue choice can presently be requested.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum DialogueChoiceAvailability { # [default] Available, Unavailable (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::persona::DialogueTurn", "name": "DialogueTurn", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "One complete caller-owned persona turn.", "documentation": "One complete caller-owned persona turn.", "signature": "# [doc = \" One complete caller-owned persona turn.\"] # [derive (Debug, Clone, PartialEq)] pub struct DialogueTurn { id : SharedString, agent : AgentSnapshot, body : MessageBody, streaming : bool, choices : Vec, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::DialogueTurn::choice", "name": "choice", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn choice (mut self, choice : DialogueChoice) -> Self", "cfg": [], "target": "DialogueTurn" }, { "id": "gpui_kit::agent::persona::DialogueTurn::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "DialogueTurn" }, { "id": "gpui_kit::agent::persona::DialogueTurn::markdown", "name": "markdown", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn markdown (id : impl Into, agent : AgentSnapshot, source : impl Into,) -> Self", "cfg": [], "target": "DialogueTurn" }, { "id": "gpui_kit::agent::persona::DialogueTurn::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, agent : AgentSnapshot, body : impl Into,) -> Self", "cfg": [], "target": "DialogueTurn" }, { "id": "gpui_kit::agent::persona::DialogueTurn::streaming", "name": "streaming", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn streaming (mut self, streaming : bool) -> Self", "cfg": [], "target": "DialogueTurn" }, { "id": "gpui_kit::agent::persona::PersonaDialogue", "name": "PersonaDialogue", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Persona-aware dialogue over the safe Markdown renderer.", "documentation": "Persona-aware dialogue over the safe Markdown renderer.\n\nPortrait placement, expression treatment, status, streaming presentation,\nchoice layout, RTL order, and disabled explanations are all owned here.\nThe component never advances the turn or applies a choice.", "signature": "# [doc = \" Persona-aware dialogue over the safe Markdown renderer.\"] # [doc = \"\"] # [doc = \" Portrait placement, expression treatment, status, streaming presentation,\"] # [doc = \" choice layout, RTL order, and disabled explanations are all owned here.\"] # [doc = \" The component never advances the turn or applies a choice.\"] # [derive (IntoElement)] pub struct PersonaDialogue { ident : Ident, turn : DialogueTurn, expression : PersonaExpression, voice : Option, image : Option, tint : Option, on_event : Option, image_source : Option, highlighter : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::PersonaDialogue::expression", "name": "expression", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn expression (mut self, expression : PersonaExpression) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn image (mut self, image : impl Into) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::image_source", "name": "image_source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Uses caller-resolved portrait art without converting it to a URI.", "documentation": "Uses caller-resolved portrait art without converting it to a URI.", "signature": "pub fn image_source (mut self, image : gpui::ImageSource) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::markdown_highlighter", "name": "markdown_highlighter", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Supplies host-computed code spans without moving grammar policy here.", "documentation": "Supplies host-computed code spans without moving grammar policy here.", "signature": "pub fn markdown_highlighter (mut self, highlighter : impl Fn (& SharedString, & CodeBlock) -> Vec + 'static,) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::markdown_image", "name": "markdown_image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Supplies an already-resolved image for a Markdown request.", "documentation": "Supplies an already-resolved image for a Markdown request.", "signature": "pub fn markdown_image (mut self, source : impl Fn (& SharedString, & ImageRequest, & mut Window, & mut App) -> Option + 'static,) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, turn : DialogueTurn) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& PersonaDialogueEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogue::voice", "name": "voice", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn voice (mut self, sample : VoiceSample) -> Self", "cfg": [], "target": "PersonaDialogue" }, { "id": "gpui_kit::agent::persona::PersonaDialogueEvent", "name": "PersonaDialogueEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "What persona dialogue reports without applying it.", "documentation": "What persona dialogue reports without applying it.", "signature": "# [doc = \" What persona dialogue reports without applying it.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum PersonaDialogueEvent { ChoiceRequested { turn_id : SharedString, choice_id : SharedString, }, Markdown { turn_id : SharedString, event : MarkdownEvent, }, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::PersonaExpression", "name": "PersonaExpression", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "A caller-observed expression, independent of execution state.", "documentation": "A caller-observed expression, independent of execution state.\n\nAn agent may be focused while idle or warm while speaking. Keeping this\nfact separate prevents portrait styling from changing what the execution\nsurface reports.", "signature": "# [doc = \" A caller-observed expression, independent of execution state.\"] # [doc = \"\"] # [doc = \" An agent may be focused while idle or warm while speaking. Keeping this\"] # [doc = \" fact separate prevents portrait styling from changing what the execution\"] # [doc = \" surface reports.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum PersonaExpression { # [default] Neutral, Warm, Focused, Concerned, Celebrating, # [doc = \" A host-owned expression name. It receives the neutral visual treatment\"] # [doc = \" rather than guessing what the name means.\"] Custom (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::persona::PersonaExpression::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & str", "cfg": [], "target": "PersonaExpression" }, { "id": "gpui_kit::agent::persona::PersonaPortrait", "name": "PersonaPortrait", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "A large expressive portrait built on the standard [`AgentAvatar`].", "documentation": "A large expressive portrait built on the standard [`AgentAvatar`].\n\nAn optional [`EffectPlan`] is a decorative layer only. Its semantic event,\nbudget, replay, quality, and reduced-motion decision were already resolved\nby the shared effects policy.", "signature": "# [doc = \" A large expressive portrait built on the standard [`AgentAvatar`].\"] # [doc = \"\"] # [doc = \" An optional [`EffectPlan`] is a decorative layer only. Its semantic event,\"] # [doc = \" budget, replay, quality, and reduced-motion decision were already resolved\"] # [doc = \" by the shared effects policy.\"] # [derive (Debug, IntoElement)] pub struct PersonaPortrait { ident : Ident, agent : AgentSnapshot, expression : PersonaExpression, voice : Option, image : Option, tint : Option, effect : Option, sample_at : Option, size : f32, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::PersonaPortrait::effect", "name": "effect", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn effect (mut self, plan : EffectPlan) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::expression", "name": "expression", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn expression (mut self, expression : PersonaExpression) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "A host-resolved resource path or URI. This component performs no fetch.", "documentation": "A host-resolved resource path or URI. This component performs no fetch.", "signature": "pub fn image (mut self, image : impl Into) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::image_source", "name": "image_source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Uses caller-resolved portrait art and preserves custom loading policy.", "documentation": "Uses caller-resolved portrait art and preserves custom loading policy.", "signature": "pub fn image_source (mut self, image : gpui::ImageSource) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, agent : AgentSnapshot) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::sample_at", "name": "sample_at", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn sample_at (mut self, elapsed : Duration) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::size", "name": "size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn size (mut self, size : f32) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::PersonaPortrait::voice", "name": "voice", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn voice (mut self, sample : VoiceSample) -> Self", "cfg": [], "target": "PersonaPortrait" }, { "id": "gpui_kit::agent::persona::VoiceField", "name": "VoiceField", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Which normalized voice field failed validation.", "documentation": "Which normalized voice field failed validation.", "signature": "# [doc = \" Which normalized voice field failed validation.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum VoiceField { Level, Envelope, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::VoiceReactive", "name": "VoiceReactive", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "A standard voice-reactive visualization from a normalized host sample.", "documentation": "A standard voice-reactive visualization from a normalized host sample.\n\nLive samples animate from one component-owned timeline. [`Self::sample_at`]\nfreezes that timeline at an absolute instant for replay and headless\nrendering. Reduced motion shows the current envelope as a static symmetric\nmeter and schedules no frames.", "signature": "# [doc = \" A standard voice-reactive visualization from a normalized host sample.\"] # [doc = \"\"] # [doc = \" Live samples animate from one component-owned timeline. [`Self::sample_at`]\"] # [doc = \" freezes that timeline at an absolute instant for replay and headless\"] # [doc = \" rendering. Reduced motion shows the current envelope as a static symmetric\"] # [doc = \" meter and schedules no frames.\"] # [derive (Debug, IntoElement)] pub struct VoiceReactive { ident : Ident, sample : VoiceSample, sample_at : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::VoiceReactive::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, sample : VoiceSample) -> Self", "cfg": [], "target": "VoiceReactive" }, { "id": "gpui_kit::agent::persona::VoiceReactive::sample_at", "name": "sample_at", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn sample_at (mut self, elapsed : Duration) -> Self", "cfg": [], "target": "VoiceReactive" }, { "id": "gpui_kit::agent::persona::VoiceSample", "name": "VoiceSample", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "One bounded, caller-sampled voice observation.", "documentation": "One bounded, caller-sampled voice observation.\n\n`level` is the current normalized energy and `envelope` is the host's\nnormalized smoothed energy. Kit turns both into bars and pulses; callers do\nnot pass bar heights, colours, smoothing constants, or animation timing.", "signature": "# [doc = \" One bounded, caller-sampled voice observation.\"] # [doc = \"\"] # [doc = \" `level` is the current normalized energy and `envelope` is the host's\"] # [doc = \" normalized smoothed energy. Kit turns both into bars and pulses; callers do\"] # [doc = \" not pass bar heights, colours, smoothing constants, or animation timing.\"] # [derive (Debug, Clone, PartialEq)] pub struct VoiceSample { state : VoiceState, level : f32, envelope : f32, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::VoiceSample::envelope", "name": "envelope", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn envelope (& self) -> f32", "cfg": [], "target": "VoiceSample" }, { "id": "gpui_kit::agent::persona::VoiceSample::level", "name": "level", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn level (& self) -> f32", "cfg": [], "target": "VoiceSample" }, { "id": "gpui_kit::agent::persona::VoiceSample::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn new (state : VoiceState, level : f32, envelope : f32) -> Result", "cfg": [], "target": "VoiceSample" }, { "id": "gpui_kit::agent::persona::VoiceSample::silent", "name": "silent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn silent () -> Self", "cfg": [], "target": "VoiceSample" }, { "id": "gpui_kit::agent::persona::VoiceSample::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn state (& self) -> & VoiceState", "cfg": [], "target": "VoiceSample" }, { "id": "gpui_kit::agent::persona::VoiceSampleError", "name": "VoiceSampleError", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "A rejected voice sample. Invalid values are never clamped into plausible audio facts.", "documentation": "A rejected voice sample. Invalid values are never clamped into plausible\naudio facts.", "signature": "# [doc = \" A rejected voice sample. Invalid values are never clamped into plausible\"] # [doc = \" audio facts.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct VoiceSampleError { pub field : VoiceField, pub kind : VoiceSampleErrorKind, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::VoiceSampleErrorKind", "name": "VoiceSampleErrorKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Why a voice sample was rejected.", "documentation": "Why a voice sample was rejected.", "signature": "# [doc = \" Why a voice sample was rejected.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum VoiceSampleErrorKind { NonFinite, OutOfRange, }", "cfg": [] }, { "id": "gpui_kit::agent::persona::VoiceState", "name": "VoiceState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "Whether a host-observed voice channel is active.", "documentation": "Whether a host-observed voice channel is active.", "signature": "# [doc = \" Whether a host-observed voice channel is active.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum VoiceState { # [default] Silent, Listening, Speaking, Unavailable (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::persona::VoiceState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::persona", "path": "gpui_kit::agent::persona", "source": "crates/gpui-kit/src/agent/persona.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "VoiceState" }, { "id": "gpui_kit::agent::plan::AgentPlan", "name": "AgentPlan", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "A plan, as a run of marks and one line about the item in flight.", "documentation": "A plan, as a run of marks and one line about the item in flight.", "signature": "# [doc = \" A plan, as a run of marks and one line about the item in flight.\"] # [derive (IntoElement)] pub struct AgentPlan { ident : Ident, items : Vec, on_pick : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::plan::AgentPlan::done", "name": "done", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "How many items have finished, which is what the summary publishes.", "documentation": "How many items have finished, which is what the summary publishes.", "signature": "pub fn done (& self) -> usize", "cfg": [], "target": "AgentPlan" }, { "id": "gpui_kit::agent::plan::AgentPlan::item", "name": "item", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn item (mut self, item : PlanItem) -> Self", "cfg": [], "target": "AgentPlan" }, { "id": "gpui_kit::agent::plan::AgentPlan::items", "name": "items", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn items (mut self, items : impl IntoIterator) -> Self", "cfg": [], "target": "AgentPlan" }, { "id": "gpui_kit::agent::plan::AgentPlan::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "AgentPlan" }, { "id": "gpui_kit::agent::plan::AgentPlan::on_pick", "name": "on_pick", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "Reports the id of the item that was picked. Without this the marks are a report and install no handler at all.", "documentation": "Reports the id of the item that was picked. Without this the marks are\na report and install no handler at all.", "signature": "pub fn on_pick (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "AgentPlan" }, { "id": "gpui_kit::agent::plan::PlanItem", "name": "PlanItem", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "One item of a plan.", "documentation": "One item of a plan.", "signature": "# [doc = \" One item of a plan.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct PlanItem { id : SharedString, label : SharedString, state : PlanState, }", "cfg": [] }, { "id": "gpui_kit::agent::plan::PlanItem::blocked", "name": "blocked", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn blocked (self, reason : impl Into) -> Self", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanItem::doing", "name": "doing", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn doing (self) -> Self", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanItem::done", "name": "done", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn done (self) -> Self", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanItem::dropped", "name": "dropped", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn dropped (self, reason : impl Into) -> Self", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanItem::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "What the reader is told this item is, in the caller's words.", "documentation": "What the reader is told this item is, in the caller's words.", "signature": "pub fn label (& self) -> & SharedString", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanItem::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanItem::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : PlanState) -> Self", "cfg": [], "target": "PlanItem" }, { "id": "gpui_kit::agent::plan::PlanState", "name": "PlanState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "Where one item of a plan stands.", "documentation": "Where one item of a plan stands.\n\nAhead, doing and done are the three a plan is mostly made of. The other two\nare the ones a plan cannot be honest without: work that stopped, and work\nthe agent decided against, each in the host's own words.", "signature": "# [doc = \" Where one item of a plan stands.\"] # [doc = \"\"] # [doc = \" Ahead, doing and done are the three a plan is mostly made of. The other two\"] # [doc = \" are the ones a plan cannot be honest without: work that stopped, and work\"] # [doc = \" the agent decided against, each in the host's own words.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum PlanState { # [doc = \" Not started. The reader is not waiting on it yet.\"] # [default] Ahead, # [doc = \" In flight. At most one item should be, and the plan draws whichever\"] # [doc = \" ones are.\"] Doing, Done, # [doc = \" Started and stopped, in the host's words.\"] Blocked (SharedString), # [doc = \" Decided against before it ran, in the host's words.\"] Dropped (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::plan::PlanState::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "The name the semantic node publishes, so a test tells the five apart without reading a colour.", "documentation": "The name the semantic node publishes, so a test tells the five apart\nwithout reading a colour.", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "PlanState" }, { "id": "gpui_kit::agent::plan::PlanState::reason", "name": "reason", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::plan", "path": "gpui_kit::agent::plan", "source": "crates/gpui-kit/src/agent/plan.rs", "summary": "The host's words for why this item is not moving, if it is not.", "documentation": "The host's words for why this item is not moving, if it is not.", "signature": "pub fn reason (& self) -> Option<& SharedString>", "cfg": [], "target": "PlanState" }, { "id": "gpui_kit::agent::presentation::AgentActivityLine", "name": "AgentActivityLine", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "The localized execution sentence and its non-colour status mark.", "documentation": "The localized execution sentence and its non-colour status mark.", "signature": "# [doc = \" The localized execution sentence and its non-colour status mark.\"] # [derive (Debug, IntoElement)] pub struct AgentActivityLine { ident : Ident, execution : AgentExecutionState, tint : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentActivityLine::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, execution : AgentExecutionState) -> Self", "cfg": [], "target": "AgentActivityLine" }, { "id": "gpui_kit::agent::presentation::AgentActivityLine::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "AgentActivityLine" }, { "id": "gpui_kit::agent::presentation::AgentAppearance", "name": "AgentAppearance", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "Optional caller-owned art for an agent identity.", "documentation": "Optional caller-owned art for an agent identity.\n\nExecution and presence never come from this value. Changing a portrait or\nrole tint therefore cannot accidentally change the state the UI reports.", "signature": "# [doc = \" Optional caller-owned art for an agent identity.\"] # [doc = \"\"] # [doc = \" Execution and presence never come from this value. Changing a portrait or\"] # [doc = \" role tint therefore cannot accidentally change the state the UI reports.\"] # [derive (Debug, Clone, PartialEq)] pub struct AgentAppearance { id : AgentId, image : Option, tint : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentAppearance::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn image (mut self, image : impl Into) -> Self", "cfg": [], "target": "AgentAppearance" }, { "id": "gpui_kit::agent::presentation::AgentAppearance::image_source", "name": "image_source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "Uses caller-resolved art, preserving custom loader lifetime and policy.", "documentation": "Uses caller-resolved art, preserving custom loader lifetime and policy.", "signature": "pub fn image_source (mut self, image : gpui::ImageSource) -> Self", "cfg": [], "target": "AgentAppearance" }, { "id": "gpui_kit::agent::presentation::AgentAppearance::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into) -> Self", "cfg": [], "target": "AgentAppearance" }, { "id": "gpui_kit::agent::presentation::AgentAppearance::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "AgentAppearance" }, { "id": "gpui_kit::agent::presentation::AgentAvatar", "name": "AgentAvatar", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "A status-coloured agent identity with a separate presence mark.", "documentation": "A status-coloured agent identity with a separate presence mark.", "signature": "# [doc = \" A status-coloured agent identity with a separate presence mark.\"] # [derive (Debug, IntoElement)] pub struct AgentAvatar { ident : Ident, agent : AgentSnapshot, image : Option, tint : Option, size : f32, mark_inset : f32, parent : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentAvatar::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn image (mut self, image : impl Into) -> Self", "cfg": [], "target": "AgentAvatar" }, { "id": "gpui_kit::agent::presentation::AgentAvatar::image_source", "name": "image_source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "Uses caller-resolved art without converting a loader into a path.", "documentation": "Uses caller-resolved art without converting a loader into a path.", "signature": "pub fn image_source (mut self, image : gpui::ImageSource) -> Self", "cfg": [], "target": "AgentAvatar" }, { "id": "gpui_kit::agent::presentation::AgentAvatar::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, agent : AgentSnapshot) -> Self", "cfg": [], "target": "AgentAvatar" }, { "id": "gpui_kit::agent::presentation::AgentAvatar::parent", "name": "parent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "Establishes the semantic group this avatar belongs to.", "documentation": "Establishes the semantic group this avatar belongs to.", "signature": "pub fn parent (mut self, parent : impl Into) -> Self", "cfg": [], "target": "AgentAvatar" }, { "id": "gpui_kit::agent::presentation::AgentAvatar::size", "name": "size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn size (mut self, size : f32) -> Self", "cfg": [], "target": "AgentAvatar" }, { "id": "gpui_kit::agent::presentation::AgentAvatar::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "AgentAvatar" }, { "id": "gpui_kit::agent::presentation::AgentCard", "name": "AgentCard", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "A complete summary of one agent and its current caller-owned task.", "documentation": "A complete summary of one agent and its current caller-owned task.", "signature": "# [doc = \" A complete summary of one agent and its current caller-owned task.\"] # [derive (IntoElement)] pub struct AgentCard { ident : Ident, agent : AgentSnapshot, task_label : Option, image : Option, tint : Option, selected : bool, on_action : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentCard::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn image (mut self, image : impl Into) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentCard::image_source", "name": "image_source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "Uses caller-resolved art, including revocable custom sources.", "documentation": "Uses caller-resolved art, including revocable custom sources.", "signature": "pub fn image_source (mut self, image : gpui::ImageSource) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentCard::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, agent : AgentSnapshot) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentCard::on_action", "name": "on_action", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn on_action (mut self, handler : impl Fn (AgentUiAction, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentCard::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : bool) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentCard::task_label", "name": "task_label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn task_label (mut self, label : impl Into) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentCard::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "AgentCard" }, { "id": "gpui_kit::agent::presentation::AgentGroup", "name": "AgentGroup", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "A compact overlapping group of agent identities with an overflow count.", "documentation": "A compact overlapping group of agent identities with an overflow count.", "signature": "# [doc = \" A compact overlapping group of agent identities with an overflow count.\"] # [derive (IntoElement)] pub struct AgentGroup { ident : Ident, agents : Vec, appearances : Vec, max_visible : usize, size : f32, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentGroup::appearances", "name": "appearances", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn appearances (mut self, appearances : impl IntoIterator) -> Self", "cfg": [], "target": "AgentGroup" }, { "id": "gpui_kit::agent::presentation::AgentGroup::max_visible", "name": "max_visible", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn max_visible (mut self, max_visible : usize) -> Self", "cfg": [], "target": "AgentGroup" }, { "id": "gpui_kit::agent::presentation::AgentGroup::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, agents : impl IntoIterator) -> Self", "cfg": [], "target": "AgentGroup" }, { "id": "gpui_kit::agent::presentation::AgentGroup::size", "name": "size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn size (mut self, size : f32) -> Self", "cfg": [], "target": "AgentGroup" }, { "id": "gpui_kit::agent::presentation::AgentRoster", "name": "AgentRoster", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "A virtualized list of agents with standard identity and activity rows.", "documentation": "A virtualized list of agents with standard identity and activity rows.", "signature": "# [doc = \" A virtualized list of agents with standard identity and activity rows.\"] # [derive (IntoElement)] pub struct AgentRoster { ident : Ident, agents : Vec, tasks : Vec, appearances : Vec, selected : Option, visible_rows : Option, on_action : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentRoster::appearances", "name": "appearances", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn appearances (mut self, appearances : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRoster::from_run", "name": "from_run", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn from_run (ident : impl Into, run : & AgentRunSnapshot) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRoster::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, agents : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRoster::on_action", "name": "on_action", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn on_action (mut self, handler : impl Fn (AgentUiAction, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRoster::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : impl Into) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRoster::tasks", "name": "tasks", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn tasks (mut self, tasks : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRoster::visible_rows", "name": "visible_rows", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn visible_rows (mut self, rows : usize) -> Self", "cfg": [], "target": "AgentRoster" }, { "id": "gpui_kit::agent::presentation::AgentRunIssues", "name": "AgentRunIssues", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "A single truthful notice for malformed multi-agent snapshot structure.", "documentation": "A single truthful notice for malformed multi-agent snapshot structure.\n\nComponents use this before building identity-indexed rows or topology, so\nduplicate and dangling facts are never silently collapsed into a different\nrun. A valid snapshot renders no notice.", "signature": "# [doc = \" A single truthful notice for malformed multi-agent snapshot structure.\"] # [doc = \"\"] # [doc = \" Components use this before building identity-indexed rows or topology, so\"] # [doc = \" duplicate and dangling facts are never silently collapsed into a different\"] # [doc = \" run. A valid snapshot renders no notice.\"] # [derive (Debug, IntoElement)] pub struct AgentRunIssues { ident : Ident, issues : Vec, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::AgentRunIssues::from_run", "name": "from_run", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn from_run (ident : impl Into, run : & AgentRunSnapshot) -> Self", "cfg": [], "target": "AgentRunIssues" }, { "id": "gpui_kit::agent::presentation::AgentRunIssues::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, issues : impl IntoIterator) -> Self", "cfg": [], "target": "AgentRunIssues" }, { "id": "gpui_kit::agent::presentation::SubagentTree", "name": "SubagentTree", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "A caller-controlled hierarchy derived from `Spawn` links in a run.", "documentation": "A caller-controlled hierarchy derived from `Spawn` links in a run.", "signature": "# [doc = \" A caller-controlled hierarchy derived from `Spawn` links in a run.\"] # [derive (IntoElement)] pub struct SubagentTree { ident : Ident, run : AgentRunSnapshot, expanded : Vec, selected : Option, visible_rows : Option, on_toggle : Option, on_action : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::presentation::SubagentTree::expanded", "name": "expanded", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn expanded (mut self, expanded : impl IntoIterator) -> Self", "cfg": [], "target": "SubagentTree" }, { "id": "gpui_kit::agent::presentation::SubagentTree::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, run : AgentRunSnapshot) -> Self", "cfg": [], "target": "SubagentTree" }, { "id": "gpui_kit::agent::presentation::SubagentTree::on_action", "name": "on_action", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn on_action (mut self, handler : impl Fn (AgentUiAction, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "SubagentTree" }, { "id": "gpui_kit::agent::presentation::SubagentTree::on_toggle", "name": "on_toggle", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "Reports the next caller-owned disclosure state without applying it.", "documentation": "Reports the next caller-owned disclosure state without applying it.", "signature": "pub fn on_toggle (mut self, handler : impl Fn (AgentId, bool, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "SubagentTree" }, { "id": "gpui_kit::agent::presentation::SubagentTree::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : impl Into) -> Self", "cfg": [], "target": "SubagentTree" }, { "id": "gpui_kit::agent::presentation::SubagentTree::visible_rows", "name": "visible_rows", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::presentation", "path": "gpui_kit::agent::presentation", "source": "crates/gpui-kit/src/agent/presentation.rs", "summary": "", "documentation": "", "signature": "pub fn visible_rows (mut self, rows : usize) -> Self", "cfg": [], "target": "SubagentTree" }, { "id": "gpui_kit::agent::prompt::PromptBuilder", "name": "PromptBuilder", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "A template with host-owned slots.", "documentation": "A template with host-owned slots.", "signature": "# [doc = \" A template with host-owned slots.\"] # [derive (IntoElement)] pub struct PromptBuilder { ident : Ident, label : SharedString, body : SharedString, slots : Vec, replacements : Slots, state : PromptBuilderState, disabled : bool, on_slot : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::prompt::PromptBuilder::body", "name": "body", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn body (mut self, body : impl Into) -> Self", "cfg": [], "target": "PromptBuilder" }, { "id": "gpui_kit::agent::prompt::PromptBuilder::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, label : impl Into) -> Self", "cfg": [], "target": "PromptBuilder" }, { "id": "gpui_kit::agent::prompt::PromptBuilder::on_slot", "name": "on_slot", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn on_slot (mut self, handler : impl Fn (& PromptSlot, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "PromptBuilder" }, { "id": "gpui_kit::agent::prompt::PromptBuilder::slots", "name": "slots", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn slots (mut self, slots : impl IntoIterator) -> Self", "cfg": [], "target": "PromptBuilder" }, { "id": "gpui_kit::agent::prompt::PromptBuilder::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : PromptBuilderState) -> Self", "cfg": [], "target": "PromptBuilder" }, { "id": "gpui_kit::agent::prompt::PromptBuilderEvent", "name": "PromptBuilderEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "What a slot activation reports.", "documentation": "What a slot activation reports.", "signature": "# [doc = \" What a slot activation reports.\"] # [derive (Debug, Clone, PartialEq)] pub enum PromptBuilderEvent { SlotActivated (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::prompt::PromptBuilderState", "name": "PromptBuilderState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "How the template was asked for.", "documentation": "How the template was asked for.", "signature": "# [doc = \" How the template was asked for.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum PromptBuilderState { Loading, Ready, Empty, Unavailable (SharedString), Error (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::prompt::PromptBuilderState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "PromptBuilderState" }, { "id": "gpui_kit::agent::prompt::PromptSlot", "name": "PromptSlot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "One named hole in a template. Identity is the host's, never the draw order.", "documentation": "One named hole in a template. Identity is the host's, never the draw order.", "signature": "# [doc = \" One named hole in a template. Identity is the host's, never the draw order.\"] # [derive (Debug, Clone, PartialEq)] pub struct PromptSlot { pub id : SharedString, pub name : SharedString, pub value : SharedString, }", "cfg": [] }, { "id": "gpui_kit::agent::prompt::PromptSlot::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "PromptSlot" }, { "id": "gpui_kit::agent::prompt::PromptSlot::value", "name": "value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::prompt", "path": "gpui_kit::agent::prompt", "source": "crates/gpui-kit/src/agent/prompt.rs", "summary": "", "documentation": "", "signature": "pub fn value (mut self, value : impl Into) -> Self", "cfg": [], "target": "PromptSlot" }, { "id": "gpui_kit::agent::reexport-1", "name": "approval :: { AlwaysScope , ApprovalDecision , ApprovalEvent , ApprovalPrompt , ApprovalStatus }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use approval::{ AlwaysScope, ApprovalDecision, ApprovalEvent, ApprovalPrompt, ApprovalStatus };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-10", "name": "permission :: { PermissionAction , PermissionChange , PermissionEntry , PermissionMatrix , PermissionSource , PermissionState , PermissionSubject , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use permission::{ PermissionAction, PermissionChange, PermissionEntry, PermissionMatrix, PermissionSource, PermissionState, PermissionSubject, };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-11", "name": "persona :: { DialogueChoice , DialogueChoiceAvailability , DialogueTurn , PersonaDialogue , PersonaDialogueEvent , PersonaExpression , PersonaPortrait , VoiceField , VoiceReactive , VoiceSample , VoiceSampleError , VoiceSampleErrorKind , VoiceState , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use persona::{ DialogueChoice, DialogueChoiceAvailability, DialogueTurn, PersonaDialogue, PersonaDialogueEvent, PersonaExpression, PersonaPortrait, VoiceField, VoiceReactive, VoiceSample, VoiceSampleError, VoiceSampleErrorKind, VoiceState, };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-12", "name": "plan :: { AgentPlan , PlanItem , PlanState }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use plan::{ AgentPlan, PlanItem, PlanState };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-13", "name": "presentation :: { AgentActivityLine , AgentAppearance , AgentAvatar , AgentCard , AgentGroup , AgentRoster , AgentRunIssues , SubagentTree , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use presentation::{ AgentActivityLine, AgentAppearance, AgentAvatar, AgentCard, AgentGroup, AgentRoster, AgentRunIssues, SubagentTree, };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-14", "name": "prompt :: { PromptBuilder , PromptBuilderEvent , PromptBuilderState , PromptSlot }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use prompt::{ PromptBuilder, PromptBuilderEvent, PromptBuilderState, PromptSlot };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-15", "name": "server_list :: { Catalog , Offering , OfferingKind , ServerEntry , ServerList , ServerState }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use server_list::{ Catalog, Offering, OfferingKind, ServerEntry, ServerList, ServerState };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-16", "name": "thinking :: { Reasoning , ThinkingBlock }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use thinking::{ Reasoning, ThinkingBlock };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-17", "name": "tool_call :: { Elapsed , ToolBody , ToolCall , ToolCallState , ToolFamily , ToolOutput }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use tool_call::{ Elapsed, ToolBody, ToolCall, ToolCallState, ToolFamily, ToolOutput };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-2", "name": "artifact :: { ArtifactKind , ArtifactPreview , ArtifactPreviewState }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use artifact::{ ArtifactKind, ArtifactPreview, ArtifactPreviewState };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-3", "name": "canvas :: { AgentRunCanvas , AgentRunCanvasEvent , AgentRunLayout }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use canvas::{ AgentRunCanvas, AgentRunCanvasEvent, AgentRunLayout };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-4", "name": "clarification :: { ClarificationEvent , ClarificationOption , ClarificationPanel , ClarificationStatus , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use clarification::{ ClarificationEvent, ClarificationOption, ClarificationPanel, ClarificationStatus, };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-5", "name": "cost :: { Basis , ContextGauge , CostLine , CostMeter , LastVerified , Limit , Quantity , Reading }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use cost::{ Basis, ContextGauge, CostLine, CostMeter, LastVerified, Limit, Quantity, Reading };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-6", "name": "disclosure :: AgentDisclosurePresentation", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use disclosure::AgentDisclosurePresentation;", "cfg": [] }, { "id": "gpui_kit::agent::reexport-7", "name": "feedback :: { FeedbackRating , FeedbackRatingEvent , FeedbackVote }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use feedback::{ FeedbackRating, FeedbackRatingEvent, FeedbackVote };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-8", "name": "model :: { AgentActivity , AgentDescriptor , AgentExecutionState , AgentId , AgentModelIssue , AgentOutcome , AgentPresence , AgentRunSnapshot , AgentSnapshot , AgentTaskSnapshot , AgentUiAction , AgentVisualEvent , AgentVisualEventKind , AggregationSnapshot , InvocationId , RunId , RunLink , RunLinkId , RunLinkKind , RunSubjectId , TaskId , VisualEventId , WaitReason , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use model::{ AgentActivity, AgentDescriptor, AgentExecutionState, AgentId, AgentModelIssue, AgentOutcome, AgentPresence, AgentRunSnapshot, AgentSnapshot, AgentTaskSnapshot, AgentUiAction, AgentVisualEvent, AgentVisualEventKind, AggregationSnapshot, InvocationId, RunId, RunLink, RunLinkId, RunLinkKind, RunSubjectId, TaskId, VisualEventId, WaitReason, };", "cfg": [] }, { "id": "gpui_kit::agent::reexport-9", "name": "offering_catalog :: { OfferingCatalog , OfferingIdentity , OfferingSource , OfferingSourceState , SearchableOffering , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent", "path": "gpui_kit::agent", "source": "crates/gpui-kit/src/agent/mod.rs", "summary": "", "documentation": "", "signature": "pub use offering_catalog::{ OfferingCatalog, OfferingIdentity, OfferingSource, OfferingSourceState, SearchableOffering, };", "cfg": [] }, { "id": "gpui_kit::agent::server_list::Catalog", "name": "Catalog", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "What is known about what a server offers.", "documentation": "What is known about what a server offers.\n\n[`Catalog::Offers`] holding an empty list is an answer; [`Catalog::Unasked`]\nis the absence of a question. The two are separate variants rather than one\nemptiness because a surface that cannot tell them apart will show the wrong\none to somebody who is trying to work out whether their server is broken.", "signature": "# [doc = \" What is known about what a server offers.\"] # [doc = \"\"] # [doc = \" [`Catalog::Offers`] holding an empty list is an answer; [`Catalog::Unasked`]\"] # [doc = \" is the absence of a question. The two are separate variants rather than one\"] # [doc = \" emptiness because a surface that cannot tell them apart will show the wrong\"] # [doc = \" one to somebody who is trying to work out whether their server is broken.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum Catalog { # [doc = \" Nobody has asked this server what it offers.\"] # [default] Unasked, # [doc = \" The question is in flight.\"] Asking, # [doc = \" The server answered. An empty list is an answer.\"] Offers (Vec), # [doc = \" The question could not be answered, for the host's stated reason.\"] Unavailable (SharedString), }", "cfg": [] }, { "id": "gpui_kit::agent::server_list::Offering", "name": "Offering", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "One thing a server offers.", "documentation": "One thing a server offers.", "signature": "# [doc = \" One thing a server offers.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct Offering { id : SharedString, kind : OfferingKind, name : SharedString, summary : Option, # [doc = \" The one extra fact that tells two similarly named things apart — a\"] # [doc = \" resource's locator, a tool's signature — written by the host.\"] qualifier : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::server_list::Offering::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::kind", "name": "kind", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn kind (& self) -> OfferingKind", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & SharedString", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, kind : OfferingKind, name : impl Into,) -> Self", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::qualifier", "name": "qualifier", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn qualifier (mut self, qualifier : impl Into) -> Self", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::qualifier_text", "name": "qualifier_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn qualifier_text (& self) -> Option<& SharedString>", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::resource", "name": "resource", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn resource (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::skill", "name": "skill", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn skill (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::summary", "name": "summary", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn summary (mut self, summary : impl Into) -> Self", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::summary_text", "name": "summary_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn summary_text (& self) -> Option<& SharedString>", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::Offering::tool", "name": "tool", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn tool (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "Offering" }, { "id": "gpui_kit::agent::server_list::OfferingKind", "name": "OfferingKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "Which of the three kinds of thing a server offers.", "documentation": "Which of the three kinds of thing a server offers.", "signature": "# [doc = \" Which of the three kinds of thing a server offers.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)] pub enum OfferingKind { # [doc = \" Something the application can call.\"] Tool, # [doc = \" A procedure the application can follow.\"] Skill, # [doc = \" Something the application can read.\"] Resource, }", "cfg": [] }, { "id": "gpui_kit::agent::server_list::OfferingKind::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "The published name.", "documentation": "The published name.", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "OfferingKind" }, { "id": "gpui_kit::agent::server_list::ServerEntry", "name": "ServerEntry", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "One connection.", "documentation": "One connection.", "signature": "# [doc = \" One connection.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct ServerEntry { id : SharedString, name : SharedString, detail : Option, state : ServerState, catalog : Catalog, }", "cfg": [] }, { "id": "gpui_kit::agent::server_list::ServerEntry::catalog", "name": "catalog", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn catalog (mut self, catalog : Catalog) -> Self", "cfg": [], "target": "ServerEntry" }, { "id": "gpui_kit::agent::server_list::ServerEntry::detail", "name": "detail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "A second line naming the connection: where it runs, which account it uses. The host writes it; this crate never derives one.", "documentation": "A second line naming the connection: where it runs, which account it\nuses. The host writes it; this crate never derives one.", "signature": "pub fn detail (mut self, detail : impl Into) -> Self", "cfg": [], "target": "ServerEntry" }, { "id": "gpui_kit::agent::server_list::ServerEntry::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "ServerEntry" }, { "id": "gpui_kit::agent::server_list::ServerEntry::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "ServerEntry" }, { "id": "gpui_kit::agent::server_list::ServerEntry::offers", "name": "offers", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn offers (self, offerings : impl IntoIterator) -> Self", "cfg": [], "target": "ServerEntry" }, { "id": "gpui_kit::agent::server_list::ServerEntry::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : ServerState) -> Self", "cfg": [], "target": "ServerEntry" }, { "id": "gpui_kit::agent::server_list::ServerList", "name": "ServerList", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "The connections an application holds, and what each one offers.", "documentation": "The connections an application holds, and what each one offers.", "signature": "# [doc = \" The connections an application holds, and what each one offers.\"] # [derive (IntoElement)] pub struct ServerList { ident : Ident, servers : Vec, expanded : Vec, selected : Option, size : ControlSize, disabled : bool, on_select : Option, on_retry : Option, on_toggle : Option, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::agent::server_list::ServerList::expanded", "name": "expanded", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "The servers whose offerings are shown. Everything else is folded away, and a folded server publishes none of what it offers.", "documentation": "The servers whose offerings are shown. Everything else is folded away,\nand a folded server publishes none of what it offers.", "signature": "pub fn expanded (mut self, ids : impl IntoIterator) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::expanded_ids", "name": "expanded_ids", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn expanded_ids> (mut self, ids : & [S]) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::on_retry", "name": "on_retry", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "Reports that a failed connection should be attempted again. This crate connects to nothing.", "documentation": "Reports that a failed connection should be attempted again. This crate\nconnects to nothing.", "signature": "pub fn on_retry (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::on_select", "name": "on_select", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn on_select (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::on_toggle", "name": "on_toggle", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "Reports that a server's offerings should be shown or folded away.", "documentation": "Reports that a server's offerings should be shown or folded away.", "signature": "pub fn on_toggle (mut self, handler : impl Fn (SharedString, bool, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, id : impl Into) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::server", "name": "server", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn server (mut self, server : ServerEntry) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerList::servers", "name": "servers", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "", "documentation": "", "signature": "pub fn servers (mut self, servers : impl IntoIterator) -> Self", "cfg": [], "target": "ServerList" }, { "id": "gpui_kit::agent::server_list::ServerState", "name": "ServerState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "Where a connection stands.", "documentation": "Where a connection stands.", "signature": "# [doc = \" Where a connection stands.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ServerState { Connected, Connecting, # [doc = \" Not connected, and nothing went wrong.\"] Disconnected, # [doc = \" The attempt failed. The reason is the host's and is shown word for\"] # [doc = \" word; this crate never authors one.\"] Failed { reason : SharedString, }, # [doc = \" The reader turned this one off. A refusal, not a failure, which is why\"] # [doc = \" it is a state of its own rather than a disconnection with a note.\"] Disabled { reason : Option, }, }", "cfg": [] }, { "id": "gpui_kit::agent::server_list::ServerState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::server_list", "path": "gpui_kit::agent::server_list", "source": "crates/gpui-kit/src/agent/server_list.rs", "summary": "The name the node publishes. It is the state, never its colour.", "documentation": "The name the node publishes. It is the state, never its colour.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "ServerState" }, { "id": "gpui_kit::agent::thinking::Reasoning", "name": "Reasoning", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "What is known about a turn's reasoning.", "documentation": "What is known about a turn's reasoning.\n\nDeliberately not `Option`, and deliberately without a\n`From>`: the two ways of having no text to show are different\nfacts, and the type is the thing that stops them being confused.", "signature": "# [doc = \" What is known about a turn's reasoning.\"] # [doc = \"\"] # [doc = \" Deliberately not `Option`, and deliberately without a\"] # [doc = \" `From>`: the two ways of having no text to show are different\"] # [doc = \" facts, and the type is the thing that stops them being confused.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum Reasoning { # [doc = \" It exists and this is it. An empty string is still reasoning that\"] # [doc = \" exists; it is not [`Reasoning::Absent`].\"] Present (SharedString), # [doc = \" It exists and was withheld, in the withholder's own words.\"] Withheld (SharedString), # [doc = \" None was produced.\"] Absent, }", "cfg": [] }, { "id": "gpui_kit::agent::thinking::Reasoning::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "The name the semantic node publishes.", "documentation": "The name the semantic node publishes.", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "Reasoning" }, { "id": "gpui_kit::agent::thinking::Reasoning::is_disclosable", "name": "is_disclosable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "Whether there is anything a disclosure could disclose.", "documentation": "Whether there is anything a disclosure could disclose.", "signature": "pub fn is_disclosable (& self) -> bool", "cfg": [], "target": "Reasoning" }, { "id": "gpui_kit::agent::thinking::Reasoning::present", "name": "present", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "", "documentation": "", "signature": "pub fn present (text : impl Into) -> Self", "cfg": [], "target": "Reasoning" }, { "id": "gpui_kit::agent::thinking::Reasoning::withheld", "name": "withheld", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "", "documentation": "", "signature": "pub fn withheld (reason : impl Into) -> Self", "cfg": [], "target": "Reasoning" }, { "id": "gpui_kit::agent::thinking::ThinkingBlock", "name": "ThinkingBlock", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "A collapsed block of model reasoning.", "documentation": "A collapsed block of model reasoning.\n\nWhether it is open is the caller's, as it is for\n[`Accordion`](crate::navigation::accordion::Accordion): the block reports\nthe state it should take and shows exactly the state it was given.", "signature": "# [doc = \" A collapsed block of model reasoning.\"] # [doc = \"\"] # [doc = \" Whether it is open is the caller's, as it is for\"] # [doc = \" [`Accordion`](crate::navigation::accordion::Accordion): the block reports\"] # [doc = \" the state it should take and shows exactly the state it was given.\"] # [derive (IntoElement)] pub struct ThinkingBlock { ident : Ident, reasoning : Reasoning, expanded : bool, # [doc = \" Whether the reasoning is still arriving. Separate from the reasoning\"] # [doc = \" itself, because text that has stopped growing and text that is still\"] # [doc = \" growing look identical and mean different things.\"] thinking : bool, # [doc = \" How long the host says this turn has been thinking, already formatted.\"] elapsed : Option, presentation : AgentDisclosurePresentation, on_toggle : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::thinking::ThinkingBlock::elapsed", "name": "elapsed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "A host-formatted duration shown as “Thought for …” when known.", "documentation": "A host-formatted duration shown as “Thought for …” when known.", "signature": "pub fn elapsed (mut self, elapsed : impl Into) -> Self", "cfg": [], "target": "ThinkingBlock" }, { "id": "gpui_kit::agent::thinking::ThinkingBlock::expanded", "name": "expanded", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "Collapsed unless the caller says otherwise, and reasoning that cannot be disclosed stays shut whatever the caller says.", "documentation": "Collapsed unless the caller says otherwise, and reasoning that cannot\nbe disclosed stays shut whatever the caller says.", "signature": "pub fn expanded (mut self, expanded : bool) -> Self", "cfg": [], "target": "ThinkingBlock" }, { "id": "gpui_kit::agent::thinking::ThinkingBlock::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "The reasoning is a constructor argument because there is no sensible default: which of the three states holds is the whole question.", "documentation": "The reasoning is a constructor argument because there is no sensible\ndefault: which of the three states holds is the whole question.", "signature": "pub fn new (ident : impl Into, reasoning : Reasoning) -> Self", "cfg": [], "target": "ThinkingBlock" }, { "id": "gpui_kit::agent::thinking::ThinkingBlock::on_toggle", "name": "on_toggle", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "Reports the state the block should take next.", "documentation": "Reports the state the block should take next.", "signature": "pub fn on_toggle (mut self, handler : impl Fn (bool, & mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "ThinkingBlock" }, { "id": "gpui_kit::agent::thinking::ThinkingBlock::presentation", "name": "presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "Chooses the body treatment when reasoning is disclosed.", "documentation": "Chooses the body treatment when reasoning is disclosed.\n\nThe default is [`AgentDisclosurePresentation::Inset`]. Flow preserves\nthe body's indentation and content without drawing a separate surface.", "signature": "pub fn presentation (mut self, presentation : AgentDisclosurePresentation) -> Self", "cfg": [], "target": "ThinkingBlock" }, { "id": "gpui_kit::agent::thinking::ThinkingBlock::thinking", "name": "thinking", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::thinking", "path": "gpui_kit::agent::thinking", "source": "crates/gpui-kit/src/agent/thinking.rs", "summary": "Reports that the reasoning is still being produced.", "documentation": "Reports that the reasoning is still being produced.\n\nIts active mark differs from the settled mark even when motion is\nreduced, so a working thought does not need a state word beside it.", "signature": "pub fn thinking (mut self, thinking : bool) -> Self", "cfg": [], "target": "ThinkingBlock" }, { "id": "gpui_kit::agent::tool_call::Elapsed", "name": "Elapsed", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "How long a call took, as far as anyone has said.", "documentation": "How long a call took, as far as anyone has said.\n\nA duration nobody stated is a state, not a zero — the rule\n[`TransportDuration`](crate::content::transport::TransportDuration) keeps\nfor the same reason.", "signature": "# [doc = \" How long a call took, as far as anyone has said.\"] # [doc = \"\"] # [doc = \" A duration nobody stated is a state, not a zero — the rule\"] # [doc = \" [`TransportDuration`](crate::content::transport::TransportDuration) keeps\"] # [doc = \" for the same reason.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum Elapsed { # [doc = \" A duration the caller has already put into words.\"] Took (SharedString), # [default] Unknown, }", "cfg": [] }, { "id": "gpui_kit::agent::tool_call::Elapsed::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "Elapsed" }, { "id": "gpui_kit::agent::tool_call::ToolBody", "name": "ToolBody", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "A block of caller-owned text — the arguments a tool was called with, or what it returned — with an optional limit on how much of it is drawn.", "documentation": "A block of caller-owned text — the arguments a tool was called with, or\nwhat it returned — with an optional limit on how much of it is drawn.\n\nThe body keeps the whole text so the component can say how much it left\nout, and draws only what the limit allows. Nothing but the measurement\nreaches the semantic tree.", "signature": "# [doc = \" A block of caller-owned text — the arguments a tool was called with, or\"] # [doc = \" what it returned — with an optional limit on how much of it is drawn.\"] # [doc = \"\"] # [doc = \" The body keeps the whole text so the component can say how much it left\"] # [doc = \" out, and draws only what the limit allows. Nothing but the measurement\"] # [doc = \" reaches the semantic tree.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct ToolBody { text : SharedString, max_lines : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::tool_call::ToolBody::all_lines", "name": "all_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "Draws the whole body. The transcript default is four lines; callers opt into an unbounded body only where the surrounding surface already owns scrolling or another bound.", "documentation": "Draws the whole body. The transcript default is four lines; callers\nopt into an unbounded body only where the surrounding surface already\nowns scrolling or another bound.", "signature": "pub fn all_lines (mut self) -> Self", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::is_truncated", "name": "is_truncated", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn is_truncated (& self) -> bool", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::line_count", "name": "line_count", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn line_count (& self) -> usize", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::max_lines", "name": "max_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "Draws at most this many lines and states how many there are in total.", "documentation": "Draws at most this many lines and states how many there are in total.\n\nA limit of zero is one line: a body that drew nothing at all and called\nitself truncated would be indistinguishable from a body nobody passed.", "signature": "pub fn max_lines (mut self, lines : usize) -> Self", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn new (text : impl Into) -> Self", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::remaining_line_count", "name": "remaining_line_count", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn remaining_line_count (& self) -> usize", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::shape", "name": "shape", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "The measurement a reader is shown and a node publishes: never the text.", "documentation": "The measurement a reader is shown and a node publishes: never the text.", "signature": "pub fn shape (& self, cx : & App) -> SharedString", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::shown_line_count", "name": "shown_line_count", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn shown_line_count (& self) -> usize", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolBody::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "The text as the caller gave it. It is the caller's own data coming back, and the component never publishes it.", "documentation": "The text as the caller gave it. It is the caller's own data coming\nback, and the component never publishes it.", "signature": "pub fn text (& self) -> & SharedString", "cfg": [], "target": "ToolBody" }, { "id": "gpui_kit::agent::tool_call::ToolCall", "name": "ToolCall", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "One quiet evidence row for a tool invocation.", "documentation": "One quiet evidence row for a tool invocation.\n\nThe row is collapsed by default. Arguments, output and an optional diff\nappear only when the caller advances `expanded`; the component reports the\nrequested next state through `on_toggle` and runs no tool itself.", "signature": "# [doc = \" One quiet evidence row for a tool invocation.\"] # [doc = \"\"] # [doc = \" The row is collapsed by default. Arguments, output and an optional diff\"] # [doc = \" appear only when the caller advances `expanded`; the component reports the\"] # [doc = \" requested next state through `on_toggle` and runs no tool itself.\"] # [derive (IntoElement)] pub struct ToolCall { ident : Ident, family : ToolFamily, tool : SharedString, summary : Option, arguments : Option, state : ToolCallState, elapsed : Elapsed, diff : Option, expanded : bool, presentation : AgentDisclosurePresentation, on_toggle : Option, on_retry : Option, }", "cfg": [] }, { "id": "gpui_kit::agent::tool_call::ToolCall::arguments", "name": "arguments", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "What the tool was called with. Hidden while the row is collapsed.", "documentation": "What the tool was called with. Hidden while the row is collapsed.", "signature": "pub fn arguments (mut self, arguments : impl Into) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::diff", "name": "diff", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "A caller-built intra-change view, typically a small [`DiffView`](crate::content::DiffView).", "documentation": "A caller-built intra-change view, typically a small [`DiffView`](crate::content::DiffView).", "signature": "pub fn diff (mut self, diff : impl IntoElement) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::elapsed", "name": "elapsed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn elapsed (mut self, elapsed : impl Into) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::expanded", "name": "expanded", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn expanded (mut self, expanded : bool) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "`tool` is the short verb or tool name the host wants the transcript to show. Kit owns no tool catalogue and invents no display name.", "documentation": "`tool` is the short verb or tool name the host wants the transcript to\nshow. Kit owns no tool catalogue and invents no display name.", "signature": "pub fn new (ident : impl Into, family : ToolFamily, tool : impl Into) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::on_retry", "name": "on_retry", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "Offers a quiet inline retry action on a failed row only.", "documentation": "Offers a quiet inline retry action on a failed row only.", "signature": "pub fn on_retry (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::on_toggle", "name": "on_toggle", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn on_toggle (mut self, handler : impl Fn (bool, & mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::presentation", "name": "presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "Chooses the body treatment for disclosed arguments and results.", "documentation": "Chooses the body treatment for disclosed arguments and results.\n\nThe default is [`AgentDisclosurePresentation::Inset`]. Flow keeps the\nsame disclosure content and indentation without placing it on a\nseparate evidence surface.", "signature": "pub fn presentation (mut self, presentation : AgentDisclosurePresentation) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : ToolCallState) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCall::summary", "name": "summary", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "A concise, display-safe key argument such as a path, command or query.", "documentation": "A concise, display-safe key argument such as a path, command or query.\n\nUnlike [`ToolBody`], this line is published to the semantic tree so a\nscreen reader can hear the same summary. Do not pass credentials or\nunredacted user content; keep those in the redacted body.", "signature": "pub fn summary (mut self, summary : impl Into) -> Self", "cfg": [], "target": "ToolCall" }, { "id": "gpui_kit::agent::tool_call::ToolCallState", "name": "ToolCallState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "Where one invocation has got to.", "documentation": "Where one invocation has got to.\n\nThe five are a closed set rather than flags, so a card cannot be running\nand failed at once, and cannot be refused without a reason: the host that\ndeclined has to say what it declined.", "signature": "# [doc = \" Where one invocation has got to.\"] # [doc = \"\"] # [doc = \" The five are a closed set rather than flags, so a card cannot be running\"] # [doc = \" and failed at once, and cannot be refused without a reason: the host that\"] # [doc = \" declined has to say what it declined.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ToolCallState { # [doc = \" Nothing has run. Somebody has to allow it first.\"] PendingApproval, Running, Succeeded { output : ToolOutput, }, # [doc = \" The tool ran and did not succeed, in the host's own words.\"] Failed { error : SharedString, }, # [doc = \" The host declined to run it, in the host's own words. Nothing ran, so\"] # [doc = \" there is no result and no error — only a decision.\"] Refused { reason : SharedString, }, }", "cfg": [] }, { "id": "gpui_kit::agent::tool_call::ToolCallState::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "The name the semantic node publishes, so a test asserts the state the row reported rather than the colour it painted.", "documentation": "The name the semantic node publishes, so a test asserts the state the\nrow reported rather than the colour it painted.", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "ToolCallState" }, { "id": "gpui_kit::agent::tool_call::ToolCallState::failed", "name": "failed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn failed (error : impl Into) -> Self", "cfg": [], "target": "ToolCallState" }, { "id": "gpui_kit::agent::tool_call::ToolCallState::reason", "name": "reason", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "Why this call did not produce a result, when that is a thing the host said. A failure's error and a refusal's reason are different sentences and are never rendered in the same place.", "documentation": "Why this call did not produce a result, when that is a thing the host\nsaid. A failure's error and a refusal's reason are different sentences\nand are never rendered in the same place.", "signature": "pub fn reason (& self) -> Option<& SharedString>", "cfg": [], "target": "ToolCallState" }, { "id": "gpui_kit::agent::tool_call::ToolCallState::refused", "name": "refused", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn refused (reason : impl Into) -> Self", "cfg": [], "target": "ToolCallState" }, { "id": "gpui_kit::agent::tool_call::ToolCallState::succeeded", "name": "succeeded", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn succeeded (output : impl Into) -> Self", "cfg": [], "target": "ToolCallState" }, { "id": "gpui_kit::agent::tool_call::ToolCallState::succeeded_silently", "name": "succeeded_silently", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "A call that ran, succeeded, and returned nothing.", "documentation": "A call that ran, succeeded, and returned nothing.", "signature": "pub fn succeeded_silently () -> Self", "cfg": [], "target": "ToolCallState" }, { "id": "gpui_kit::agent::tool_call::ToolFamily", "name": "ToolFamily", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "The family of work one tool performs.", "documentation": "The family of work one tool performs.\n\nFamily is required at construction so every transcript gets the same\nlow-saturation edge cue instead of each host inventing a colour map. It is\nclassification only: failure and refusal still use their severity colour.", "signature": "# [doc = \" The family of work one tool performs.\"] # [doc = \"\"] # [doc = \" Family is required at construction so every transcript gets the same\"] # [doc = \" low-saturation edge cue instead of each host inventing a colour map. It is\"] # [doc = \" classification only: failure and refusal still use their severity colour.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum ToolFamily { Read, Network, Shell, Edit, External, }", "cfg": [] }, { "id": "gpui_kit::agent::tool_call::ToolFamily::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (self) -> & 'static str", "cfg": [], "target": "ToolFamily" }, { "id": "gpui_kit::agent::tool_call::ToolOutput", "name": "ToolOutput", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "agent::tool_call", "path": "gpui_kit::agent::tool_call", "source": "crates/gpui-kit/src/agent/tool_call.rs", "summary": "What a tool that ran to completion gave back.", "documentation": "What a tool that ran to completion gave back.", "signature": "# [doc = \" What a tool that ran to completion gave back.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ToolOutput { Body (ToolBody), # [doc = \" The tool ran and returned nothing. This is a fact about a completed\"] # [doc = \" call, which is why it can only be reached through\"] # [doc = \" [`ToolCallState::Succeeded`] and never stands in for a refusal.\"] Silent, }", "cfg": [] }, { "id": "gpui_kit::canvas::band::GraphBand", "name": "GraphBand", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "A labelled rectangle of canvas world space.", "documentation": "A labelled rectangle of canvas world space.\n\nThe rectangle is the caller's claim about the run, in the same coordinates\n[`NodeGraph::node`](super::NodeGraph::node) places cards in. Nothing here\nderives it from the cards inside: which nodes belong to a region is a\nproduct question, and a band computed from a bounding box would answer it\nby proximity — which is exactly the claim a reader is looking at the band\nto check.", "signature": "# [doc = \" A labelled rectangle of canvas world space.\"] # [doc = \"\"] # [doc = \" The rectangle is the caller's claim about the run, in the same coordinates\"] # [doc = \" [`NodeGraph::node`](super::NodeGraph::node) places cards in. Nothing here\"] # [doc = \" derives it from the cards inside: which nodes belong to a region is a\"] # [doc = \" product question, and a band computed from a bounding box would answer it\"] # [doc = \" by proximity — which is exactly the claim a reader is looking at the band\"] # [doc = \" to check.\"] # [derive (Debug, Clone, PartialEq)] pub struct GraphBand { pub (crate) ident : Ident, pub (crate) label : SharedString, pub (crate) bounds : Bounds, pub (crate) color : Option, pub (crate) selected : bool, }", "cfg": [] }, { "id": "gpui_kit::canvas::band::GraphBand::bounds", "name": "bounds", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "The band's rectangle in canvas world coordinates.", "documentation": "The band's rectangle in canvas world coordinates.", "signature": "pub fn bounds (& self) -> Bounds", "cfg": [], "target": "GraphBand" }, { "id": "gpui_kit::canvas::band::GraphBand::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "A caller-owned category colour.", "documentation": "A caller-owned category colour.\n\nResolved through the same tier a graph node's category takes, so a\nregion and the cards that belong to it can be given one colour and\nkeep it. Without one the band is neutral, which is the honest default:\na region is not a category until somebody says which one.", "signature": "pub fn color (mut self, color : impl Into) -> Self", "cfg": [], "target": "GraphBand" }, { "id": "gpui_kit::canvas::band::GraphBand::ident", "name": "ident", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "", "documentation": "", "signature": "pub fn ident (& self) -> & Ident", "cfg": [], "target": "GraphBand" }, { "id": "gpui_kit::canvas::band::GraphBand::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "", "documentation": "", "signature": "pub fn label (& self) -> & SharedString", "cfg": [], "target": "GraphBand" }, { "id": "gpui_kit::canvas::band::GraphBand::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "Creates a band from a business identity, a name, and a world-space rectangle.", "documentation": "Creates a band from a business identity, a name, and a world-space\nrectangle.", "signature": "pub fn new (ident : impl Into, label : impl Into, x : f32, y : f32, width : f32, height : f32,) -> Self", "cfg": [], "target": "GraphBand" }, { "id": "gpui_kit::canvas::band::GraphBand::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::band", "path": "gpui_kit::canvas::band", "source": "crates/gpui-kit/src/canvas/band.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : bool) -> Self", "cfg": [], "target": "GraphBand" }, { "id": "gpui_kit::canvas::edge::EdgeKind", "name": "EdgeKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The routing treatment of an edge.", "documentation": "The routing treatment of an edge.", "signature": "# [doc = \" The routing treatment of an edge.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum EdgeKind { # [default] Flow, Feedback, }", "cfg": [] }, { "id": "gpui_kit::canvas::edge::EdgeKind::active_color", "name": "active_color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The paint this kind takes when it carries traffic or sits under the pointer.", "documentation": "The paint this kind takes when it carries traffic or sits under the\npointer.", "signature": "pub fn active_color (self, theme : & Theme) -> Hsla", "cfg": [], "target": "EdgeKind" }, { "id": "gpui_kit::canvas::edge::EdgeKind::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn color (self, theme : & Theme) -> Hsla", "cfg": [], "target": "EdgeKind" }, { "id": "gpui_kit::canvas::edge::EdgeMarker", "name": "EdgeMarker", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The terminal mark a connection places at its destination.", "documentation": "The terminal mark a connection places at its destination.\n\nThe mark carries direction only when the host asks for it. Dense lane\ndiagrams generally need the whole corridor more than another glyph, while\na sparse curved graph can use a cap or arrow to make its reading direction\nimmediate.", "signature": "# [doc = \" The terminal mark a connection places at its destination.\"] # [doc = \"\"] # [doc = \" The mark carries direction only when the host asks for it. Dense lane\"] # [doc = \" diagrams generally need the whole corridor more than another glyph, while\"] # [doc = \" a sparse curved graph can use a cap or arrow to make its reading direction\"] # [doc = \" immediate.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum EdgeMarker { # [doc = \" The route ends cleanly at the destination port.\"] # [default] None, # [doc = \" A filled terminal bead, useful when destination is the emphasis but an\"] # [doc = \" arrow would overstate movement.\"] Dot, # [doc = \" A filled arrow following the route's exact terminal tangent.\"] Arrow, }", "cfg": [] }, { "id": "gpui_kit::canvas::edge::EdgeState", "name": "EdgeState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The caller-owned state of one connection.", "documentation": "The caller-owned state of one connection.\n\nOnly [`EdgeState::Active`] carries continuous traffic. A succeeded or\nfailed route keeps the outcome colour but stops moving, because motion on\neither would claim work is still crossing it. [`GraphEdge::active`] remains\nthe compatibility builder for callers that only distinguish idle from\nactive; [`GraphEdge::state`] is the complete vocabulary.", "signature": "# [doc = \" The caller-owned state of one connection.\"] # [doc = \"\"] # [doc = \" Only [`EdgeState::Active`] carries continuous traffic. A succeeded or\"] # [doc = \" failed route keeps the outcome colour but stops moving, because motion on\"] # [doc = \" either would claim work is still crossing it. [`GraphEdge::active`] remains\"] # [doc = \" the compatibility builder for callers that only distinguish idle from\"] # [doc = \" active; [`GraphEdge::state`] is the complete vocabulary.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum EdgeState { # [default] Idle, Active, Succeeded, Failed, }", "cfg": [] }, { "id": "gpui_kit::canvas::edge::EdgeState::value", "name": "value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn value (self) -> & 'static str", "cfg": [], "target": "EdgeState" }, { "id": "gpui_kit::canvas::edge::GraphEdge", "name": "GraphEdge", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "A controlled connection between two graph nodes.", "documentation": "A controlled connection between two graph nodes.", "signature": "# [doc = \" A controlled connection between two graph nodes.\"] # [derive (Debug, Clone, PartialEq)] pub struct GraphEdge { from : SharedString, to : SharedString, kind : EdgeKind, id : SharedString, explicit_id : bool, from_port : Option, to_port : Option, label : Option, state : EdgeState, marker : EdgeMarker, selected : bool, lane : i16, color : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::edge::GraphEdge::active", "name": "active", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn active (mut self, active : bool) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The colour this wire wears at rest, over whatever its source port's type would have lent it.", "documentation": "The colour this wire wears at rest, over whatever its source port's\ntype would have lent it.\n\nLeft unset, a wire between typed ports takes the colour of the port it\nleaves, and a wire between untyped ports takes its kind's colour. A\ncaller sets this for a wire whose meaning is not its type — a wire\nbeing traced, say — and the state colours still take over while the\nwire is active, succeeded, or failed.", "signature": "pub fn color (mut self, color : impl Into) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::edge_id", "name": "edge_id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The stable identity used for interaction and duplicate rejection.", "documentation": "The stable identity used for interaction and duplicate rejection.\n\nAn explicit identity supplied with [`GraphEdge::id`] is returned as-is;\notherwise the builder precomputes an unambiguous compatibility identity\nfrom the endpoints, ports, kind, and lane.", "signature": "pub fn edge_id (& self) -> SharedString", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::feedback", "name": "feedback", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn feedback (mut self) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::from", "name": "from", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn from (& self) -> & SharedString", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn id (mut self, id : impl Into) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::kind", "name": "kind", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn kind (& self) -> EdgeKind", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::lane", "name": "lane", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn lane (mut self, lane : i16) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::marker", "name": "marker", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "Places an optional direction mark at the destination port.", "documentation": "Places an optional direction mark at the destination port.", "signature": "pub fn marker (mut self, marker : EdgeMarker) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn new (from : impl Into, to : impl Into) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::ports", "name": "ports", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn ports (mut self, from : impl Into, to : impl Into) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : bool) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : EdgeState) -> Self", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEdge::to", "name": "to", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "", "documentation": "", "signature": "pub fn to (& self) -> & SharedString", "cfg": [], "target": "GraphEdge" }, { "id": "gpui_kit::canvas::edge::GraphEndpoint", "name": "GraphEndpoint", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "A caller-owned node and port identity used by connection proposals.", "documentation": "A caller-owned node and port identity used by connection proposals.", "signature": "# [doc = \" A caller-owned node and port identity used by connection proposals.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct GraphEndpoint { pub node : SharedString, pub port : SharedString, }", "cfg": [] }, { "id": "gpui_kit::canvas::edge::GraphEndpoint::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "Creates an endpoint from business identities, not display labels.", "documentation": "Creates an endpoint from business identities, not display labels.", "signature": "pub fn new (node : impl Into, port : impl Into) -> Self", "cfg": [], "target": "GraphEndpoint" }, { "id": "gpui_kit::canvas::edge::GraphRouting", "name": "GraphRouting", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "How the connections on one graph are drawn.", "documentation": "How the connections on one graph are drawn.\n\nThis is a statement about the graph rather than a taste about the drawing.\nLanes exist to keep many connections legible where they run together, and\n[`GraphEdge::lane`] is how a caller separates them; a curve has no lane to\nbe in, so asking for curves on a graph that needs lanes trades a fact for a\nlook. What decides it is whether a reader has to follow one connection\nthrough a crowd, or take in the shape of a sparse one.", "signature": "# [doc = \" How the connections on one graph are drawn.\"] # [doc = \"\"] # [doc = \" This is a statement about the graph rather than a taste about the drawing.\"] # [doc = \" Lanes exist to keep many connections legible where they run together, and\"] # [doc = \" [`GraphEdge::lane`] is how a caller separates them; a curve has no lane to\"] # [doc = \" be in, so asking for curves on a graph that needs lanes trades a fact for a\"] # [doc = \" look. What decides it is whether a reader has to follow one connection\"] # [doc = \" through a crowd, or take in the shape of a sparse one.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum GraphRouting { # [doc = \" Right-angled runs in separated lanes, which is how a dense pipeline\"] # [doc = \" stays traceable.\"] # [default] Lanes, # [doc = \" One curve from port to port, which is how a sparse board reads as a\"] # [doc = \" gesture rather than as wiring.\"] Curves, }", "cfg": [] }, { "id": "gpui_kit::canvas::edge::PortSide", "name": "PortSide", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::edge", "path": "gpui_kit::canvas::edge", "source": "crates/gpui-kit/src/canvas/edge.rs", "summary": "The side of a node on which a port is placed.", "documentation": "The side of a node on which a port is placed.", "signature": "# [doc = \" The side of a node on which a port is placed.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash, Default)] pub enum PortSide { Top, Right, Bottom, # [default] Left, }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::GraphFit", "name": "GraphFit", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Whether a canvas frames its own content before the reader touches it.", "documentation": "Whether a canvas frames its own content before the reader touches it.\n\nA canvas whose caller computes every position — from a dependency depth, a\ngit lineage, a ledger's layers — is routinely wider than the surface\nholding it, and the default viewport opens on its top-left corner. The\nreader's first sight of the graph is then two cards and an edge leaving the\nframe, with nothing to say that the rest exists.\n\nThe canvas is the only thing that can answer this honestly: it holds every\ncard's measured box and its own surface size, while a caller knows only the\npositions it handed over and would have to guess how tall a card came out.\nWhat stays with the caller is whether framing is wanted at all, because on\na canvas the reader arranges, the opening view is theirs.", "signature": "# [doc = \" Whether a canvas frames its own content before the reader touches it.\"] # [doc = \"\"] # [doc = \" A canvas whose caller computes every position — from a dependency depth, a\"] # [doc = \" git lineage, a ledger's layers — is routinely wider than the surface\"] # [doc = \" holding it, and the default viewport opens on its top-left corner. The\"] # [doc = \" reader's first sight of the graph is then two cards and an edge leaving the\"] # [doc = \" frame, with nothing to say that the rest exists.\"] # [doc = \"\"] # [doc = \" The canvas is the only thing that can answer this honestly: it holds every\"] # [doc = \" card's measured box and its own surface size, while a caller knows only the\"] # [doc = \" positions it handed over and would have to guess how tall a card came out.\"] # [doc = \" What stays with the caller is whether framing is wanted at all, because on\"] # [doc = \" a canvas the reader arranges, the opening view is theirs.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum GraphFit { # [doc = \" The viewport is the caller's from the first frame.\"] # [default] Never, # [doc = \" Frame every node, world-space band, and measured relationship label as\"] # [doc = \" soon as the cards and canvas-owned chrome have been laid out, and again\"] # [doc = \" each time this value changes — which is what a caller's own Fit control\"] # [doc = \" bumps, since the caller cannot compute the frame itself. The fitted\"] # [doc = \" content clears the caller's [`NodeGraph::fit_clearance`], the graph's\"] # [doc = \" minimap, and its toolbar rather than remaining technically inside the\"] # [doc = \" viewport underneath them. Reported as an ordinary\"] # [doc = \" [`NodeGraphEvent::ViewportChanged`], so a caller that already stores its\"] # [doc = \" viewport needs nothing else. Between framings the viewport is the reader's\"] # [doc = \" and the canvas never moves it on its own. While the caller still holds the\"] # [doc = \" exact fitted viewport, a changed container rectangle is framed again; the\"] # [doc = \" first pan, wheel or caller-restored viewport ends that resize following\"] # [doc = \" without requiring a second mode flag.\"] Whole (u64), }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::GraphInteraction", "name": "GraphInteraction", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Which controlled changes an interactive graph may propose.", "documentation": "Which controlled changes an interactive graph may propose.\n\nOmitting [`NodeGraph::on_event`] still makes any mode static. With a\nhandler installed, `Inspect` permits navigation and selection, `Arrange`\nadditionally permits moving nodes, and `Edit` retains the complete graph\neditor including connection and deletion proposals.", "signature": "# [doc = \" Which controlled changes an interactive graph may propose.\"] # [doc = \"\"] # [doc = \" Omitting [`NodeGraph::on_event`] still makes any mode static. With a\"] # [doc = \" handler installed, `Inspect` permits navigation and selection, `Arrange`\"] # [doc = \" additionally permits moving nodes, and `Edit` retains the complete graph\"] # [doc = \" editor including connection and deletion proposals.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum GraphInteraction { Inspect, Arrange, # [default] Edit, }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::GraphState", "name": "GraphState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "What the canvas can currently say about itself.", "documentation": "What the canvas can currently say about itself.\n\nThese are the same five distinct states the rest of the library keeps\napart, and for the same reason: a canvas that is still loading, a run with\nno steps, a graph the host would not produce, and a graph that failed to\nload are four different things, and drawing any of them as an empty canvas\nwould be a lie a reader cannot detect.", "signature": "# [doc = \" What the canvas can currently say about itself.\"] # [doc = \"\"] # [doc = \" These are the same five distinct states the rest of the library keeps\"] # [doc = \" apart, and for the same reason: a canvas that is still loading, a run with\"] # [doc = \" no steps, a graph the host would not produce, and a graph that failed to\"] # [doc = \" load are four different things, and drawing any of them as an empty canvas\"] # [doc = \" would be a lie a reader cannot detect.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum GraphState { # [default] Ready, Loading, # [doc = \" The host declined to produce the graph, in its own words.\"] Refused (SharedString), # [doc = \" The graph could not be loaded, in the host's own words.\"] Failed (SharedString), }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::GraphState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "GraphState" }, { "id": "gpui_kit::canvas::graph::GraphViewport", "name": "GraphViewport", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Caller-owned pan and zoom values for a [`NodeGraph`].", "documentation": "Caller-owned pan and zoom values for a [`NodeGraph`].", "signature": "# [doc = \" Caller-owned pan and zoom values for a [`NodeGraph`].\"] # [derive (Debug, Clone, Copy, PartialEq)] pub struct GraphViewport { pub offset : Point, pub zoom : f32, }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::GraphViewport::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Creates a viewport with a screen-space offset and world scale.", "documentation": "Creates a viewport with a screen-space offset and world scale.", "signature": "pub fn new (offset : Point, zoom : f32) -> Self", "cfg": [], "target": "GraphViewport" }, { "id": "gpui_kit::canvas::graph::NodeGraph", "name": "NodeGraph", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "A run drawn as connected steps.", "documentation": "A run drawn as connected steps.", "signature": "# [doc = \" A run drawn as connected steps.\"] # [derive (IntoElement)] pub struct NodeGraph { ident : Ident, nodes : Vec, edges : Vec, source : Option, bands : Vec, state : GraphState, empty : Option, slots : Slots, grid : bool, axes : bool, ground_light : bool, viewport : GraphViewport, zoom_range : (f32, f32), interaction : GraphInteraction, on_event : Option, can_connect : Option, minimap : bool, toolbar : Option, fit : GraphFit, fit_clearance : Edges, routing : GraphRouting, animate_layout : bool, }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::NodeGraph::animate_layout", "name": "animate_layout", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Animates caller-applied bounds of explicitly sized nodes using the Navigation policy. Automatic-height nodes retain measured instant layout. First mount, direct manipulation and reduced motion snap. Current caller content is never delayed by the layout transition. Newly published identities fade in; initial mount and viewport culling do not replay entrances. Also controls removed-card and route paint retirement. Unsupported recordings retire immediately; disabling drops pictures. Compatible lane corridors interpolate with current ports pinned. Every intermediate uses global clearance checks; incompatible topology or an obstructed sample snaps to the solved route. Labels, culling and semantic targets follow that exact displayed route. Curves follow current nodes.", "documentation": "Animates caller-applied bounds of explicitly sized nodes using the\nNavigation policy. Automatic-height nodes retain measured instant\nlayout. First mount, direct manipulation and reduced motion snap.\nCurrent caller content is never delayed by the layout transition.\nNewly published identities fade in; initial mount and viewport culling\ndo not replay entrances. Also controls removed-card and route paint retirement.\nUnsupported recordings retire immediately; disabling drops pictures.\nCompatible lane corridors interpolate with current ports pinned. Every\nintermediate uses global clearance checks; incompatible topology or an\nobstructed sample snaps to the solved route. Labels, culling and semantic\ntargets follow that exact displayed route. Curves follow current nodes.", "signature": "pub fn animate_layout (mut self, animate : bool) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::axes", "name": "axes", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Turns off the two rules through the world origin while leaving the dot grid in place.", "documentation": "Turns off the two rules through the world origin while leaving the dot\ngrid in place.\n\nThe axes say the origin is a landmark. That is useful on a diagram\nwhose positions carry meaning; a board whose cards were merely laid\nout on a plane has no distinguished zero, so the rules would claim a\nboundary the content does not have.", "signature": "pub fn axes (mut self, axes : bool) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::band", "name": "band", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Names a region of the canvas, in the same world coordinates the nodes are placed in.", "documentation": "Names a region of the canvas, in the same world coordinates the nodes\nare placed in.\n\nBands are drawn above the grid and below every connection and card, in\nthe order they were added, and never intercept a pointer. See\n[`GraphBand`].", "signature": "pub fn band (mut self, band : GraphBand) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::bands", "name": "bands", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn bands (mut self, bands : impl IntoIterator) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::can_connect", "name": "can_connect", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Supplies the caller's connection rules so the graph can preview legal and illegal targets before proposing a connection. Endpoints are always passed as output then input, including gestures begun at input.", "documentation": "Supplies the caller's connection rules so the graph can preview legal\nand illegal targets before proposing a connection. Endpoints are\nalways passed as output then input, including gestures begun at input.", "signature": "pub fn can_connect (mut self, validator : impl Fn (& GraphEndpoint, & GraphEndpoint) -> bool + 'static,) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::edge", "name": "edge", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn edge (mut self, edge : GraphEdge) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::edges", "name": "edges", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn edges (mut self, edges : impl IntoIterator) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::empty", "name": "empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "What to draw when the run has no steps at all. Without one, an empty run draws as an empty canvas, which is only honest when the caller has confirmed that is what it is.", "documentation": "What to draw when the run has no steps at all. Without one, an empty\nrun draws as an empty canvas, which is only honest when the caller has\nconfirmed that is what it is.", "signature": "pub fn empty (mut self, empty : EmptyState) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::fit", "name": "fit", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Whether this canvas frames its own content before the reader touches it. See [`GraphFit`].", "documentation": "Whether this canvas frames its own content before the reader touches\nit. See [`GraphFit`].", "signature": "pub fn fit (mut self, fit : GraphFit) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::fit_clearance", "name": "fit_clearance", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "The canvas edge bands covered by the caller's own overlays, in canvas pixels, so framing a fit keeps content clear of them as it already keeps clear of the graph's toolbar and minimap.", "documentation": "The canvas edge bands covered by the caller's own overlays, in canvas\npixels, so framing a fit keeps content clear of them as it already keeps\nclear of the graph's toolbar and minimap.", "signature": "pub fn fit_clearance (mut self, clearance : Edges) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::grid", "name": "grid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Turns off the dot grid, for a canvas embedded somewhere that already has a texture of its own.", "documentation": "Turns off the dot grid, for a canvas embedded somewhere that already\nhas a texture of its own.", "signature": "pub fn grid (mut self, grid : bool) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::ground_light", "name": "ground_light", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Turns off the ground's top-origin cast, for a canvas whose contents are the lit things on it.", "documentation": "Turns off the ground's top-origin cast, for a canvas whose contents\nare the lit things on it.\n\nThe cast says the ground is a material with a light above it, which is\nwhat a diagram of boxes and lines wants. A board of pictures does not:\neach picture carries its own light, and a sheen running down behind\nthem is a second one arriving from somewhere else. Turning it off\nleaves a flat ground and nothing else — the sunken frame and the grid\nare what they were.", "signature": "pub fn ground_light (mut self, ground_light : bool) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::interaction", "name": "interaction", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn interaction (mut self, interaction : GraphInteraction) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::minimap", "name": "minimap", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Draws a small overview of the placed nodes in the corner.", "documentation": "Draws a small overview of the placed nodes in the corner.", "signature": "pub fn minimap (mut self, show : bool) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::node", "name": "node", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn node (mut self, node : GraphNode, x : f32, y : f32) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::offset", "name": "offset", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Scrolls the canvas. The caller owns the offset, because panning is a gesture the host binds and a position the host may want to keep.", "documentation": "Scrolls the canvas. The caller owns the offset, because panning is a\ngesture the host binds and a position the host may want to keep.", "signature": "pub fn offset (mut self, x : f32, y : f32) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& NodeGraphEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::placed", "name": "placed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn placed (mut self, placed : Placed) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::routing", "name": "routing", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "How this canvas draws its connections. See [`GraphRouting`].", "documentation": "How this canvas draws its connections. See [`GraphRouting`].", "signature": "pub fn routing (mut self, routing : GraphRouting) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::source", "name": "source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Uses caller-shared metadata and lazy visible-card factories instead of consumed nodes/edges. Subsequent node/placed/edge builders select the legacy path again; the two models are never silently merged.", "documentation": "Uses caller-shared metadata and lazy visible-card factories instead of\nconsumed nodes/edges. Subsequent node/placed/edge builders select the\nlegacy path again; the two models are never silently merged.", "signature": "pub fn source (mut self, source : GraphSource) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : GraphState) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::toolbar", "name": "toolbar", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Seats canvas chrome in the graph's top-left overlay layer.", "documentation": "Seats canvas chrome in the graph's top-left overlay layer.\n\nThe graph measures the finished toolbar rather than duplicating its\ncontrol geometry. [`GraphFit::Whole`] then keeps world content out from\nunder it, just as it does for the graph's own minimap. This is the\ncomplete overlay path: paint order and fit geometry cannot disagree,\nand the host supplies no pixel inset.", "signature": "pub fn toolbar (mut self, toolbar : CanvasToolbar) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::viewport", "name": "viewport", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn viewport (mut self, viewport : GraphViewport) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::zoom", "name": "zoom", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn zoom (mut self, zoom : f32) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraph::zoom_range", "name": "zoom_range", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn zoom_range (mut self, min : f32, max : f32) -> Self", "cfg": [], "target": "NodeGraph" }, { "id": "gpui_kit::canvas::graph::NodeGraphEvent", "name": "NodeGraphEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "A proposed controlled graph change.", "documentation": "A proposed controlled graph change.", "signature": "# [doc = \" A proposed controlled graph change.\"] # [derive (Debug, Clone, PartialEq)] pub enum NodeGraphEvent { # [doc = \" Proposes a pan or zoom change.\"] ViewportChanged (GraphViewport), # [doc = \" Proposes the complete caller-owned node selection.\"] SelectionChanged { ids : Vec }, # [doc = \" Proposes a new world-space position for a node.\"] NodeMoved { id : SharedString, position : Point, }, # [doc = \" Proposes a new world-space size for a node, from its resize handle.\"] # [doc = \"\"] # [doc = \" The graph keeps drawing the node at the size the caller last placed\"] # [doc = \" it at; a caller that accepts the proposal places it with\"] # [doc = \" [`Placed::height`] and [`GraphNode::width`] at the reported size.\"] NodeResized { id : SharedString, size : Size }, # [doc = \" Proposes deleting a node by business identity.\"] NodeDeleted { id : SharedString }, # [doc = \" Reports a press that landed on the canvas itself rather than on any\"] # [doc = \" node, with where it landed in world space.\"] # [doc = \"\"] # [doc = \" A caller that puts a new node where the reader pointed needs this, and\"] # [doc = \" only the canvas can answer it: it holds every card's measured box,\"] # [doc = \" while a caller testing the point itself would be re-deriving those\"] # [doc = \" boxes from the positions it handed over and would miss whichever card\"] # [doc = \" came out taller than it assumed.\"] SurfacePressed { position : Point, button : MouseButton, click_count : usize, }, # [doc = \" Proposes a new output-to-input connection.\"] ConnectionRequested { from : GraphEndpoint, to : GraphEndpoint, }, # [doc = \" A connection gesture ended on open canvas rather than another port.\"] # [doc = \" The position uses the same canvas coordinates as placed nodes.\"] ConnectionDropped { from : GraphEndpoint, at : Point }, # [doc = \" Proposes removing one controlled edge by its stable identity.\"] DisconnectRequested { id : SharedString }, }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::Placed", "name": "Placed", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "A node and where its top left corner sits, in canvas coordinates.", "documentation": "A node and where its top left corner sits, in canvas coordinates.", "signature": "# [doc = \" A node and where its top left corner sits, in canvas coordinates.\"] pub struct Placed { pub (super) node : GraphNode, pub (super) x : f32, pub (super) y : f32, # [doc = \" A height the caller declared, for a card whose content the node cannot\"] # [doc = \" measure. Left unset, the node measures itself.\"] pub (super) height : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::graph::Placed::height", "name": "height", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Sets the card's actual logical height. Routing and card layout use this same value. Non-finite and non-positive values leave the height automatic rather than creating geometry the card cannot render.", "documentation": "Sets the card's actual logical height. Routing and card layout use this\nsame value. Non-finite and non-positive values leave the height\nautomatic rather than creating geometry the card cannot render.", "signature": "pub fn height (mut self, height : f32) -> Self", "cfg": [], "target": "Placed" }, { "id": "gpui_kit::canvas::graph::Placed::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "", "documentation": "", "signature": "pub fn new (node : GraphNode, x : f32, y : f32) -> Self", "cfg": [], "target": "Placed" }, { "id": "gpui_kit::canvas::graph::layered_layout", "name": "layered_layout", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::graph", "path": "gpui_kit::canvas::graph", "source": "crates/gpui-kit/src/canvas/graph.rs", "summary": "Places nodes in layers along the reading direction from a caller-owned edge list. The graph still draws whatever positions it is handed; this is a helper a host may apply before that.", "documentation": "Places nodes in layers along the reading direction from a caller-owned\nedge list. The graph still draws whatever positions it is handed; this\nis a helper a host may apply before that.", "signature": "pub fn layered_layout<'a> (ids : impl IntoIterator>, edges : impl IntoIterator, column_gap : f32, row_gap : f32,) -> Vec<(SharedString, Point)>", "cfg": [] }, { "id": "gpui_kit::canvas::group::NodeGroup", "name": "NodeGroup", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::group", "path": "gpui_kit::canvas::group", "source": "crates/gpui-kit/src/canvas/group.rs", "summary": "A labelled group drawn over a canvas region the host already decided.", "documentation": "A labelled group drawn over a canvas region the host already decided.", "signature": "# [doc = \" A labelled group drawn over a canvas region the host already decided.\"] # [derive (IntoElement)] pub struct NodeGroup { ident : Ident, label : SharedString, selected : bool, children : Vec, }", "cfg": [] }, { "id": "gpui_kit::canvas::group::NodeGroup::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::group", "path": "gpui_kit::canvas::group", "source": "crates/gpui-kit/src/canvas/group.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, label : impl Into) -> Self", "cfg": [], "target": "NodeGroup" }, { "id": "gpui_kit::canvas::group::NodeGroup::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::group", "path": "gpui_kit::canvas::group", "source": "crates/gpui-kit/src/canvas/group.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : bool) -> Self", "cfg": [], "target": "NodeGroup" }, { "id": "gpui_kit::canvas::layout::GraphCyclePolicy", "name": "GraphCyclePolicy", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::layout", "path": "gpui_kit::canvas::layout", "source": "crates/gpui-kit/src/canvas/layout.rs", "summary": "How a layered layout handles a component without a remaining source.", "documentation": "How a layered layout handles a component without a remaining source.", "signature": "# [doc = \" How a layered layout handles a component without a remaining source.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum GraphCyclePolicy { # [doc = \" Return an error; no partial layout is returned.\"] Reject, # [doc = \" Place the lexically first remaining node, ignoring its incoming edges.\"] # [doc = \" Such edges can point backwards; this is not a DAG ordering or an SCC layout.\"] BreakIncoming, # [doc = \" Condense strongly connected components into a DAG. Members of each\"] # [doc = \" component share a column, stacked by identity; only internal edges can\"] # [doc = \" run backwards. Unlike BreakIncoming, cycles never delay unrelated DAG\"] # [doc = \" predecessors. Uses iterative traversal, including for deep graphs.\"] Condense, }", "cfg": [] }, { "id": "gpui_kit::canvas::layout::GraphLayoutError", "name": "GraphLayoutError", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::layout", "path": "gpui_kit::canvas::layout", "source": "crates/gpui-kit/src/canvas/layout.rs", "summary": "Invalid input to [`layered_layout_sized`].", "documentation": "Invalid input to [`layered_layout_sized`].", "signature": "# [doc = \" Invalid input to [`layered_layout_sized`].\"] # [derive (Clone, Debug, PartialEq, Eq)] pub enum GraphLayoutError { DuplicateId (SharedString), InvalidSize (SharedString), UnknownEndpoint (SharedString), InvalidGap, Cycle, Overflow, }", "cfg": [] }, { "id": "gpui_kit::canvas::layout::layered_layout_sized", "name": "layered_layout_sized", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::layout", "path": "gpui_kit::canvas::layout", "source": "crates/gpui-kit/src/canvas/layout.rs", "summary": "Deterministic left-to-right layout using caller-measured node dimensions.", "documentation": "Deterministic left-to-right layout using caller-measured node dimensions.\n\nNode input order never affects the result. Each weakly connected component\ngets its own horizontal band. Columns\nadvance by the widest member plus `column_gap`; rows by actual height plus\n`row_gap`. Component bands are separated by `component_gap`. Duplicate edges\nhave no effect. Gaps must be finite and nonnegative, dimensions finite and\npositive. Unknown endpoints and duplicate identities are errors.\n\n`Reject` and `BreakIncoming` preserve lexical order within layers. `Condense`\nkeeps strongly connected members together and runs eight alternating\nbarycenter sweeps on the condensation DAG, retaining the best adjacent-layer\ncrossing count (never worse than its initial lexical ordering). Long edges\nare not split into dummy vertices; this is not optimal crossing minimization\nor obstacle routing. Cyclic edges under `BreakIncoming` may run backwards.\nThe returned bounds are sorted by identity. No geometry is installed into\nNodeGraph.", "signature": "pub fn layered_layout_sized<'a> (nodes : impl IntoIterator)>, edges : impl IntoIterator, column_gap : f32, row_gap : f32, component_gap : f32, cycles : GraphCyclePolicy,) -> Result)>, GraphLayoutError>", "cfg": [] }, { "id": "gpui_kit::canvas::minimap::Minimap", "name": "Minimap", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "A compact overview of host-owned marks.", "documentation": "A compact overview of host-owned marks.", "signature": "# [doc = \" A compact overview of host-owned marks.\"] # [derive (IntoElement)] pub struct Minimap { ident : Ident, marks : Vec, view : Option, on_pan : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::minimap::Minimap::marks", "name": "marks", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn marks (mut self, marks : impl IntoIterator) -> Self", "cfg": [], "target": "Minimap" }, { "id": "gpui_kit::canvas::minimap::Minimap::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "Minimap" }, { "id": "gpui_kit::canvas::minimap::Minimap::on_pan", "name": "on_pan", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn on_pan (mut self, handler : impl Fn (f32, f32, & mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "Minimap" }, { "id": "gpui_kit::canvas::minimap::Minimap::view", "name": "view", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn view (mut self, view : MinimapView) -> Self", "cfg": [], "target": "Minimap" }, { "id": "gpui_kit::canvas::minimap::MinimapEvent", "name": "MinimapEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "What a click on the overview reported.", "documentation": "What a click on the overview reported.", "signature": "# [doc = \" What a click on the overview reported.\"] # [derive (Debug, Clone, PartialEq)] pub enum MinimapEvent { Pan { x : f32, y : f32 }, }", "cfg": [] }, { "id": "gpui_kit::canvas::minimap::MinimapMark", "name": "MinimapMark", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "One already-normalized mark on the overview.", "documentation": "One already-normalized mark on the overview.", "signature": "# [doc = \" One already-normalized mark on the overview.\"] # [derive (Debug, Clone, PartialEq)] pub struct MinimapMark { pub id : SharedString, pub x : f32, pub y : f32, pub width : f32, pub height : f32, # [doc = \" Optional caller-owned category colour. A mark without one remains\"] # [doc = \" neutral; a mark with one resolves through the same palette tier as a\"] # [doc = \" graph node, so identity survives the change in scale.\"] pub color : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::minimap::MinimapMark::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn color (mut self, color : impl Into) -> Self", "cfg": [], "target": "MinimapMark" }, { "id": "gpui_kit::canvas::minimap::MinimapMark::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, x : f32, y : f32, width : f32, height : f32) -> Self", "cfg": [], "target": "MinimapMark" }, { "id": "gpui_kit::canvas::minimap::MinimapView", "name": "MinimapView", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "The visible window, already normalized.", "documentation": "The visible window, already normalized.", "signature": "# [doc = \" The visible window, already normalized.\"] # [derive (Debug, Clone, Copy, PartialEq)] pub struct MinimapView { pub x : f32, pub y : f32, pub width : f32, pub height : f32, }", "cfg": [] }, { "id": "gpui_kit::canvas::minimap::MinimapView::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::minimap", "path": "gpui_kit::canvas::minimap", "source": "crates/gpui-kit/src/canvas/minimap.rs", "summary": "", "documentation": "", "signature": "pub fn new (x : f32, y : f32, width : f32, height : f32) -> Self", "cfg": [], "target": "MinimapView" }, { "id": "gpui_kit::canvas::node::Diff", "name": "Diff", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "How much a step changed, in lines.", "documentation": "How much a step changed, in lines.\n\nKept apart from [`NodeMetric`] because the two halves are coloured against\neach other, and a reader who sees green and red beside each other is\nentitled to assume they mean added and removed.", "signature": "# [doc = \" How much a step changed, in lines.\"] # [doc = \"\"] # [doc = \" Kept apart from [`NodeMetric`] because the two halves are coloured against\"] # [doc = \" each other, and a reader who sees green and red beside each other is\"] # [doc = \" entitled to assume they mean added and removed.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub struct Diff { pub added : usize, pub removed : usize, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::Diff::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn is_empty (self) -> bool", "cfg": [], "target": "Diff" }, { "id": "gpui_kit::canvas::node::Diff::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn new (added : usize, removed : usize) -> Self", "cfg": [], "target": "Diff" }, { "id": "gpui_kit::canvas::node::GraphNode", "name": "GraphNode", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "A step of a run, as a card on the canvas.", "documentation": "A step of a run, as a card on the canvas.", "signature": "# [doc = \" A step of a run, as a card on the canvas.\"] # [derive (IntoElement)] pub struct GraphNode { ident : Ident, title : SharedString, icon : Option, thumbnail : Option, thumbnail_ratio : f32, note : Option, note_lines : usize, # [doc = \" What the step is doing now, for a step that is doing something.\"] action : Option, state : NodeState, # [doc = \" What kind of step this is, in the caller's own terms.\"] category : Option, # [doc = \" The word for that kind, when the caller has one.\"] kind : Option, metrics : Vec, ports : Vec, diff : Option, status : Option, progress : Option, # [doc = \" Caller-owned content seated below the ports: a prompt, a preview, a\"] # [doc = \" control. The card lays it out and keeps its hands off it.\"] content : Vec, selected : bool, active_glass : GlassPreset, width : f32, display_zoom : f32, declared_height : Option, pointer_click : bool, compact : bool, on_click : Option, on_delete : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::GraphNode::action", "name": "action", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "What the step is doing right now, in the caller's words.", "documentation": "What the step is doing right now, in the caller's words.\n\nShown only while the step is busy: a finished step's last action is a\nrecord, and a record belongs in the step's detail, not on a card\nwhose job is to say where the run is now.", "signature": "pub fn action (mut self, action : impl Into) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::active_glass", "name": "active_glass", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Chooses the shared glass preset used while the node is running, selected, or under the pointer.", "documentation": "Chooses the shared glass preset used while the node is running,\nselected, or under the pointer.\n\nResting cards remain the zero-snapshot pseudo-glass material. The\npromoted state uses [`Glass`] itself, so blur, refraction, fallback and\nrenderer admission stay one framework contract. Frosted is the default.", "signature": "pub fn active_glass (mut self, preset : GlassPreset) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::child", "name": "child", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Seats caller-owned content below the ports.", "documentation": "Seats caller-owned content below the ports.\n\nThe card lays the content out at its own width and keeps its hands\noff it: pointer and keyboard that land on the content belong to what\nthe caller mounted, not to the card's activation or the canvas's drag.\nA prompt field, a preview, a slider, and a button are all content.", "signature": "pub fn child (mut self, child : impl IntoElement) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::children", "name": "children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn children (mut self, children : impl IntoIterator) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "What kind of step this is, painted as the node's header and its edge stripe.", "documentation": "What kind of step this is, painted as the node's header and its edge\nstripe.\n\nCategory is the caller's taxonomy, not this component's: a graph of\nsources, transforms and sinks and a graph of agents, tools and\napprovals both need their kinds told apart at a glance, and neither\nlist belongs in a UI kit. It resolves through the shared\n[`Variant::Light`] tier, so a teal node here and a teal chip elsewhere\nare the same teal.\n\nThis is deliberately separate from [`GraphNode::state`]. What a step\n*is* does not change while it runs, and a node that changed colour on\nfailure would lose the identity a reader was using to find it.", "signature": "pub fn color (mut self, category : impl Into) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::diff", "name": "diff", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "What the step changed. An empty diff is not shown, because \"nothing changed\" and \"no diff was reported\" are different claims and only the caller knows which one it has.", "documentation": "What the step changed. An empty diff is not shown, because \"nothing\nchanged\" and \"no diff was reported\" are different claims and only the\ncaller knows which one it has.", "signature": "pub fn diff (mut self, diff : Diff) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::icon", "name": "icon", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Seats a caller-owned category glyph in the leading badge.", "documentation": "Seats a caller-owned category glyph in the leading badge.\n\nThe node resolves its wash from [`GraphNode::color`] and never infers a\ncategory from the glyph. A host that has no category icon leaves the\nseat absent rather than receiving a generic substitute.", "signature": "pub fn icon (mut self, icon : Icon) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::kind", "name": "kind", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "The word for what this node is — \"image\", \"review\", \"deploy\" — set quietly beside the title.", "documentation": "The word for what this node is — \"image\", \"review\", \"deploy\" — set\nquietly beside the title.\n\nIt is a word and not a chip: the badge already carries the category's\ncolour, and a wash behind the word would say the kind twice on every\ncard. A node with a colour and no badge keeps the wash on the card,\nbecause then the wash is the only thing saying it.", "signature": "pub fn kind (mut self, kind : impl Into) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::metric", "name": "metric", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "One bare figure the step reports. The value is visible; the label names it on hover and in the semantic tree. For facts that need a visible name, pass a [`NodeMetric::labelled`] figure to [`Self::metrics`].", "documentation": "One bare figure the step reports. The value is visible; the label\nnames it on hover and in the semantic tree. For facts that need a\nvisible name, pass a [`NodeMetric::labelled`] figure to [`Self::metrics`].", "signature": "pub fn metric (mut self, label : impl Into, value : impl Into,) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::metrics", "name": "metrics", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn metrics (mut self, metrics : impl IntoIterator) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, title : impl Into) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::note", "name": "note", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "A muted, wrapping text body, omitted in compact mode. The semantic description retains the full caller-supplied, display-safe text.", "documentation": "A muted, wrapping text body, omitted in compact mode. The semantic\ndescription retains the full caller-supplied, display-safe text.", "signature": "pub fn note (mut self, text : impl Into) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::note_lines", "name": "note_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Maximum visible note lines (four by default); zero is treated as one. GPUI shapes and ellipsizes the text rather than cropping characters.", "documentation": "Maximum visible note lines (four by default); zero is treated as one.\nGPUI shapes and ellipsizes the text rather than cropping characters.", "signature": "pub fn note_lines (mut self, n : usize) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::on_click", "name": "on_click", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn on_click (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::port", "name": "port", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn port (mut self, port : GraphPort) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::ports", "name": "ports", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn ports (mut self, ports : impl IntoIterator) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::progress", "name": "progress", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "How far the step has got, as a bar along the card's top edge.", "documentation": "How far the step has got, as a bar along the card's top edge.\n\n`Some(fraction)` fills that much of the edge. `None` says the step is\nworking without knowing how much is left, and the bar sweeps while the\nstep is busy. A step that succeeds fills the bar and lets it go; one\nthat fails keeps the bar where it stopped, in the failure's colour,\nbecause how far it got is part of what went wrong.", "signature": "pub fn progress (mut self, fraction : Option) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : NodeState) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::status", "name": "status", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "The caller's own words for the step's state, published on the state dot's help and in the semantic tree.", "documentation": "The caller's own words for the step's state, published on the state\ndot's help and in the semantic tree.\n\n[`GraphNode::state`] owns the semantic state, colour and motion, and\nthe dot is what the card shows for it; these words are caller-owned\nbecause products use different operational vocabulary for the same\nstate, and they are not painted on the card because the dot has\nalready said it.", "signature": "pub fn status (mut self, status : impl Into) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::thumbnail", "name": "thumbnail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Supplies the caller-owned visual preview for this node.", "documentation": "Supplies the caller-owned visual preview for this node.\n\nThe slot fills the card's content width and keeps a 16:9 ratio unless\n[`GraphNode::thumbnail_ratio`] states another one. The element may be\nan image, a video still, a waveform, or any other visual the caller can\nrender; this component does not fetch or decode it.", "signature": "pub fn thumbnail (mut self, thumbnail : impl IntoElement) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::thumbnail_ratio", "name": "thumbnail_ratio", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Sets the thumbnail width divided by its height.", "documentation": "Sets the thumbnail width divided by its height.", "signature": "pub fn thumbnail_ratio (mut self, ratio : f32) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphNode::width", "name": "width", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn width (mut self, width : f32) -> Self", "cfg": [], "target": "GraphNode" }, { "id": "gpui_kit::canvas::node::GraphPort", "name": "GraphPort", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "A typed connection point on a [`GraphNode`].", "documentation": "A typed connection point on a [`GraphNode`].\n\nPort ids must be unique within their node. They are caller-owned identity,\nwhile labels are the caller-owned words shown for that identity.", "signature": "# [doc = \" A typed connection point on a [`GraphNode`].\"] # [doc = \"\"] # [doc = \" Port ids must be unique within their node. They are caller-owned identity,\"] # [doc = \" while labels are the caller-owned words shown for that identity.\"] # [derive (Debug, Clone, PartialEq)] pub struct GraphPort { id : SharedString, label : SharedString, direction : PortDirection, side : PortSide, port_type : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::GraphPort::direction", "name": "direction", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn direction (& self) -> PortDirection", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::input", "name": "input", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn input (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn label (& self) -> & SharedString", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::output", "name": "output", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn output (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::port_side", "name": "port_side", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Returns the side selected for this port.", "documentation": "Returns the side selected for this port.\n\nNamed distinctly from the [`GraphPort::side`] builder because Rust\ndoes not overload methods by argument count.", "signature": "pub fn port_side (& self) -> PortSide", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::port_type", "name": "port_type", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn port_type (& self) -> Option<& PortType>", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::side", "name": "side", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn side (mut self, side : PortSide) -> Self", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::GraphPort::typed", "name": "typed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "States what this port carries. The ring takes the type's colour and glyph, and a wire leaving an output of this type takes its colour.", "documentation": "States what this port carries. The ring takes the type's colour and\nglyph, and a wire leaving an output of this type takes its colour.", "signature": "pub fn typed (mut self, port_type : PortType) -> Self", "cfg": [], "target": "GraphPort" }, { "id": "gpui_kit::canvas::node::NODE_WIDTH", "name": "NODE_WIDTH", "kind": "constant", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "The default width of a node, in pixels.", "documentation": "The default width of a node, in pixels.\n\nNodes on one canvas share a width so the columns of a graph line up and the\neye can compare two steps without measuring them.", "signature": "pub const NODE_WIDTH: f32", "cfg": [] }, { "id": "gpui_kit::canvas::node::NodeMetric", "name": "NodeMetric", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "One figure a step reports about itself, such as a token count or an elapsed time. Both halves are the caller's words.", "documentation": "One figure a step reports about itself, such as a token count or an elapsed\ntime. Both halves are the caller's words.", "signature": "# [doc = \" One figure a step reports about itself, such as a token count or an elapsed\"] # [doc = \" time. Both halves are the caller's words.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct NodeMetric { pub label : SharedString, pub value : SharedString, # [doc = \" Whether the label is also visible beside the value.\"] pub labelled : bool, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::NodeMetric::labelled", "name": "labelled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Shows a muted label beside the normal-colour value.", "documentation": "Shows a muted label beside the normal-colour value.", "signature": "pub fn labelled (mut self) -> Self", "cfg": [], "target": "NodeMetric" }, { "id": "gpui_kit::canvas::node::NodeMetric::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn new (label : impl Into, value : impl Into) -> Self", "cfg": [], "target": "NodeMetric" }, { "id": "gpui_kit::canvas::node::NodeState", "name": "NodeState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "The exact execution state a step reports.", "documentation": "The exact execution state a step reports.\n\nQueued, waiting, blocked, refused, failed, cancelled, and unavailable are\nseparate answers. Keeping the full vocabulary here prevents a run adapter\nfrom painting a host refusal as a failure or a wait as an unreached step.", "signature": "# [doc = \" The exact execution state a step reports.\"] # [doc = \"\"] # [doc = \" Queued, waiting, blocked, refused, failed, cancelled, and unavailable are\"] # [doc = \" separate answers. Keeping the full vocabulary here prevents a run adapter\"] # [doc = \" from painting a host refusal as a failure or a wait as an unreached step.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum NodeState { # [doc = \" Not reached yet.\"] # [default] Pending, Idle, Queued, Starting, Running, Waiting, Blocked, Succeeded, Partial, Failed, # [doc = \" The host declined to run it. Shown as a refusal, never as a failure and\"] # [doc = \" never as an empty step.\"] Refused, Cancelling, Cancelled, TimedOut, Unavailable, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::NodeState::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn color (self, theme : & gpui_kit_theme::Theme) -> Hsla", "cfg": [], "target": "NodeState" }, { "id": "gpui_kit::canvas::node::PortDirection", "name": "PortDirection", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Whether a port receives or produces data.", "documentation": "Whether a port receives or produces data.", "signature": "# [doc = \" Whether a port receives or produces data.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum PortDirection { # [default] Input, Output, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::PortDirection::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "PortDirection" }, { "id": "gpui_kit::canvas::node::PortType", "name": "PortType", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "What a port carries, in the caller's taxonomy.", "documentation": "What a port carries, in the caller's taxonomy.\n\nA type is a colour and, optionally, a glyph. The colour is the one fact a\nreader uses to tell at a glance which sockets can be joined and which wire\ncarries what: a connection inherits the colour of the port it leaves. The\nid is the caller's own vocabulary for the type — `\"image\"`, `\"tensor\"`,\n`\"text\"` — and is published on the port, never invented here.", "signature": "# [doc = \" What a port carries, in the caller's taxonomy.\"] # [doc = \"\"] # [doc = \" A type is a colour and, optionally, a glyph. The colour is the one fact a\"] # [doc = \" reader uses to tell at a glance which sockets can be joined and which wire\"] # [doc = \" carries what: a connection inherits the colour of the port it leaves. The\"] # [doc = \" id is the caller's own vocabulary for the type — `\\\"image\\\"`, `\\\"tensor\\\"`,\"] # [doc = \" `\\\"text\\\"` — and is published on the port, never invented here.\"] # [derive (Debug, Clone, PartialEq)] pub struct PortType { id : SharedString, glyph : Option, color : ColorChoice, }", "cfg": [] }, { "id": "gpui_kit::canvas::node::PortType::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn color (& self) -> & ColorChoice", "cfg": [], "target": "PortType" }, { "id": "gpui_kit::canvas::node::PortType::glyph", "name": "glyph", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "Seats a glyph inside the port ring, for a type whose colour alone is not enough to tell it from its neighbours.", "documentation": "Seats a glyph inside the port ring, for a type whose colour alone is\nnot enough to tell it from its neighbours.", "signature": "pub fn glyph (mut self, glyph : Icon) -> Self", "cfg": [], "target": "PortType" }, { "id": "gpui_kit::canvas::node::PortType::icon", "name": "icon", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn icon (& self) -> Option", "cfg": [], "target": "PortType" }, { "id": "gpui_kit::canvas::node::PortType::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "PortType" }, { "id": "gpui_kit::canvas::node::PortType::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::node", "path": "gpui_kit::canvas::node", "source": "crates/gpui-kit/src/canvas/node.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, color : impl Into) -> Self", "cfg": [], "target": "PortType" }, { "id": "gpui_kit::canvas::reexport-1", "name": "band :: GraphBand", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use band::GraphBand;", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-2", "name": "edge :: { EdgeKind , EdgeMarker , EdgeState , GraphEdge , GraphEndpoint , GraphRouting , PortSide }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use edge::{ EdgeKind, EdgeMarker, EdgeState, GraphEdge, GraphEndpoint, GraphRouting, PortSide };", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-3", "name": "graph :: { GraphFit , GraphInteraction , GraphState , GraphViewport , NodeGraph , NodeGraphEvent , Placed , layered_layout , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use graph::{ GraphFit, GraphInteraction, GraphState, GraphViewport, NodeGraph, NodeGraphEvent, Placed, layered_layout, };", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-4", "name": "group :: NodeGroup", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use group::NodeGroup;", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-5", "name": "layout :: { GraphCyclePolicy , GraphLayoutError , layered_layout_sized }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use layout::{ GraphCyclePolicy, GraphLayoutError, layered_layout_sized };", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-6", "name": "minimap :: { Minimap , MinimapEvent , MinimapMark , MinimapView }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use minimap::{ Minimap, MinimapEvent, MinimapMark, MinimapView };", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-7", "name": "node :: { Diff , GraphNode , GraphPort , NODE_WIDTH , NodeMetric , NodeState , PortDirection , PortType , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use node::{ Diff, GraphNode, GraphPort, NODE_WIDTH, NodeMetric, NodeState, PortDirection, PortType, };", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-8", "name": "source :: { GraphSource , GraphSourceError }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use source::{ GraphSource, GraphSourceError };", "cfg": [] }, { "id": "gpui_kit::canvas::reexport-9", "name": "toolbar :: { CanvasToolbar , CanvasToolbarAction , CanvasToolbarEvent }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas", "path": "gpui_kit::canvas", "source": "crates/gpui-kit/src/canvas/mod.rs", "summary": "", "documentation": "", "signature": "pub use toolbar::{ CanvasToolbar, CanvasToolbarAction, CanvasToolbarEvent };", "cfg": [] }, { "id": "gpui_kit::canvas::source::GraphSource", "name": "GraphSource", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Reusable graph data. `GraphNode` remains the metadata authority; explicit finite sizes make offscreen nodes routable without mounting their content. One-use children/thumbnails are rejected; use lazy factory setters instead. Edges may name absent nodes and remain caller-owned through node removal.", "documentation": "Reusable graph data. `GraphNode` remains the metadata authority; explicit\nfinite sizes make offscreen nodes routable without mounting their content.\nOne-use children/thumbnails are rejected; use lazy factory setters instead.\nEdges may name absent nodes and remain caller-owned through node removal.", "signature": "# [doc = \" Reusable graph data. `GraphNode` remains the metadata authority; explicit\"] # [doc = \" finite sizes make offscreen nodes routable without mounting their content.\"] # [doc = \" One-use children/thumbnails are rejected; use lazy factory setters instead.\"] # [doc = \" Edges may name absent nodes and remain caller-owned through node removal.\"] # [derive (Clone, Default)] pub struct GraphSource { pub (super) data : Rc>, }", "cfg": [] }, { "id": "gpui_kit::canvas::source::GraphSource::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "", "documentation": "", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::len", "name": "len", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "", "documentation": "", "signature": "pub fn len (& self) -> usize", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "", "documentation": "", "signature": "pub fn new (nodes : impl IntoIterator, edges : impl IntoIterator,) -> Result", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::remove", "name": "remove", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Removes this identity and its factories, not the caller's edges. A reinserted identity is new content at the end of the source order.", "documentation": "Removes this identity and its factories, not the caller's edges. A\nreinserted identity is new content at the end of the source order.", "signature": "pub fn remove (& self, id : & str) -> bool", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::replace_edges", "name": "replace_edges", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "", "documentation": "", "signature": "pub fn replace_edges (& self, edges : impl IntoIterator,) -> Result<(), GraphSourceError>", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::revision", "name": "revision", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Monotonic accepted-mutation revision shared by every cloned handle.", "documentation": "Monotonic accepted-mutation revision shared by every cloned handle.", "signature": "pub fn revision (& self) -> u64", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::same_source", "name": "same_source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Identity is stable across mutations, and distinct from equal data.", "documentation": "Identity is stable across mutations, and distinct from equal data.", "signature": "pub fn same_source (& self, other : & Self) -> bool", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::set_content", "name": "set_content", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Runs only when this card mounts. Captured host data remains caller-owned; replace the factory after changing its data to publish a new revision.", "documentation": "Runs only when this card mounts. Captured host data remains caller-owned;\nreplace the factory after changing its data to publish a new revision.", "signature": "pub fn set_content (& self, id : & str, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Result<(), GraphSourceError>", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::set_thumbnail", "name": "set_thumbnail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Lazy thumbnail with the canonical node's thumbnail aspect ratio.", "documentation": "Lazy thumbnail with the canonical node's thumbnail aspect ratio.", "signature": "pub fn set_thumbnail (& self, id : & str, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Result<(), GraphSourceError>", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSource::upsert", "name": "upsert", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Replaces canonical metadata while preserving existing factory ownership and insertion order. New identities append. Failed validation is atomic.", "documentation": "Replaces canonical metadata while preserving existing factory ownership\nand insertion order. New identities append. Failed validation is atomic.", "signature": "pub fn upsert (& self, placed : Placed) -> Result<(), GraphSourceError>", "cfg": [], "target": "GraphSource" }, { "id": "gpui_kit::canvas::source::GraphSourceError", "name": "GraphSourceError", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::source", "path": "gpui_kit::canvas::source", "source": "crates/gpui-kit/src/canvas/source.rs", "summary": "Rejected source mutation. Validation is atomic: neither metadata, factory ownership, ordering nor revision changes on error.", "documentation": "Rejected source mutation. Validation is atomic: neither metadata, factory\nownership, ordering nor revision changes on error.", "signature": "# [doc = \" Rejected source mutation. Validation is atomic: neither metadata, factory\"] # [doc = \" ownership, ordering nor revision changes on error.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum GraphSourceError { DuplicateNode (SharedString), DuplicateEdge (SharedString), DuplicatePort { node : SharedString, port : SharedString, }, MissingNode (SharedString), InvalidGeometry (SharedString), MissingHeight (SharedString), OpaqueContent (SharedString), }", "cfg": [] }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbar", "name": "CanvasToolbar", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "Compact canvas chrome: a host-formatted zoom and the intents the host can actually carry out.", "documentation": "Compact canvas chrome: a host-formatted zoom and the intents the host can\nactually carry out.", "signature": "# [doc = \" Compact canvas chrome: a host-formatted zoom and the intents the host can\"] # [doc = \" actually carry out.\"] # [derive (IntoElement)] pub struct CanvasToolbar { ident : Ident, zoom : SharedString, actions : Vec, snap : bool, glass : Option, disabled : bool, on_action : Option, }", "cfg": [] }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbar::actions", "name": "actions", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "The actions this toolbar offers, in the order it shows them.", "documentation": "The actions this toolbar offers, in the order it shows them.\n\nThe default is all three, which is the toolbar a graph editor wants.\nAn inspect-only canvas cannot snap or rearrange anything, and a chip\nthat reports an intent its host will not act on is a promise the\nreader is entitled to believe. Naming the actions is how a host says\nwhich promises it can keep; naming none leaves the zoom on its own,\nwhich is a legitimate readout.\n\nRepeats are dropped rather than drawn twice.", "signature": "pub fn actions (mut self, actions : impl IntoIterator) -> Self", "cfg": [], "target": "CanvasToolbar" }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbar::glass", "name": "glass", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "Places this floating chrome on one of the kit's glass materials.", "documentation": "Places this floating chrome on one of the kit's glass materials.\n\nThe preset resolves exclusively through the theme's `effect.glass*`\ntokens and the shared [`Glass`] layer, including its renderer fallback\nand adaptive readability tint. Without this opt-in the toolbar keeps\nits ordinary opaque overlay surface.\n\n# Prefer a preset that scatters\n\nA canvas is line work — a grid, an axis rule, an edge, a region\nboundary — and this toolbar floats over it, so whatever is behind it is\na hairline sooner or later. [`GlassPreset::Liquid`] and\n[`GlassPreset::Lens`] are clear by default: their blur is zero, so a\nline arrives on the far side at full contrast and crosses the\ntoolbar's own readout. That is the material behaving as documented,\nand it is still a toolbar whose zoom percentage has a rule through it.\n\nAn adaptive tint cannot answer this. Tint darkens what shows through;\nit does not remove the *structure* of a line crossing a glyph, and a\ntint heavy enough to hide one is no longer glass. Scattering removes\nthe structure, which is the thing in the way. Reach for\n[`GlassPreset::Frosted`], or compose blur onto another preset with\n[`Glass::blur`], unless the surface behind this toolbar is known not to\ncarry line work.", "signature": "pub fn glass (mut self, preset : GlassPreset) -> Self", "cfg": [], "target": "CanvasToolbar" }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbar::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, zoom : impl Into) -> Self", "cfg": [], "target": "CanvasToolbar" }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbar::on_action", "name": "on_action", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "", "documentation": "", "signature": "pub fn on_action (mut self, handler : impl Fn (CanvasToolbarAction, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "CanvasToolbar" }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbar::snap", "name": "snap", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "", "documentation": "", "signature": "pub fn snap (mut self, snap : bool) -> Self", "cfg": [], "target": "CanvasToolbar" }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbarAction", "name": "CanvasToolbarAction", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "A canvas chrome action the host already knows how to apply.", "documentation": "A canvas chrome action the host already knows how to apply.", "signature": "# [doc = \" A canvas chrome action the host already knows how to apply.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum CanvasToolbarAction { Fit, Snap, Arrange, }", "cfg": [] }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbarAction::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "CanvasToolbarAction" }, { "id": "gpui_kit::canvas::toolbar::CanvasToolbarEvent", "name": "CanvasToolbarEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "canvas::toolbar", "path": "gpui_kit::canvas::toolbar", "source": "crates/gpui-kit/src/canvas/toolbar.rs", "summary": "What the toolbar reported.", "documentation": "What the toolbar reported.", "signature": "# [doc = \" What the toolbar reported.\"] # [derive (Debug, Clone, PartialEq)] pub enum CanvasToolbarEvent { Action (CanvasToolbarAction), }", "cfg": [] }, { "id": "gpui_kit::content::agent_document::AgentBlockKind", "name": "AgentBlockKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "The semantic kind of one document block.", "documentation": "The semantic kind of one document block.", "signature": "# [doc = \" The semantic kind of one document block.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum AgentBlockKind { Text, Markdown, Code, ToolCall, Diff, Artifact, Schema, Chart, Image, Notice, Choice, Custom, }", "cfg": [] }, { "id": "gpui_kit::content::agent_document::AgentBlockKind::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (self) -> & 'static str", "cfg": [], "target": "AgentBlockKind" }, { "id": "gpui_kit::content::agent_document::AgentBlockKind::is_evidence", "name": "is_evidence", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Supporting evidence in a transcript, rather than the answer or a media/result surface that deserves its own presentation.", "documentation": "Supporting evidence in a transcript, rather than the answer or a\nmedia/result surface that deserves its own presentation.", "signature": "pub fn is_evidence (self) -> bool", "cfg": [], "target": "AgentBlockKind" }, { "id": "gpui_kit::content::agent_document::AgentDocument", "name": "AgentDocument", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "A read-only sequence of typed agent output blocks.", "documentation": "A read-only sequence of typed agent output blocks.", "signature": "# [doc = \" A read-only sequence of typed agent output blocks.\"] # [derive (IntoElement)] pub struct AgentDocument { ident : Ident, state : AgentDocumentState, blocks : Vec, visible_rows : Option, on_event : Option, markdown_options : Option, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::content::agent_document::AgentDocument::block", "name": "block", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn block (mut self, block : AgentDocumentBlock) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::blocks", "name": "blocks", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn blocks (mut self, blocks : impl IntoIterator) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::configure_markdown", "name": "configure_markdown", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Configures each mounted Markdown row with host-owned image resolution, highlighting or block plugins. The block id is the caller's identity, independent of revision and virtualization. The callback is repeatable.", "documentation": "Configures each mounted Markdown row with host-owned image resolution,\nhighlighting or block plugins. The block id is the caller's identity,\nindependent of revision and virtualization. The callback is repeatable.", "signature": "pub fn configure_markdown (mut self, configure : impl Fn (& SharedString, Markdown) -> Markdown + 'static,) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::duplicate_ids", "name": "duplicate_ids", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Repeated block identities are returned exactly as supplied. The host decides whether repeated records are revisions, duplicates, or distinct content and gives them distinct ids where appropriate.", "documentation": "Repeated block identities are returned exactly as supplied. The host\ndecides whether repeated records are revisions, duplicates, or distinct\ncontent and gives them distinct ids where appropriate.", "signature": "pub fn duplicate_ids (& self) -> Vec", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& AgentDocumentEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::remeasure_block", "name": "remeasure_block", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Invalidates geometry for this caller-owned block after asynchronous image resolution or a native plugin changes size. Unrelated rows and the current scroll anchor stay intact; semantic ids do not change.", "documentation": "Invalidates geometry for this caller-owned block after asynchronous\nimage resolution or a native plugin changes size. Unrelated rows and\nthe current scroll anchor stay intact; semantic ids do not change.", "signature": "pub fn remeasure_block (ident : & Ident, block : & str, window : & mut Window, cx : & mut App)", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : AgentDocumentState) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::virtualized", "name": "virtualized", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Lays out only the blocks that are on screen, in a frame this many blocks tall.", "documentation": "Lays out only the blocks that are on screen, in a frame this many\nblocks tall.\n\nA conversation is not a document that happens to be long. It is a\nsurface that grows all day, is scrolled back through, and whose oldest\nblocks are a diff of four hundred lines and a tool call with a table in\nit. Drawn as a column, every one of those is laid out on every frame,\nincluding while the newest block is still arriving a token at a time —\nso the cost of showing the *last* block grows with everything said\nbefore it, which is the shape of a surface that gets slower the longer\nthe conversation is useful.\n\nVirtualized, the cost of a frame is the cost of the screenful. That is\nwhy a block holds a way to build its element rather than a built one:\nthere is no other way to draw a block that scrolled off and came back.\n\nBlocks are matched across frames by their ids, so a block whose text\ngrew re-measures that block and nothing else. Without that a streaming\nreply would discard every height the list had learned on every token,\nand the scrollbar would shudder for as long as the answer took to\narrive.\n\nThe trade is the usual one: a block that has never been on screen has\nno bounds and publishes nothing, so a copy across the whole document\nreaches what was mounted rather than everything that exists.", "signature": "pub fn virtualized (mut self, rows : usize) -> Self", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocument::work", "name": "work", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Reports actual retained planning work for this virtualized identity.", "documentation": "Reports actual retained planning work for this virtualized identity.", "signature": "pub fn work (ident : & Ident, window : & Window, cx : & mut App) -> AgentDocumentWork", "cfg": [], "target": "AgentDocument" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock", "name": "AgentDocumentBlock", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "One stable part of an [`AgentDocument`].", "documentation": "One stable part of an [`AgentDocument`].", "signature": "# [doc = \" One stable part of an [`AgentDocument`].\"] pub struct AgentDocumentBlock { id : SharedString, revision : u64, kind : AgentBlockKind, label : Option, streaming : bool, body : AgentBlockBody, }", "cfg": [] }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::artifact", "name": "artifact", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn artifact (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::chart", "name": "chart", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn chart (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::choice", "name": "choice", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn choice (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::code", "name": "code", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn code (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::custom", "name": "custom", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn custom (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::diff", "name": "diff", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn diff (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::element", "name": "element", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "A typed block whose existing component owns its presentation.", "documentation": "A typed block whose existing component owns its presentation.\n\nTakes a way to build the element rather than a built one, so the block\ncan be drawn again when the reader scrolls back to it. See\n[`AgentDocument::virtualized`] for why that is not optional.", "signature": "pub fn element (id : impl Into, kind : AgentBlockKind, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn image (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::kind", "name": "kind", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn kind (& self) -> AgentBlockKind", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "A host-authored heading for a non-prose block.", "documentation": "A host-authored heading for a non-prose block.", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::markdown", "name": "markdown", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Safe read-only Markdown under [`Markdown`]'s host-owned link and image policy.", "documentation": "Safe read-only Markdown under [`Markdown`]'s host-owned link and image\npolicy.", "signature": "pub fn markdown (id : impl Into, source : impl Into) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::notice", "name": "notice", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "A host-authored status or warning inside the document.", "documentation": "A host-authored status or warning inside the document.", "signature": "pub fn notice (id : impl Into, message : impl Into, tone : Tone,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::revision", "name": "revision", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "The caller's monotonic version of this block.", "documentation": "The caller's monotonic version of this block.", "signature": "pub fn revision (mut self, revision : u64) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::schema", "name": "schema", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn schema (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::streaming", "name": "streaming", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Marks this block as still arriving without changing what has arrived.", "documentation": "Marks this block as still arriving without changing what has arrived.", "signature": "pub fn streaming (mut self, streaming : bool) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Plain selectable text, with no markup interpreted.", "documentation": "Plain selectable text, with no markup interpreted.", "signature": "pub fn text (id : impl Into, text : impl Into) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentBlock::tool_call", "name": "tool_call", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn tool_call (id : impl Into, build : impl Fn (& mut Window, & mut App) -> AnyElement + 'static,) -> Self", "cfg": [], "target": "AgentDocumentBlock" }, { "id": "gpui_kit::content::agent_document::AgentDocumentEvent", "name": "AgentDocumentEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "An action originating in a typed document block.", "documentation": "An action originating in a typed document block.", "signature": "# [doc = \" An action originating in a typed document block.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum AgentDocumentEvent { Markdown { block : SharedString, event : MarkdownEvent, }, }", "cfg": [] }, { "id": "gpui_kit::content::agent_document::AgentDocumentState", "name": "AgentDocumentState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "What is known about the document as a whole.", "documentation": "What is known about the document as a whole.", "signature": "# [doc = \" What is known about the document as a whole.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum AgentDocumentState { Idle (SharedString), Loading (SharedString), # [default] Ready, Empty (SharedString), Unavailable (SharedString), Failed (SharedString), }", "cfg": [] }, { "id": "gpui_kit::content::agent_document::AgentDocumentState::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & 'static str", "cfg": [], "target": "AgentDocumentState" }, { "id": "gpui_kit::content::agent_document::AgentDocumentWork", "name": "AgentDocumentWork", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::agent_document", "path": "gpui_kit::content::agent_document", "source": "crates/gpui-kit/src/content/agent_document.rs", "summary": "Work performed by a mounted virtual document's retained plans. Input checks are linear comparisons of caller records, not byte scans. Parser totals cover currently retained Markdown blocks. These counters do not include GPUI layout, key-vector copies into List, or wall-clock time.", "documentation": "Work performed by a mounted virtual document's retained plans.\nInput checks are linear comparisons of caller records, not byte scans.\nParser totals cover currently retained Markdown blocks. These counters do\nnot include GPUI layout, key-vector copies into List, or wall-clock time.", "signature": "# [doc = \" Work performed by a mounted virtual document's retained plans.\"] # [doc = \" Input checks are linear comparisons of caller records, not byte scans.\"] # [doc = \" Parser totals cover currently retained Markdown blocks. These counters do\"] # [doc = \" not include GPUI layout, key-vector copies into List, or wall-clock time.\"] # [derive (Debug, Default, Clone, Copy, PartialEq, Eq)] pub struct AgentDocumentWork { pub input_checks : usize, pub planned_rows : usize, pub parser : crate::content::markdown::MarkdownWork, }", "cfg": [] }, { "id": "gpui_kit::content::ansi::AnsiRun", "name": "AnsiRun", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::ansi", "path": "gpui_kit::content::ansi", "source": "crates/gpui-kit/src/content/ansi.rs", "summary": "One coloured run of the stripped text.", "documentation": "One coloured run of the stripped text.", "signature": "# [doc = \" One coloured run of the stripped text.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct AnsiRun { pub range : Range, # [doc = \" An index into [`Theme::terminal_ansi`](gpui_kit_theme::Colors::terminal_ansi), when the run named a colour.\"] pub color : Option, pub bold : bool, }", "cfg": [] }, { "id": "gpui_kit::content::ansi::ansi_color", "name": "ansi_color", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::ansi", "path": "gpui_kit::content::ansi", "source": "crates/gpui-kit/src/content/ansi.rs", "summary": "", "documentation": "", "signature": "pub fn ansi_color (index : u8, theme : & Theme) -> Option", "cfg": [] }, { "id": "gpui_kit::content::ansi::ansi_highlights", "name": "ansi_highlights", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::ansi", "path": "gpui_kit::content::ansi", "source": "crates/gpui-kit/src/content/ansi.rs", "summary": "Highlight styles for the runs [`strip_ansi`] produced, using the theme's sixteen ANSI colours.", "documentation": "Highlight styles for the runs [`strip_ansi`] produced, using the theme's\nsixteen ANSI colours.", "signature": "pub fn ansi_highlights (runs : & [AnsiRun], theme : & Theme) -> Vec<(Range, HighlightStyle)>", "cfg": [] }, { "id": "gpui_kit::content::ansi::strip_ansi", "name": "strip_ansi", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::ansi", "path": "gpui_kit::content::ansi", "source": "crates/gpui-kit/src/content/ansi.rs", "summary": "Strips SGR sequences and returns the readable text plus the runs they coloured.", "documentation": "Strips SGR sequences and returns the readable text plus the runs they\ncoloured.", "signature": "pub fn strip_ansi (raw : & str) -> (SharedString, Vec)", "cfg": [] }, { "id": "gpui_kit::content::browser::BrowserPanel", "name": "BrowserPanel", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "A framed web view: address, controls, and the rectangle a page goes in.", "documentation": "A framed web view: address, controls, and the rectangle a page goes in.", "signature": "# [doc = \" A framed web view: address, controls, and the rectangle a page goes in.\"] # [derive (IntoElement)] pub struct BrowserPanel { ident : Ident, # [doc = \" The address as the host reports it. The panel never edits or completes\"] # [doc = \" it, because what a typed string resolves to is the engine's decision.\"] url : SharedString, # [doc = \" Whether the host supplied an address at all. An empty string and \\\"no\"] # [doc = \" address yet\\\" are different, and only one of them is worth drawing an\"] # [doc = \" empty bar for.\"] url_set : bool, state : ViewportState, # [doc = \" Whether history has anywhere to go. A control with nowhere to go is\"] # [doc = \" disabled, and a disabled control installs no handler.\"] can_go_back : bool, can_go_forward : bool, on_back : Option, on_forward : Option, on_reload : Option, # [doc = \" The host's own painted surface for the page.\"] viewport : Option, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::content::browser::BrowserPanel::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::BrowserPanel::on_back", "name": "on_back", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "Enables the back control and gives it somewhere to go.", "documentation": "Enables the back control and gives it somewhere to go.", "signature": "pub fn on_back (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::BrowserPanel::on_forward", "name": "on_forward", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "", "documentation": "", "signature": "pub fn on_forward (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::BrowserPanel::on_reload", "name": "on_reload", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "", "documentation": "", "signature": "pub fn on_reload (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::BrowserPanel::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : ViewportState) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::BrowserPanel::url", "name": "url", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "", "documentation": "", "signature": "pub fn url (mut self, url : impl Into) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::BrowserPanel::viewport", "name": "viewport", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "The surface the host paints the page onto.", "documentation": "The surface the host paints the page onto.", "signature": "pub fn viewport (mut self, viewport : impl IntoElement) -> Self", "cfg": [], "target": "BrowserPanel" }, { "id": "gpui_kit::content::browser::ViewportState", "name": "ViewportState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "What is behind the panel right now.", "documentation": "What is behind the panel right now.\n\nFive separate answers, kept separate. `Ready` is the only one that shows a\npage, and the four that do not each say a different thing about why.", "signature": "# [doc = \" What is behind the panel right now.\"] # [doc = \"\"] # [doc = \" Five separate answers, kept separate. `Ready` is the only one that shows a\"] # [doc = \" page, and the four that do not each say a different thing about why.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ViewportState { # [doc = \" A page is on its way.\"] Loading, # [doc = \" Navigation completed successfully and returned no page content.\"] Empty, # [doc = \" The host cannot open this address. The reason remains the host's own;\"] # [doc = \" a refusal is not rewritten as an empty page or a failed navigation.\"] Unavailable (SharedString), # [doc = \" Navigation failed, in the host's own words.\"] Error (SharedString), # [doc = \" A page is there and the host is painting it.\"] Ready, }", "cfg": [] }, { "id": "gpui_kit::content::browser::ViewportState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "ViewportState" }, { "id": "gpui_kit::content::browser::ViewportState::value", "name": "value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::browser", "path": "gpui_kit::content::browser", "source": "crates/gpui-kit/src/content/browser.rs", "summary": "What the panel publishes as its value.", "documentation": "What the panel publishes as its value.", "signature": "pub fn value (& self) -> & 'static str", "cfg": [], "target": "ViewportState" }, { "id": "gpui_kit::content::code_view::CodeLine", "name": "CodeLine", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "One line of code, identified by its number.", "documentation": "One line of code, identified by its number.\n\nA line number is a line's business identity in a file: it survives the view\nscrolling, and it is what a diagnostic and a review comment already point\nat. It is not the row's position in whatever slice the caller passed, which\nis why a view of lines 400 to 450 numbers them 400 to 450.", "signature": "# [doc = \" One line of code, identified by its number.\"] # [doc = \"\"] # [doc = \" A line number is a line's business identity in a file: it survives the view\"] # [doc = \" scrolling, and it is what a diagnostic and a review comment already point\"] # [doc = \" at. It is not the row's position in whatever slice the caller passed, which\"] # [doc = \" is why a view of lines 400 to 450 numbers them 400 to 450.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct CodeLine { pub number : usize, pub text : SharedString, pub spans : Vec, pub mark : Option, }", "cfg": [] }, { "id": "gpui_kit::content::code_view::CodeLine::mark", "name": "mark", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "", "documentation": "", "signature": "pub fn mark (mut self, mark : LineMark) -> Self", "cfg": [], "target": "CodeLine" }, { "id": "gpui_kit::content::code_view::CodeLine::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "", "documentation": "", "signature": "pub fn new (number : usize, text : impl Into) -> Self", "cfg": [], "target": "CodeLine" }, { "id": "gpui_kit::content::code_view::CodeLine::spans", "name": "spans", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "Pre-classified runs, in byte offsets into this line's own text.", "documentation": "Pre-classified runs, in byte offsets into this line's own text.", "signature": "pub fn spans (mut self, spans : impl IntoIterator) -> Self", "cfg": [], "target": "CodeLine" }, { "id": "gpui_kit::content::code_view::CodeView", "name": "CodeView", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "Read-only code with a gutter.", "documentation": "Read-only code with a gutter.", "signature": "# [doc = \" Read-only code with a gutter.\"] # [derive (IntoElement)] pub struct CodeView { ident : Ident, lines : Vec, # [doc = \" The fence's info string equivalent, shown exactly as written. Nothing\"] # [doc = \" here parses it.\"] language : Option, line_numbers : bool, visible_lines : Option, copyable : bool, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::content::code_view::CodeView::copyable", "name": "copyable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "Whether the view carries a control that copies the whole text.", "documentation": "Whether the view carries a control that copies the whole text.", "signature": "pub fn copyable (mut self, copyable : bool) -> Self", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::CodeView::from_text", "name": "from_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "Splits plain text into numbered lines starting at 1.", "documentation": "Splits plain text into numbered lines starting at 1.\n\nA convenience over [`CodeView::new`] and nothing more: it classifies\nnothing and marks nothing.", "signature": "pub fn from_text (ident : impl Into, text : & str) -> Self", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::CodeView::language", "name": "language", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "The language's name, shown as written above the code.", "documentation": "The language's name, shown as written above the code.\n\nIt is also the caller's claim about what the code is, so a name\n[`crate::content::highlight`] recognises colours the lines that did not\narrive with spans of their own. A name it does not recognise is shown\nand nothing more.", "signature": "pub fn language (mut self, language : impl Into) -> Self", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::CodeView::line_numbers", "name": "line_numbers", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "", "documentation": "", "signature": "pub fn line_numbers (mut self, line_numbers : bool) -> Self", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::CodeView::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, lines : impl IntoIterator) -> Self", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::CodeView::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "The text a copy would put on the clipboard: every line, in order.", "documentation": "The text a copy would put on the clipboard: every line, in order.", "signature": "pub fn text (& self) -> String", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::CodeView::visible_lines", "name": "visible_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "Bounds the viewport to `lines` rows and virtualizes the body.", "documentation": "Bounds the viewport to `lines` rows and virtualizes the body.\n\nHorizontal scrolling goes with it; see the module documentation.", "signature": "pub fn visible_lines (mut self, lines : usize) -> Self", "cfg": [], "target": "CodeView" }, { "id": "gpui_kit::content::code_view::LineMark", "name": "LineMark", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "What a line is being called out for.", "documentation": "What a line is being called out for.\n\nThese are the host's claims about the code, not judgements this view makes:\nnothing here diffs anything or finds an error.", "signature": "# [doc = \" What a line is being called out for.\"] # [doc = \"\"] # [doc = \" These are the host's claims about the code, not judgements this view makes:\"] # [doc = \" nothing here diffs anything or finds an error.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum LineMark { Added, Removed, Changed, # [doc = \" Called out for attention without saying anything about correctness.\"] Highlighted, Error, }", "cfg": [] }, { "id": "gpui_kit::content::code_view::LineMark::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::code_view", "path": "gpui_kit::content::code_view", "source": "crates/gpui-kit/src/content/code_view.rs", "summary": "The name the semantic tree publishes, so a test tells the five apart without reading a colour.", "documentation": "The name the semantic tree publishes, so a test tells the five apart\nwithout reading a colour.", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "LineMark" }, { "id": "gpui_kit::content::diff_view::DiffCursor", "name": "DiffCursor", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Where the reader is in a diff they are stepping through.", "documentation": "Where the reader is in a diff they are stepping through.\n\nNamed the way the events are, because it is the other half of the same\nconversation: a host that hears [`DiffViewEvent::HunkActivated`] and a host\nthat steps to the next hunk are pointing at the same row.", "signature": "# [doc = \" Where the reader is in a diff they are stepping through.\"] # [doc = \"\"] # [doc = \" Named the way the events are, because it is the other half of the same\"] # [doc = \" conversation: a host that hears [`DiffViewEvent::HunkActivated`] and a host\"] # [doc = \" that steps to the next hunk are pointing at the same row.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum DiffCursor { File { file_id : SharedString, }, Hunk { file_id : SharedString, hunk_id : SharedString, }, Line { file_id : SharedString, hunk_id : SharedString, line_id : SharedString, }, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffFile", "name": "DiffFile", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Clone, PartialEq, Eq)] pub struct DiffFile { pub id : SharedString, pub label : SharedString, pub hunks : Vec, # [doc = \" What is true of the file itself, drawn under its header.\"] pub notes : Vec, # [doc = \" The language this file is written in, when it is not the one the view\"] # [doc = \" named.\"] pub language : Option, # [doc = \" When true the file's header stays and its hunks do not.\"] pub folded : bool, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffFile::folded", "name": "folded", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Puts the whole file away behind its header.", "documentation": "Puts the whole file away behind its header.\n\nA review of forty files is unreadable as forty thousand rows, and the\nhunk-level collapse does not help: it still leaves every file's header\nand every hunk's header on screen. Folding is what makes the top of a\nlarge review a list of files again.\n\nThe header of a folded file says what it is hiding — how many lines\nwere added and removed — because a fold that says only \"there is\nsomething here\" makes the reader open every file to find out which ones\nmatter, which is the thing folding was for.", "signature": "pub fn folded (mut self, folded : bool) -> Self", "cfg": [], "target": "DiffFile" }, { "id": "gpui_kit::content::diff_view::DiffFile::language", "name": "language", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "The language this file is written in.", "documentation": "The language this file is written in.\n\nA review is not written in one language: a change reaches Rust, a\nmanifest and a note in the same patch, and a scanner given the wrong\ngrammar does not merely fail to colour — it colours the wrong things,\nwhich reads as a claim about code that is not true. So the file says\nwhat it is, and [`DiffView::language`] is the answer for the files that\ndo not.", "signature": "pub fn language (mut self, language : impl Into) -> Self", "cfg": [], "target": "DiffFile" }, { "id": "gpui_kit::content::diff_view::DiffFile::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into, hunks : impl IntoIterator,) -> Self", "cfg": [], "target": "DiffFile" }, { "id": "gpui_kit::content::diff_view::DiffFile::notes", "name": "notes", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "What is true of the file rather than of its lines.", "documentation": "What is true of the file rather than of its lines.\n\nA file carries at most one note of each kind, since that is what the\nkinds mean — a file is renamed from one place and ends in one mode —\nand a second note of a kind already present is dropped rather than\ndrawn under the same name as the first.", "signature": "pub fn notes (mut self, notes : impl IntoIterator) -> Self", "cfg": [], "target": "DiffFile" }, { "id": "gpui_kit::content::diff_view::DiffHunk", "name": "DiffHunk", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "One caller-supplied hunk.", "documentation": "One caller-supplied hunk.", "signature": "# [doc = \" One caller-supplied hunk.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct DiffHunk { pub id : SharedString, pub header : SharedString, pub lines : Vec, # [doc = \" When true the hunk header stays and the lines do not, so a host can\"] # [doc = \" offer more context without this view inventing it.\"] pub collapsed : bool, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffHunk::collapsed", "name": "collapsed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn collapsed (mut self, collapsed : bool) -> Self", "cfg": [], "target": "DiffHunk" }, { "id": "gpui_kit::content::diff_view::DiffHunk::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, header : impl Into, lines : impl IntoIterator,) -> Self", "cfg": [], "target": "DiffHunk" }, { "id": "gpui_kit::content::diff_view::DiffLine", "name": "DiffLine", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "One stable, caller-supplied logical diff row.", "documentation": "One stable, caller-supplied logical diff row.\n\nA context row carries the same text on both sides. A pure addition or\nremoval carries one side. A replacement carries both different sides, so\nsplit presentation can align them without this component deciding which\nremoval belongs with which addition.", "signature": "# [doc = \" One stable, caller-supplied logical diff row.\"] # [doc = \"\"] # [doc = \" A context row carries the same text on both sides. A pure addition or\"] # [doc = \" removal carries one side. A replacement carries both different sides, so\"] # [doc = \" split presentation can align them without this component deciding which\"] # [doc = \" removal belongs with which addition.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct DiffLine { pub id : SharedString, old : Option, new : Option, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffLine::added", "name": "added", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "A pure addition supplied by the caller.", "documentation": "A pure addition supplied by the caller.", "signature": "pub fn added (id : impl Into, text : impl Into) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "A context line. The text begins on both sides; old and new numbers are supplied independently.", "documentation": "A context line. The text begins on both sides; old and new numbers are\nsupplied independently.", "signature": "pub fn new (id : impl Into, text : impl Into) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::new_number", "name": "new_number", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn new_number (mut self, number : usize) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::new_spans", "name": "new_spans", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn new_spans (mut self, spans : impl IntoIterator) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::old_number", "name": "old_number", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn old_number (mut self, number : usize) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::old_spans", "name": "old_spans", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn old_spans (mut self, spans : impl IntoIterator) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::paired", "name": "paired", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "An aligned replacement supplied by the caller. Unified presentation draws its removed and added sides as consecutive rows; split presentation draws them opposite one another.", "documentation": "An aligned replacement supplied by the caller. Unified presentation\ndraws its removed and added sides as consecutive rows; split\npresentation draws them opposite one another.", "signature": "pub fn paired (id : impl Into, old : impl Into, new : impl Into,) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::removed", "name": "removed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "A pure removal supplied by the caller.", "documentation": "A pure removal supplied by the caller.", "signature": "pub fn removed (id : impl Into, text : impl Into) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffLine::spans", "name": "spans", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Pre-classified spans for both sides. Use `old_spans` and `new_spans` when an aligned replacement has different classifications.", "documentation": "Pre-classified spans for both sides. Use `old_spans` and `new_spans`\nwhen an aligned replacement has different classifications.", "signature": "pub fn spans (mut self, spans : impl IntoIterator) -> Self", "cfg": [], "target": "DiffLine" }, { "id": "gpui_kit::content::diff_view::DiffNote", "name": "DiffNote", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "One caller-supplied file and its hunks. Something a diff says about a file rather than about its lines.", "documentation": "One caller-supplied file and its hunks.\nSomething a diff says about a file rather than about its lines.\n\nA rename, a mode change or a file that arrived whole are facts no hunk\nstates: they are true of the file, and a reader who only sees added lines\ncannot tell a new file from a large addition to an old one. Each kind is\nnamed rather than free text so this crate can say it in the reader's\nlanguage, and so a host cannot put a path or a message of its own on a row\nthat a diagnostic snapshot reads.", "signature": "# [doc = \" One caller-supplied file and its hunks.\"] # [doc = \" Something a diff says about a file rather than about its lines.\"] # [doc = \"\"] # [doc = \" A rename, a mode change or a file that arrived whole are facts no hunk\"] # [doc = \" states: they are true of the file, and a reader who only sees added lines\"] # [doc = \" cannot tell a new file from a large addition to an old one. Each kind is\"] # [doc = \" named rather than free text so this crate can say it in the reader's\"] # [doc = \" language, and so a host cannot put a path or a message of its own on a row\"] # [doc = \" that a diagnostic snapshot reads.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum DiffNote { # [doc = \" The file did not exist before.\"] Added, # [doc = \" The file does not exist after.\"] Removed, # [doc = \" The file was moved, and this is where it came from.\"] Renamed { from : SharedString }, # [doc = \" The file changed, but not in lines anybody can read.\"] Binary, # [doc = \" The file's permissions changed, and this is what they became.\"] Mode { to : SharedString }, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffPresentation", "name": "DiffPresentation", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "How the same caller-supplied lines are arranged.", "documentation": "How the same caller-supplied lines are arranged.", "signature": "# [doc = \" How the same caller-supplied lines are arranged.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum DiffPresentation { # [default] Unified, Split, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffPresentation::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "DiffPresentation" }, { "id": "gpui_kit::content::diff_view::DiffView", "name": "DiffView", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "A virtualized, read-only diff presentation.", "documentation": "A virtualized, read-only diff presentation.", "signature": "# [doc = \" A virtualized, read-only diff presentation.\"] # [derive (IntoElement)] pub struct DiffView { ident : Ident, files : Source, presentation : DiffPresentation, visible_rows : usize, fills : bool, wrapping : bool, language : Option, cursor : Option, on_event : Option, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::DiffView::cursor", "name": "cursor", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Marks the row the reader has stepped to, and puts it on screen when it moves.", "documentation": "Marks the row the reader has stepped to, and puts it on screen when it\nmoves.\n\nA diff is read by walking it — next change, next file — and a step that\nonly scrolled would leave the reader guessing which of the rows now in\nview is the one they asked for. The row is revealed when the cursor\nchanges and not on every frame, so a reader who then scrolls away with\nthe wheel is not dragged back to it.", "signature": "pub fn cursor (mut self, cursor : DiffCursor) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::fills", "name": "fills", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Takes the height of whatever holds it, instead of a number of rows.", "documentation": "Takes the height of whatever holds it, instead of a number of rows.\n\nA diff drawn in a pane is as tall as the pane, which the reader\nresizes; a row count would be wrong at every size but one.", "signature": "pub fn fills (mut self) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::language", "name": "language", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Colours code that arrived without colours, by the language the caller says it is, for every file that does not name one of its own with [`DiffFile::language`].", "documentation": "Colours code that arrived without colours, by the language the caller\nsays it is, for every file that does not name one of its own with\n[`DiffFile::language`].\n\nA diff of code is code, and reading it uncoloured next to a coloured\neditor is harder than it needs to be. The rule is the same one\n[`CodeView::language`](crate::content::CodeView::language) keeps: a\nline that arrived with spans keeps them, because the caller's grammar\noutranks this scanner, and a language this crate does not know colours\nnothing rather than guessing.\n\nA replacement keeps its word-level spans rather than gaining syntax\ncolour. Saying *which words changed* is the more specific claim on a\nrow that exists because two versions differ, and two claims in one\nplace is one too many.", "signature": "pub fn language (mut self, language : impl Into) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, files : impl IntoIterator) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Reports file, hunk and line actions without changing or applying the diff.", "documentation": "Reports file, hunk and line actions without changing or applying the\ndiff.", "signature": "pub fn on_event (mut self, handler : impl Fn (DiffViewEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::presentation", "name": "presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "", "documentation": "", "signature": "pub fn presentation (mut self, presentation : DiffPresentation) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::shared", "name": "shared", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "The same view over a diff the caller keeps, and rebuilds only when it changes.", "documentation": "The same view over a diff the caller keeps, and rebuilds only when it\nchanges.\n\nFlattening the hierarchy and scanning it for syntax are both linear in\nthe whole diff, and a builder runs on every frame — so on a diff of any\nsize, a view built from an iterator does that work again for every\nanimation frame, every hover, every keystroke elsewhere in the window.\nThe cost is invisible on the ten-line diff a component's own exhibit\nshows and ruinous on a review of a thousand files.\n\nAn [`Arc`] the caller holds on to is a promise this view can check:\nwhile it is the same allocation, nothing in it can have changed, so the\nflattened rows and their colours are still the answer. A caller that\nfolds a file or receives a new patch builds a new one, which is exactly\nwhen the work should be done again.", "signature": "pub fn shared (ident : impl Into, files : Arc>) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::visible_rows", "name": "visible_rows", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Bounds and virtualizes the view to this many fixed-height rows. File and hunk headers each occupy one row too.", "documentation": "Bounds and virtualizes the view to this many fixed-height rows. File\nand hunk headers each occupy one row too.", "signature": "pub fn visible_rows (mut self, rows : usize) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffView::wrapping", "name": "wrapping", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Wraps a line that is too long instead of clipping it.", "documentation": "Wraps a line that is too long instead of clipping it.\n\nFixed rows are what make a large diff cheap: every row's height is\nknown without laying it out, so the list can jump anywhere in a hundred\nthousand rows immediately. The price is that a long line is cut off at\nthe right edge, and in a diff that price is sometimes wrong — a\nminified bundle, a long string literal, a one-line JSON change is a\nline whose *end* is the change, and a diff that hides it is showing\nnothing.\n\nSo this is a choice rather than a default. Rows are then measured as\nthey are laid out, which costs layout for every row the reader passes\nand makes the scrollbar settle rather than being right immediately.", "signature": "pub fn wrapping (mut self, wrapping : bool) -> Self", "cfg": [], "target": "DiffView" }, { "id": "gpui_kit::content::diff_view::DiffViewEvent", "name": "DiffViewEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "An action on caller-owned diff identity.", "documentation": "An action on caller-owned diff identity.", "signature": "# [doc = \" An action on caller-owned diff identity.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum DiffViewEvent { FileActivated { file_id : SharedString, }, HunkActivated { file_id : SharedString, hunk_id : SharedString, }, LineActivated { file_id : SharedString, hunk_id : SharedString, line_id : SharedString, }, # [doc = \" The host should disclose more context around this hunk.\"] ExpandHunk { file_id : SharedString, hunk_id : SharedString, }, # [doc = \" The host should put this file back on screen. Reported instead of\"] # [doc = \" [`DiffViewEvent::FileActivated`] while a file is folded, so a host that\"] # [doc = \" treats a header click as \\\"open this file elsewhere\\\" does not have to\"] # [doc = \" guess which of the two the reader meant.\"] UnfoldFile { file_id : SharedString, }, }", "cfg": [] }, { "id": "gpui_kit::content::diff_view::word_spans", "name": "word_spans", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::diff_view", "path": "gpui_kit::content::diff_view", "source": "crates/gpui-kit/src/content/diff_view.rs", "summary": "Highlights tokens that do not appear in the other side.", "documentation": "Highlights tokens that do not appear in the other side.\n\nThis is not a diff: both strings are complete, and the spans name the\ntokens that have no counterpart. A host that already computed a real\nintra-line diff should pass its own [`CodeSpan`]s instead.", "signature": "pub fn word_spans (old : & str, new : & str) -> (Vec, Vec)", "cfg": [] }, { "id": "gpui_kit::content::highlight::Carry", "name": "Carry", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::highlight", "path": "gpui_kit::content::highlight", "source": "crates/gpui-kit/src/content/highlight.rs", "summary": "What the scanner is in the middle of, carried from one line to the next.", "documentation": "What the scanner is in the middle of, carried from one line to the next.", "signature": "# [doc = \" What the scanner is in the middle of, carried from one line to the next.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum Carry { # [default] None, Comment, # [doc = \" Inside a string, identified by which of the language's string forms\"] # [doc = \" opened it.\"] Text (u8), }", "cfg": [] }, { "id": "gpui_kit::content::highlight::Language", "name": "Language", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::highlight", "path": "gpui_kit::content::highlight", "source": "crates/gpui-kit/src/content/highlight.rs", "summary": "A language this can scan.", "documentation": "A language this can scan.\n\nDeliberately short. Each entry is a table someone has to keep true, and a\nlanguage coloured from a stale table reads worse than one left plain.", "signature": "# [doc = \" A language this can scan.\"] # [doc = \"\"] # [doc = \" Deliberately short. Each entry is a table someone has to keep true, and a\"] # [doc = \" language coloured from a stale table reads worse than one left plain.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum Language { Rust, TypeScript, Python, Go, Json, Shell, Toml, Yaml, Markdown, }", "cfg": [] }, { "id": "gpui_kit::content::highlight::Language::named", "name": "named", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::highlight", "path": "gpui_kit::content::highlight", "source": "crates/gpui-kit/src/content/highlight.rs", "summary": "The language a fence's info string names, when it names one of these.", "documentation": "The language a fence's info string names, when it names one of these.\n\nOnly what was written is read. Guessing a language from the shape of\nthe code would put a claim on the screen that nobody made, and would be\nwrong exactly where code is shortest.", "signature": "pub fn named (tag : & str) -> Option", "cfg": [], "target": "Language" }, { "id": "gpui_kit::content::highlight::line_spans", "name": "line_spans", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::highlight", "path": "gpui_kit::content::highlight", "source": "crates/gpui-kit/src/content/highlight.rs", "summary": "Colours one line, given what the line before it left open.", "documentation": "Colours one line, given what the line before it left open.", "signature": "pub fn line_spans (language : Language, line : & str, carry : Carry) -> (Vec, Carry)", "cfg": [] }, { "id": "gpui_kit::content::highlight::line_spans_of", "name": "line_spans_of", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::highlight", "path": "gpui_kit::content::highlight", "source": "crates/gpui-kit/src/content/highlight.rs", "summary": "Colours a block a line at a time, in byte offsets into each line.", "documentation": "Colours a block a line at a time, in byte offsets into each line.\n\nThis is the shape the scanner works in, and the shape a view that draws one\nelement per line needs.", "signature": "pub fn line_spans_of (language : Language, code : & str) -> Vec>", "cfg": [] }, { "id": "gpui_kit::content::highlight::spans", "name": "spans", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::highlight", "path": "gpui_kit::content::highlight", "source": "crates/gpui-kit/src/content/highlight.rs", "summary": "Colours a whole block, in byte offsets into it.", "documentation": "Colours a whole block, in byte offsets into it.\n\nThe same colouring as [`line_spans_of`], moved onto the block's own\noffsets, because it is derived from it rather than found again — two scans\nthat could disagree about the same code would be one too many.", "signature": "pub fn spans (language : Language, code : & str) -> Vec", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::FitMode", "name": "FitMode", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "How the image is sized inside the frame.", "documentation": "How the image is sized inside the frame.", "signature": "# [doc = \" How the image is sized inside the frame.\"] # [derive (Debug, Clone, Copy, PartialEq, Default)] pub enum FitMode { # [doc = \" The whole image, inside the frame.\"] # [default] Contain, # [doc = \" The whole frame, covered by the image.\"] Cover, # [doc = \" One image pixel per frame pixel.\"] Actual, # [doc = \" The caller's own scale, where one is the actual size.\"] Zoom (f32), }", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::FitMode::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "The name a semantic node publishes, so a test reads the mode rather than the geometry it produced.", "documentation": "The name a semantic node publishes, so a test reads the mode rather\nthan the geometry it produced.", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "FitMode" }, { "id": "gpui_kit::content::image_viewer::ImageFrame", "name": "ImageFrame", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "One image the viewer can show.", "documentation": "One image the viewer can show.", "signature": "# [doc = \" One image the viewer can show.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct ImageFrame { id : SharedString, label : SharedString, source : SharedString, natural : Option, state : ImageState, }", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::ImageFrame::failed", "name": "failed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "The bytes arrived and could not be read, and this is why.", "documentation": "The bytes arrived and could not be read, and this is why.", "signature": "pub fn failed (self, reason : impl Into) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn label (& self) -> & SharedString", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::loading", "name": "loading", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn loading (self) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::natural", "name": "natural", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "The source's own pixel dimensions.", "documentation": "The source's own pixel dimensions.\n\nWithout this the viewer says the size is unknown and refuses to scale,\nbecause a scale nobody can compute is not a scale.", "signature": "pub fn natural (mut self, width : u32, height : u32) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "`id` is the image's own identity, never its place in the list.", "documentation": "`id` is the image's own identity, never its place in the list.", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::source", "name": "source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "Where the image came from, shown whenever it is not on screen.", "documentation": "Where the image came from, shown whenever it is not on screen.", "signature": "pub fn source (mut self, source : impl Into) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : ImageState) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageFrame::unavailable", "name": "unavailable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "The host could not supply this image, and this is why.", "documentation": "The host could not supply this image, and this is why.", "signature": "pub fn unavailable (self, reason : impl Into) -> Self", "cfg": [], "target": "ImageFrame" }, { "id": "gpui_kit::content::image_viewer::ImageRequest", "name": "ImageRequest", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "An image the viewer had to draw and the host has not supplied.", "documentation": "An image the viewer had to draw and the host has not supplied.", "signature": "# [doc = \" An image the viewer had to draw and the host has not supplied.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct ImageRequest { pub id : SharedString, pub label : SharedString, pub source : SharedString, # [doc = \" What the host said the source measures, when it said anything.\"] pub natural : Option, }", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::ImageSize", "name": "ImageSize", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "The pixel size of a source, as the host stated it.", "documentation": "The pixel size of a source, as the host stated it.", "signature": "# [doc = \" The pixel size of a source, as the host stated it.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct ImageSize { pub width : u32, pub height : u32, }", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::ImageSize::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn new (width : u32, height : u32) -> Self", "cfg": [], "target": "ImageSize" }, { "id": "gpui_kit::content::image_viewer::ImageState", "name": "ImageState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "What the host knows about one image right now.", "documentation": "What the host knows about one image right now.\n\nThis is the library's [`crate::state::Loadable`] vocabulary specialized to\na picture: an image the host refused and an image that arrived broken fail\ndifferently and read differently, so they are not one variant.", "signature": "# [doc = \" What the host knows about one image right now.\"] # [doc = \"\"] # [doc = \" This is the library's [`crate::state::Loadable`] vocabulary specialized to\"] # [doc = \" a picture: an image the host refused and an image that arrived broken fail\"] # [doc = \" differently and read differently, so they are not one variant.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum ImageState { # [doc = \" The host is still fetching it.\"] Loading, # [doc = \" The host could not supply it, in its own words.\"] Unavailable (SharedString), # [doc = \" The bytes arrived and could not be read, in the host's words.\"] Failed (SharedString), # [doc = \" The host has it.\"] # [default] Ready, }", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::ImageState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "ImageState" }, { "id": "gpui_kit::content::image_viewer::ImageViewer", "name": "ImageViewer", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "A framed viewer for one image at a time.", "documentation": "A framed viewer for one image at a time.", "signature": "# [doc = \" A framed viewer for one image at a time.\"] # [derive (IntoElement)] pub struct ImageViewer { ident : Ident, frames : Vec, showing : Option, fit : FitMode, min_zoom : f32, max_zoom : f32, height : Option, control_size : ControlSize, disabled : bool, image : Option, on_event : Option, }", "cfg": [] }, { "id": "gpui_kit::content::image_viewer::ImageViewer::fit", "name": "fit", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "How the caller says the image is sized. The viewer draws this and reports every request to change it.", "documentation": "How the caller says the image is sized. The viewer draws this and\nreports every request to change it.", "signature": "pub fn fit (mut self, fit : FitMode) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewer::height", "name": "height", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn height (mut self, height : f32) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewer::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "Supplies the element to draw for an image the host already holds.", "documentation": "Supplies the element to draw for an image the host already holds.\n\nAnswering `None` leaves a placeholder naming the source, so a host that\ncannot supply one has said so rather than left a gap.", "signature": "pub fn image (mut self, supplier : impl Fn (& ImageFrame, & mut Window, & mut App) -> Option + 'static,) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewer::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, frames : impl IntoIterator) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewer::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& ImageViewerEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewer::showing", "name": "showing", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "Which image the caller says is showing. Without one the first is.", "documentation": "Which image the caller says is showing. Without one the first is.", "signature": "pub fn showing (mut self, id : impl Into) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewer::zoom_range", "name": "zoom_range", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "How far in and out the reader may go. Both ends are the caller's judgement: a thumbnail and a scan of a page have different answers.", "documentation": "How far in and out the reader may go. Both ends are the caller's\njudgement: a thumbnail and a scan of a page have different answers.", "signature": "pub fn zoom_range (mut self, min : f32, max : f32) -> Self", "cfg": [], "target": "ImageViewer" }, { "id": "gpui_kit::content::image_viewer::ImageViewerEvent", "name": "ImageViewerEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::image_viewer", "path": "gpui_kit::content::image_viewer", "source": "crates/gpui-kit/src/content/image_viewer.rs", "summary": "What a viewer reports. It applies none of it.", "documentation": "What a viewer reports. It applies none of it.", "signature": "# [doc = \" What a viewer reports. It applies none of it.\"] # [derive (Debug, Clone, PartialEq)] pub enum ImageViewerEvent { # [doc = \" The reader asked for a different fit, by a control, the wheel, or a\"] # [doc = \" key. The viewer draws whatever the caller says is showing.\"] FitChanged (FitMode), # [doc = \" The reader asked for another image, by its own id.\"] Stepped { id : SharedString }, # [doc = \" An image the host has not supplied was drawn as a placeholder.\"] # [doc = \"\"] # [doc = \" Reported once per image per viewer rather than once per frame, so a\"] # [doc = \" host that answers by supplying it is not asked again for answering.\"] ImageRequested (ImageRequest), }", "cfg": [] }, { "id": "gpui_kit::content::log_stream::LogEntry", "name": "LogEntry", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "One caller-owned log entry.", "documentation": "One caller-owned log entry.", "signature": "# [doc = \" One caller-owned log entry.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct LogEntry { pub id : SharedString, pub timestamp : SharedString, pub level : SharedString, pub source : SharedString, pub message : SharedString, pub tone : Tone, pub search_hits : Vec>, pub current_hit : Option, compiled : Option<(SharedString, Vec)>, }", "cfg": [] }, { "id": "gpui_kit::content::log_stream::LogEntry::current_hit", "name": "current_hit", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Which supplied search hit is current.", "documentation": "Which supplied search hit is current.", "signature": "pub fn current_hit (mut self, hit : usize) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogEntry::level", "name": "level", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "The caller's level name and the semantic tone it should carry.", "documentation": "The caller's level name and the semantic tone it should carry.", "signature": "pub fn level (mut self, level : impl Into, tone : Tone) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogEntry::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, message : impl Into) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogEntry::prepare_ansi", "name": "prepare_ansi", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Strips ANSI once so a virtualized row does not parse the same line again on every scroll.", "documentation": "Strips ANSI once so a virtualized row does not parse the same line\nagain on every scroll.", "signature": "pub fn prepare_ansi (mut self) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogEntry::search_hits", "name": "search_hits", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Search hits as sorted, non-overlapping UTF-8 byte ranges into [`LogEntry::message`]. Invalid ranges are skipped by `HighlightedText`.", "documentation": "Search hits as sorted, non-overlapping UTF-8 byte ranges into\n[`LogEntry::message`]. Invalid ranges are skipped by `HighlightedText`.", "signature": "pub fn search_hits (mut self, hits : impl IntoIterator>) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogEntry::source", "name": "source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "The caller's source name. Nothing here interprets it.", "documentation": "The caller's source name. Nothing here interprets it.", "signature": "pub fn source (mut self, source : impl Into) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogEntry::timestamp", "name": "timestamp", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "A timestamp the caller already formatted.", "documentation": "A timestamp the caller already formatted.", "signature": "pub fn timestamp (mut self, timestamp : impl Into) -> Self", "cfg": [], "target": "LogEntry" }, { "id": "gpui_kit::content::log_stream::LogStream", "name": "LogStream", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "A virtualized, read-only log presentation.", "documentation": "A virtualized, read-only log presentation.", "signature": "# [doc = \" A virtualized, read-only log presentation.\"] # [derive (IntoElement)] pub struct LogStream { ident : Ident, entries : Vec, state : LogStreamState, visible_rows : usize, selected : Option, on_select : Option, on_copy : Option, ansi : bool, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::content::log_stream::LogStream::ansi", "name": "ansi", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Treats each message as ANSI-coloured text. Search hits still win.", "documentation": "Treats each message as ANSI-coloured text. Search hits still win.", "signature": "pub fn ansi (mut self, ansi : bool) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStream::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, entries : impl IntoIterator) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStream::on_copy", "name": "on_copy", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Reports that the selected entry should be copied. The host decides what representation belongs on the clipboard.", "documentation": "Reports that the selected entry should be copied. The host decides what\nrepresentation belongs on the clipboard.", "signature": "pub fn on_copy (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStream::on_select", "name": "on_select", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Reports an entry selection and changes no data.", "documentation": "Reports an entry selection and changes no data.", "signature": "pub fn on_select (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStream::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "The caller-owned selected entry.", "documentation": "The caller-owned selected entry.", "signature": "pub fn selected (mut self, id : impl Into) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStream::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : LogStreamState) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStream::visible_rows", "name": "visible_rows", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "Bounds and virtualizes the stream to this many fixed-height entries.", "documentation": "Bounds and virtualizes the stream to this many fixed-height entries.", "signature": "pub fn visible_rows (mut self, rows : usize) -> Self", "cfg": [], "target": "LogStream" }, { "id": "gpui_kit::content::log_stream::LogStreamState", "name": "LogStreamState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "What is known about the stream as a whole.", "documentation": "What is known about the stream as a whole.", "signature": "# [doc = \" What is known about the stream as a whole.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum LogStreamState { Loading, Empty, Unavailable (SharedString), Error (SharedString), # [doc = \" Entries are the last verified value; the text says why they are stale.\"] Stale (SharedString), # [default] Ready, }", "cfg": [] }, { "id": "gpui_kit::content::log_stream::LogStreamState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::log_stream", "path": "gpui_kit::content::log_stream", "source": "crates/gpui-kit/src/content/log_stream.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "LogStreamState" }, { "id": "gpui_kit::content::markdown::CodeBlock", "name": "CodeBlock", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "A fenced block, as handed to a host that colours code.", "documentation": "A fenced block, as handed to a host that colours code.", "signature": "# [doc = \" A fenced block, as handed to a host that colours code.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct CodeBlock { # [doc = \" The fence's info string, exactly as written. Nothing here parses it.\"] pub language : Option, pub text : SharedString, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::CodeSpan", "name": "CodeSpan", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "One coloured run of a code block, in byte offsets into its text.", "documentation": "One coloured run of a code block, in byte offsets into its text.\n\nThe role is a syntax class, not a general tone, so the same span means the\nsame thing whether [`crate::content::highlight`] found it or a host with a\nreal grammar did, and both land on the theme's syntax colours rather than\non whatever the caller thought a keyword should look like.", "signature": "# [doc = \" One coloured run of a code block, in byte offsets into its text.\"] # [doc = \"\"] # [doc = \" The role is a syntax class, not a general tone, so the same span means the\"] # [doc = \" same thing whether [`crate::content::highlight`] found it or a host with a\"] # [doc = \" real grammar did, and both land on the theme's syntax colours rather than\"] # [doc = \" on whatever the caller thought a keyword should look like.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct CodeSpan { pub range : Range, pub role : SyntaxColor, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::ImageRequest", "name": "ImageRequest", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "An image the document referred to and this crate did not fetch.", "documentation": "An image the document referred to and this crate did not fetch.", "signature": "# [doc = \" An image the document referred to and this crate did not fetch.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct ImageRequest { pub src : SharedString, pub alt : SharedString, pub title : Option, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::Markdown", "name": "Markdown", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "A rendered Markdown document.", "documentation": "A rendered Markdown document.", "signature": "# [doc = \" A rendered Markdown document.\"] # [derive (IntoElement)] pub struct Markdown { ident : Ident, source : SharedString, parsed : Option>, parsed_tail : Option>, parsed_starts : Option>>, pending : bool, block_renderer : Option, max_lines : Option, # [doc = \" The first reading-order value this document may claim when it is\"] # [doc = \" embedded in a larger document.\"] selection_order_start : u64, on_event : Option, image : Option, highlighter : Option, code_presentation : MarkdownCodePresentation, streaming : bool, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::Markdown::block_renderer", "name": "block_renderer", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Installs a trusted native renderer for top-level parsed blocks. `None` keeps the safe built-in rendering. The identity and reading-order start are supplied so custom content can join document selection. Only mounted blocks invoke the callback; it must be repeatable and must not treat document text as executable HTML or application configuration.", "documentation": "Installs a trusted native renderer for top-level parsed blocks.\n`None` keeps the safe built-in rendering. The identity and reading-order\nstart are supplied so custom content can join document selection.\nOnly mounted blocks invoke the callback; it must be repeatable and must\nnot treat document text as executable HTML or application configuration.", "signature": "pub fn block_renderer (mut self, renderer : impl Fn (& Ident, & Block, u64, & mut Window, & mut App) -> Option + 'static,) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::code_presentation", "name": "code_presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Chooses how fenced code blocks are presented inside this document.", "documentation": "Chooses how fenced code blocks are presented inside this document.\n\nThe default is [`MarkdownCodePresentation::Flat`]. Card presentation\nchanges only the fence's container treatment; its header, Copy action,\nhighlighting, selection, line count, and overflow behavior are the\nsame as the default presentation.", "signature": "pub fn code_presentation (mut self, presentation : MarkdownCodePresentation) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::highlight", "name": "highlight", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Colours code blocks from spans the host computed.", "documentation": "Colours code blocks from spans the host computed.\n\nA fence whose info string names a language\n[`crate::content::highlight`] knows is coloured without this. Install a\nhighlighter to override that with a real grammar's judgement, or to\nreach a language the built-in scanner has no table for.", "signature": "pub fn highlight (mut self, highlighter : impl Fn (& CodeBlock) -> Vec + 'static,) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::image", "name": "image", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Supplies the element to draw for an image the host already holds.", "documentation": "Supplies the element to draw for an image the host already holds.\n\nAnswering `None` leaves the placeholder, which names the source, so a\nhost that cannot supply one has said so rather than left a gap.", "signature": "pub fn image (mut self, source : impl Fn (& ImageRequest, & mut Window, & mut App) -> Option + 'static,) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::max_lines", "name": "max_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Shows at most `lines` of the document's own structure, and says how many were left out.", "documentation": "Shows at most `lines` of the document's own structure, and says how\nmany were left out.\n\nA line is a heading, a paragraph, one line of a code fence, one list\nentry, or one table row — not a line of wrapped text, whose count only\nlayout knows.", "signature": "pub fn max_lines (mut self, lines : usize) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, source : impl Into) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& MarkdownEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::selection_order_start", "name": "selection_order_start", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Places this document inside a caller-owned reading-order partition.", "documentation": "Places this document inside a caller-owned reading-order partition.\n\nA window's document selection joins what it selected in reading order,\nand a document that draws its own runs from zero claims the same order\nas every other one. That is invisible while a Markdown is a whole\nsurface, and wrong the moment a caller draws several of them — one per\nmessage, or one per block of a long answer split across rows — because\na drag over three of them would then read them back interleaved.\n\nGive each document a start far enough apart that its own runs cannot\nreach the next one's: the count is emissions, so a stride per document\nbounds how many selectable runs one document may contain.", "signature": "pub fn selection_order_start (mut self, order : u64) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::Markdown::streaming", "name": "streaming", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "Reads this document as one that is still being written.", "documentation": "Reads this document as one that is still being written.\n\nThree things change. The source is reparsed from the last block that\ncould still be affected rather than from the beginning, so a long reply\ndoes not get slower as it gets longer. Inline markers that have opened\nand not yet closed are read as though they had, so a paragraph does not\ntwitch every time a `**` finishes. And text that has just arrived fades\nin over a fraction of a second, so a fast stream reads as a soft\nleading edge instead of a stutter.\n\nNone of it delays anything: every character is laid out the frame it\narrives, at the position it will keep.", "signature": "pub fn streaming (mut self, streaming : bool) -> Self", "cfg": [], "target": "Markdown" }, { "id": "gpui_kit::content::markdown::MarkdownCodePresentation", "name": "MarkdownCodePresentation", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "How fenced code blocks are presented inside a Markdown document.", "documentation": "How fenced code blocks are presented inside a Markdown document.", "signature": "# [doc = \" How fenced code blocks are presented inside a Markdown document.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum MarkdownCodePresentation { # [doc = \" A raised card that separates code from the surrounding document.\"] Card, # [doc = \" An inline block without a raised surface, elevation, or card frame.\"] # [default] Flat, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::MarkdownEvent", "name": "MarkdownEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "What a rendered document reports. It applies none of it.", "documentation": "What a rendered document reports. It applies none of it.", "signature": "# [doc = \" What a rendered document reports. It applies none of it.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum MarkdownEvent { # [doc = \" A link was taken. The crate opens nothing.\"] LinkClicked { href : SharedString }, # [doc = \" An image the host has not supplied was drawn as a placeholder.\"] # [doc = \"\"] # [doc = \" Reported once per source per rendered document, not once per frame, so\"] # [doc = \" a host may answer it by supplying the image without the answer\"] # [doc = \" provoking another request.\"] ImageRequested { src : SharedString, alt : SharedString, }, # [doc = \" A code block's exact text was put on the clipboard.\"] CodeCopied { language : Option, text : SharedString, }, # [doc = \" The owner's clipboard policy refused the code-copy operation.\"] # [doc = \" A refusal contains no copied payload and is never a success event.\"] CodeCopyRefused { language : Option, reason : gpui::ClipboardDenied, }, # [doc = \" The reader asked for the lines [`Markdown::max_lines`] left out.\"] MoreRequested { lines : usize }, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Align", "name": "Align", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "GFM column alignment.", "documentation": "GFM column alignment.", "signature": "# [doc = \" GFM column alignment.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum Align { # [default] Left, Center, Right, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Block", "name": "Block", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "One block, and how deeply it is nested.", "documentation": "One block, and how deeply it is nested.\n\n`indent` obeys one invariant, established by the parser and relied on by\nthe serializer: the first block is at 0, and no block is more than one\nlevel deeper than the block before it. A document that satisfies it always\nserializes to markdown that parses back to the same indents.", "signature": "# [doc = \" One block, and how deeply it is nested.\"] # [doc = \"\"] # [doc = \" `indent` obeys one invariant, established by the parser and relied on by\"] # [doc = \" the serializer: the first block is at 0, and no block is more than one\"] # [doc = \" level deeper than the block before it. A document that satisfies it always\"] # [doc = \" serializes to markdown that parses back to the same indents.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct Block { pub kind : BlockKind, pub indent : u8, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Block::at", "name": "at", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "pub fn at (kind : BlockKind, indent : u8) -> Self", "cfg": [], "target": "Block" }, { "id": "gpui_kit::content::markdown::doc::Block::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "pub fn new (kind : BlockKind) -> Self", "cfg": [], "target": "Block" }, { "id": "gpui_kit::content::markdown::doc::Block::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "The block's editable inline content, if it has any. `None` for the blocks an editor treats as atomic (code, images, rules) and for tables, whose cells are edited individually.", "documentation": "The block's editable inline content, if it has any. `None` for the\nblocks an editor treats as atomic (code, images, rules) and for tables,\nwhose cells are edited individually.", "signature": "pub fn text (& self) -> Option<& Text>", "cfg": [], "target": "Block" }, { "id": "gpui_kit::content::markdown::doc::BlockKind", "name": "BlockKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "The block vocabulary. Closed by design — it is exactly what a block editor's insert menu offers, and a consumer that needs a block of its own is a reason to widen this enum rather than to grow an extension system.", "documentation": "The block vocabulary. Closed by design — it is exactly what a block\neditor's insert menu offers, and a consumer that needs a block of its own is\na reason to widen this enum rather than to grow an extension system.", "signature": "# [doc = \" The block vocabulary. Closed by design — it is exactly what a block\"] # [doc = \" editor's insert menu offers, and a consumer that needs a block of its own is\"] # [doc = \" a reason to widen this enum rather than to grow an extension system.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum BlockKind { Paragraph (Text), Heading { # [doc = \" 1–6.\"] level : u8, text : Text, }, Bullet (Text), Ordered { # [doc = \" The rendered number. Stored rather than derived so a list starting\"] # [doc = \" at 3 survives the round trip.\"] number : u64, text : Text, }, Task { checked : bool, text : Text, }, Quote (Text), Code { language : Option, code : String, }, Image { url : String, alt : String, }, Table { align : Vec, header : Vec, rows : Vec>, }, Rule, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Doc", "name": "Doc", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "A markdown document: blocks in document order.", "documentation": "A markdown document: blocks in document order.", "signature": "# [doc = \" A markdown document: blocks in document order.\"] # [derive (Debug, Clone, Default, PartialEq, Eq)] pub struct Doc { pub blocks : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Mark", "name": "Mark", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Clone, PartialEq, Eq)] pub enum Mark { Bold, Italic, Strike, Code, Link (String), # [doc = \" An image among text. [`BlockKind::Image`] is the shape an editor offers;\"] # [doc = \" this is what keeps `see ![x](u) here` from silently becoming a link when\"] # [doc = \" the document is saved.\"] Image (String), }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::MarkSpan", "name": "MarkSpan", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Clone, PartialEq, Eq)] pub struct MarkSpan { pub range : Range, pub mark : Mark, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Text", "name": "Text", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "Inline content: a string, plus marks over byte ranges of it.", "documentation": "Inline content: a string, plus marks over byte ranges of it.\n\nMarks are a separate list rather than flags on a run because an editor has\nto *map* them through insertions and deletions, and because run flags lose\nnesting order — under flags `**_x_**` and `_**x**_` are the same value.\nHere they differ by the order of the two spans, and both survive a round\ntrip.\n\nA newline in `text` is a line break within the block (markdown's soft or\nhard break, which this model does not distinguish). Whether it paints as a\nbreak or a space is a rendering decision.", "signature": "# [doc = \" Inline content: a string, plus marks over byte ranges of it.\"] # [doc = \"\"] # [doc = \" Marks are a separate list rather than flags on a run because an editor has\"] # [doc = \" to *map* them through insertions and deletions, and because run flags lose\"] # [doc = \" nesting order — under flags `**_x_**` and `_**x**_` are the same value.\"] # [doc = \" Here they differ by the order of the two spans, and both survive a round\"] # [doc = \" trip.\"] # [doc = \"\"] # [doc = \" A newline in `text` is a line break within the block (markdown's soft or\"] # [doc = \" hard break, which this model does not distinguish). Whether it paints as a\"] # [doc = \" break or a space is a rendering decision.\"] # [derive (Debug, Clone, Default, PartialEq, Eq)] pub struct Text { pub text : String, # [doc = \" Outermost first. Ranges may overlap and may be identical.\"] pub marks : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::Text::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::Text::plain", "name": "plain", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "Unmarked text.", "documentation": "Unmarked text.", "signature": "pub fn plain (text : impl Into) -> Self", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor", "name": "Cursor", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "A caret: which block, and how far into its text.", "documentation": "A caret: which block, and how far into its text.\n\nByte offsets, like the marks — and like them, always on a character\nboundary. It lives here rather than on the editing surface because a\nposition in a document is part of the document model: the pure half can move\nit, which is what makes the motion testable without a window.", "signature": "# [doc = \" A caret: which block, and how far into its text.\"] # [doc = \"\"] # [doc = \" Byte offsets, like the marks — and like them, always on a character\"] # [doc = \" boundary. It lives here rather than on the editing surface because a\"] # [doc = \" position in a document is part of the document model: the pure half can move\"] # [doc = \" it, which is what makes the motion testable without a window.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub struct Cursor { pub block : usize, pub offset : usize, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::clamp", "name": "clamp", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Pull the caret back onto a real position: a block that exists, an offset inside it, and a character boundary.", "documentation": "Pull the caret back onto a real position: a block that exists, an offset\ninside it, and a character boundary.", "signature": "pub fn clamp (self, doc : & Doc) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::down", "name": "down", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "The block below, keeping the offset where it fits.", "documentation": "The block below, keeping the offset where it fits.", "signature": "pub fn down (self, doc : & Doc) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::end", "name": "end", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "", "documentation": "", "signature": "pub fn end (self, doc : & Doc) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::home", "name": "home", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "", "documentation": "", "signature": "pub fn home (self) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::left", "name": "left", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "One character left, stepping into the block above at the start of a line.", "documentation": "One character left, stepping into the block above at the start of a line.", "signature": "pub fn left (self, doc : & Doc) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "", "documentation": "", "signature": "pub fn new (block : usize, offset : usize) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::right", "name": "right", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "One character right, stepping into the block below at the end of a line.", "documentation": "One character right, stepping into the block below at the end of a line.", "signature": "pub fn right (self, doc : & Doc) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Cursor::up", "name": "up", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "The block above, keeping the offset where it fits.", "documentation": "The block above, keeping the offset where it fits.", "signature": "pub fn up (self, doc : & Doc) -> Self", "cfg": [], "target": "Cursor" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::ceiling", "name": "ceiling", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "How deep block `ix` is allowed to sit.", "documentation": "How deep block `ix` is allowed to sit.\n\nMarkdown expresses nesting through list items and nothing else, so a\nblock may only go deeper than the one above it when that one is a\nmarker. Indenting a paragraph under a *heading* would serialize to four\nleading spaces, which reads back as an indented code block.", "signature": "pub fn ceiling (& self, ix : usize) -> u8", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::edit_text", "name": "edit_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Apply an edit to block `ix`'s text, then put the block back in order.", "documentation": "Apply an edit to block `ix`'s text, then put the block back in order.\n\nThe editor should reach text through here rather than mutating a block\ndirectly: a heading that acquires a newline has no ATX spelling, and\nnothing else is positioned to notice.", "signature": "pub fn edit_text (& mut self, ix : usize, edit : impl FnOnce (& mut Text))", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::indent", "name": "indent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Tab. A block can go one level deeper than the one above it, and its children come with it.", "documentation": "Tab. A block can go one level deeper than the one above it, and its\nchildren come with it.", "signature": "pub fn indent (& mut self, ix : usize) -> bool", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::merge_back", "name": "merge_back", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Backspace at the start of block `ix`.", "documentation": "Backspace at the start of block `ix`.\n\nThe chain, in order: an indented block outdents, a list item becomes a\nparagraph, and only a plain block at the left margin merges into the one\nabove it. Returns the caret's new byte offset in whichever block now\nholds it, and `None` when nothing moved.", "signature": "pub fn merge_back (& mut self, ix : usize) -> Option", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::normalize", "name": "normalize", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Put the document into the form markdown can hold — the save step.", "documentation": "Put the document into the form markdown can hold — the save step.\n\nDrops the whitespace markdown discards anyway (leading and trailing on\nevery line, blank lines at a block's edges), flattens the blocks whose\noutput is one line, and renumbers ordered runs. After this,\n`parse(serialize(doc)) == doc`.", "signature": "pub fn normalize (& mut self)", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::outdent", "name": "outdent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Shift-Tab, children included.", "documentation": "Shift-Tab, children included.", "signature": "pub fn outdent (& mut self, ix : usize) -> bool", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::repair", "name": "repair", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Clamp every indent to what the document can actually express, then make ordered runs consecutive. Cheap, total, and called after anything structural — a local rule is not enough, because outdenting one block can leave the block *after* it stranded a level too deep.", "documentation": "Clamp every indent to what the document can actually express, then make\nordered runs consecutive. Cheap, total, and called after anything\nstructural — a local rule is not enough, because outdenting one block\ncan leave the block *after* it stranded a level too deep.\n\nPublic because an editor that changes a block's *kind* has to restore\nthe invariant too, and only this knows what it is.", "signature": "pub fn repair (& mut self)", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Doc::split", "name": "split", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Split block `ix` at byte offset `at`, returning the new block's index.", "documentation": "Split block `ix` at byte offset `at`, returning the new block's index.\n\nThe tail keeps the block's kind so Enter in a list makes another item —\nexcept for a heading, where the body that follows a title is body text.", "signature": "pub fn split (& mut self, ix : usize, at : usize) -> usize", "cfg": [], "target": "Doc" }, { "id": "gpui_kit::content::markdown::doc::edit::Shortcut", "name": "Shortcut", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "A markdown prefix typed at the start of a block, and what it turns it into.", "documentation": "A markdown prefix typed at the start of a block, and what it turns it into.", "signature": "# [doc = \" A markdown prefix typed at the start of a block, and what it turns it into.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum Shortcut { Heading (u8), Bullet, Ordered, Task (bool), Quote, Code, Rule, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::edit::Shortcut::apply", "name": "apply", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "The block this shortcut makes, carrying whatever text was left over.", "documentation": "The block this shortcut makes, carrying whatever text was left over.", "signature": "pub fn apply (self, text : Text) -> BlockKind", "cfg": [], "target": "Shortcut" }, { "id": "gpui_kit::content::markdown::doc::edit::Text::append", "name": "append", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Append `other`, shifting its marks onto the end of this text.", "documentation": "Append `other`, shifting its marks onto the end of this text.", "signature": "pub fn append (& mut self, other : Text)", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::Text::covered_by", "name": "covered_by", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Whether every byte of `range` already carries `mark`.", "documentation": "Whether every byte of `range` already carries `mark`.", "signature": "pub fn covered_by (& self, range : & Range, mark : & Mark) -> bool", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::Text::insert", "name": "insert", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Insert at a byte offset, moving the marks with it.", "documentation": "Insert at a byte offset, moving the marks with it.", "signature": "pub fn insert (& mut self, at : usize, s : & str)", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::Text::remove", "name": "remove", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Remove a byte range, collapsing any mark that covered it.", "documentation": "Remove a byte range, collapsing any mark that covered it.", "signature": "pub fn remove (& mut self, range : Range)", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::Text::split_off", "name": "split_off", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Cut at `at`, returning the tail. The head keeps this [`Text`].", "documentation": "Cut at `at`, returning the tail. The head keeps this [`Text`].", "signature": "pub fn split_off (& mut self, at : usize) -> Text", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::Text::toggle", "name": "toggle", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Add `mark` over `range`, or take it away if the whole range has it.", "documentation": "Add `mark` over `range`, or take it away if the whole range has it.", "signature": "pub fn toggle (& mut self, range : Range, mark : Mark)", "cfg": [], "target": "Text" }, { "id": "gpui_kit::content::markdown::doc::edit::shortcut", "name": "shortcut", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::edit", "path": "gpui_kit::content::markdown::doc::edit", "source": "crates/gpui-kit/src/content/markdown/doc/edit.rs", "summary": "Match a markdown prefix at the start of a block, returning it and how many bytes it occupied.", "documentation": "Match a markdown prefix at the start of a block, returning it and how many\nbytes it occupied.\n\nThis is the input side of the same vocabulary [`super::read`] reads: typing\n`## ` makes a heading because pasting `## ` would have. Order matters — a\ntask marker is a bullet with more on the end.", "signature": "pub fn shortcut (text : & str) -> Option<(Shortcut, usize)>", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::read::parse", "name": "parse", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::read", "path": "gpui_kit::content::markdown::doc::read", "source": "crates/gpui-kit/src/content/markdown/doc/read.rs", "summary": "Parse a markdown document.", "documentation": "Parse a markdown document.", "signature": "pub fn parse (source : & str) -> Doc", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::reexport-1", "name": "edit :: { Cursor , Shortcut , shortcut }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "pub use edit::{ Cursor, Shortcut, shortcut };", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::reexport-2", "name": "read :: parse", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "pub use read::parse;", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::reexport-3", "name": "write :: serialize", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc", "path": "gpui_kit::content::markdown::doc", "source": "crates/gpui-kit/src/content/markdown/doc.rs", "summary": "", "documentation": "", "signature": "pub use write::serialize;", "cfg": [] }, { "id": "gpui_kit::content::markdown::doc::write::serialize", "name": "serialize", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::doc::write", "path": "gpui_kit::content::markdown::doc::write", "source": "crates/gpui-kit/src/content/markdown/doc/write.rs", "summary": "", "documentation": "", "signature": "pub fn serialize (doc : & Doc) -> String", "cfg": [] }, { "id": "gpui_kit::content::markdown::parse::Block", "name": "Block", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "One block of a document.", "documentation": "One block of a document.", "signature": "# [doc = \" One block of a document.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum Block { # [doc = \" Leading YAML (`---`) or TOML (`+++`) metadata, retained verbatim.\"] # [doc = \" Parsing metadata into application configuration is always host policy.\"] Frontmatter { format : SharedString, text : SharedString, }, Heading { level : u8, content : Vec, }, Paragraph (Vec), Code { # [doc = \" The fence's info string, exactly as it was written.\"] language : Option, text : SharedString, }, Quote (Vec), List { ordered : bool, start : u64, entries : Vec, }, Rule, Table { alignment : Vec, head : Vec>, rows : Vec>>, }, # [doc = \" An HTML block, kept verbatim and never interpreted.\"] Html (SharedString), }", "cfg": [] }, { "id": "gpui_kit::content::markdown::parse::Block::lines", "name": "lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "How many lines this block occupies, counted the way truncation counts.", "documentation": "How many lines this block occupies, counted the way truncation counts.\n\nA line here is a line of the document's own structure — a heading, a\nparagraph, one line of a code fence, one list entry — not a line of\nwrapped text, whose count only layout knows.", "signature": "pub fn lines (& self) -> usize", "cfg": [], "target": "Block" }, { "id": "gpui_kit::content::markdown::parse::CellAlign", "name": "CellAlign", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "Which way a table column's cells are set.", "documentation": "Which way a table column's cells are set.", "signature": "# [doc = \" Which way a table column's cells are set.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum CellAlign { # [default] Start, Center, End, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::parse::Document", "name": "Document", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "A parsed document.", "documentation": "A parsed document.", "signature": "# [doc = \" A parsed document.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub struct Document { pub blocks : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::parse::Document::block_ranges", "name": "block_ranges", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "The source ranges of the top-level blocks of `source`, or `None` when the offsets cannot be trusted to describe the blocks this parses to.", "documentation": "The source ranges of the top-level blocks of `source`, or `None` when\nthe offsets cannot be trusted to describe the blocks this parses to.\n\nA surface that draws a long answer as scrollable rows needs a place to\ncut it. Cutting by lines would put a fence's opening and closing halves\nin different rows; cutting by rendered blocks would mean holding a\nparsed tree per row and reparsing all of it whenever the answer grows.\nA range is neither: the row holds the slice of source it is responsible\nfor, renders it as its own document, and a row whose slice did not\nchange has nothing to do when the next token arrives.\n\n`None` is the honest answer for a source whose boundaries this reader\ncannot vouch for — a container it flattens, an extension that arrives\nas bare events. A caller that gets it draws the whole source as one row\nrather than cutting it somewhere that might not be a boundary.", "signature": "pub fn block_ranges (source : & str) -> Option>>", "cfg": [], "target": "Document" }, { "id": "gpui_kit::content::markdown::parse::Document::lines", "name": "lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "", "documentation": "", "signature": "pub fn lines (& self) -> usize", "cfg": [], "target": "Document" }, { "id": "gpui_kit::content::markdown::parse::Document::parse", "name": "parse", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "Parses `source` with tables, strikethrough, task lists, and leading YAML/TOML metadata blocks enabled.", "documentation": "Parses `source` with tables, strikethrough, task lists, and leading\nYAML/TOML metadata blocks enabled.\n\nNothing else is enabled: footnotes, smart punctuation, and math would\neach change what a plain document means, and a reader who wrote three\ndots did not ask for an ellipsis.", "signature": "pub fn parse (source : & str) -> Self", "cfg": [], "target": "Document" }, { "id": "gpui_kit::content::markdown::parse::Document::truncate", "name": "truncate", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "The first `max` lines, and how many lines were left behind.", "documentation": "The first `max` lines, and how many lines were left behind.\n\nThe count is the point. A document cut to fit says how much was cut, so\na reader knows there is more rather than having to notice a fade.", "signature": "pub fn truncate (& self, max : usize) -> (Self, usize)", "cfg": [], "target": "Document" }, { "id": "gpui_kit::content::markdown::parse::Inline", "name": "Inline", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "A run of content inside one line of prose.", "documentation": "A run of content inside one line of prose.", "signature": "# [doc = \" A run of content inside one line of prose.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum Inline { Text (SharedString), # [doc = \" Backticked text, set in the mono face and never highlighted.\"] Code (SharedString), Emphasis (Vec), Strong (Vec), Struck (Vec), Link { href : SharedString, title : Option, content : Vec, }, Image { src : SharedString, alt : SharedString, title : Option, }, # [doc = \" HTML written inside a line, kept verbatim and never interpreted.\"] Html (SharedString), SoftBreak, HardBreak, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::parse::ListEntry", "name": "ListEntry", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::parse", "path": "gpui_kit::content::markdown::parse", "source": "crates/gpui-kit/src/content/markdown/parse.rs", "summary": "One entry of a bulleted or numbered list.", "documentation": "One entry of a bulleted or numbered list.", "signature": "# [doc = \" One entry of a bulleted or numbered list.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub struct ListEntry { # [doc = \" `Some` when the entry carried a task marker, and whether it was ticked.\"] pub task : Option, pub blocks : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::reexport-1", "name": "parse :: { Block , CellAlign , Document , Inline , ListEntry }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "", "documentation": "", "signature": "pub use parse::{ Block, CellAlign, Document, Inline, ListEntry };", "cfg": [] }, { "id": "gpui_kit::content::markdown::reexport-2", "name": "stream :: { MarkdownStream , MarkdownWork }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown", "path": "gpui_kit::content::markdown", "source": "crates/gpui-kit/src/content/markdown.rs", "summary": "", "documentation": "", "signature": "pub use stream::{ MarkdownStream, MarkdownWork };", "cfg": [] }, { "id": "gpui_kit::content::markdown::stream::MarkdownStream", "name": "MarkdownStream", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "A document being read as it arrives.", "documentation": "A document being read as it arrives.", "signature": "# [doc = \" A document being read as it arrives.\"] # [derive (Debug, Default)] pub struct MarkdownStream { source : String, document : Document, # [doc = \" Where each block of [`Self::document`] begins in [`Self::source`].\"] # [doc = \"\"] # [doc = \" Empty when the parser cannot map its events to top-level blocks.\"] starts : Vec, # [doc = \" Whether this source contains something whose meaning is not local.\"] whole : bool, # [doc = \" How many leading blocks the last update left untouched.\"] stable : usize, # [doc = \" How many bytes the last update actually parsed, which is the claim this\"] # [doc = \" module makes and therefore the one its tests check.\"] parsed : usize, revision : u64, work : Cell, mended_tail : RefCell>)>>, }", "cfg": [] }, { "id": "gpui_kit::content::markdown::stream::MarkdownStream::append", "name": "append", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "Append a delta without scanning or copying the settled source prefix. Reference definitions can still require a complete parser pass.", "documentation": "Append a delta without scanning or copying the settled source prefix.\nReference definitions can still require a complete parser pass.", "signature": "pub fn append (& mut self, delta : & str)", "cfg": [], "target": "MarkdownStream" }, { "id": "gpui_kit::content::markdown::stream::MarkdownStream::document", "name": "document", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "The document as it is, with every marker read literally.", "documentation": "The document as it is, with every marker read literally.", "signature": "pub fn document (& self) -> & Document", "cfg": [], "target": "MarkdownStream" }, { "id": "gpui_kit::content::markdown::stream::MarkdownStream::read", "name": "read", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "Reads `source`, doing as little work as it can to be correct about it.", "documentation": "Reads `source`, doing as little work as it can to be correct about it.\n\nAppending takes the incremental path. Anything else — an edit, a\nreplacement, a different document under the same identity — is parsed\nwhole, because only an append has the property this relies on.", "signature": "pub fn read (& mut self, source : & str)", "cfg": [], "target": "MarkdownStream" }, { "id": "gpui_kit::content::markdown::stream::MarkdownStream::revision", "name": "revision", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "The revision of the retained source; unchanged reads do not advance it.", "documentation": "The revision of the retained source; unchanged reads do not advance it.", "signature": "pub fn revision (& self) -> u64", "cfg": [], "target": "MarkdownStream" }, { "id": "gpui_kit::content::markdown::stream::MarkdownStream::work", "name": "work", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "Cumulative work since creation, including fallback and mending parses.", "documentation": "Cumulative work since creation, including fallback and mending parses.", "signature": "pub fn work (& self) -> MarkdownWork", "cfg": [], "target": "MarkdownStream" }, { "id": "gpui_kit::content::markdown::stream::MarkdownWork", "name": "MarkdownWork", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::markdown::stream", "path": "gpui_kit::content::markdown::stream", "source": "crates/gpui-kit/src/content/markdown/stream.rs", "summary": "Cumulative parser and source-buffer work, not a CPU-time estimate. Parsed bytes include boundary discovery and display-mending passes. Copied bytes count source-buffer writes, not allocations inside the syntax tree.", "documentation": "Cumulative parser and source-buffer work, not a CPU-time estimate.\nParsed bytes include boundary discovery and display-mending passes.\nCopied bytes count source-buffer writes, not allocations inside the syntax tree.", "signature": "# [doc = \" Cumulative parser and source-buffer work, not a CPU-time estimate.\"] # [doc = \" Parsed bytes include boundary discovery and display-mending passes.\"] # [doc = \" Copied bytes count source-buffer writes, not allocations inside the syntax tree.\"] # [derive (Debug, Default, Clone, Copy, PartialEq, Eq)] pub struct MarkdownWork { pub parser_passes : usize, pub parsed_bytes : usize, pub copied_bytes : usize, }", "cfg": [] }, { "id": "gpui_kit::content::message_list::Attachment", "name": "Attachment", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Something carried alongside a message. The list names it and fetches nothing.", "documentation": "Something carried alongside a message. The list names it and fetches\nnothing.", "signature": "# [doc = \" Something carried alongside a message. The list names it and fetches\"] # [doc = \" nothing.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct Attachment { id : SharedString, name : SharedString, detail : Option, }", "cfg": [] }, { "id": "gpui_kit::content::message_list::Attachment::detail", "name": "detail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "A size, a kind, or whatever else the host already knows about it.", "documentation": "A size, a kind, or whatever else the host already knows about it.", "signature": "pub fn detail (mut self, detail : impl Into) -> Self", "cfg": [], "target": "Attachment" }, { "id": "gpui_kit::content::message_list::Attachment::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, name : impl Into) -> Self", "cfg": [], "target": "Attachment" }, { "id": "gpui_kit::content::message_list::DeliveryState", "name": "DeliveryState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "What a host said about a message's journey.", "documentation": "What a host said about a message's journey.\n\nFive states, five renderings. Collapsing sent, delivered, and read into one\ntick tells the reader less than the host knows, and folding a failure into\nany of them tells them something untrue.", "signature": "# [doc = \" What a host said about a message's journey.\"] # [doc = \"\"] # [doc = \" Five states, five renderings. Collapsing sent, delivered, and read into one\"] # [doc = \" tick tells the reader less than the host knows, and folding a failure into\"] # [doc = \" any of them tells them something untrue.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum DeliveryState { # [doc = \" Handed over, not yet acknowledged.\"] Sending, # [doc = \" The host accepted it.\"] # [default] Sent, # [doc = \" It reached the other side.\"] Delivered, # [doc = \" The other side opened it.\"] Read, # [doc = \" It did not arrive, and here is why, in the host's own words.\"] Failed { reason : SharedString }, }", "cfg": [] }, { "id": "gpui_kit::content::message_list::DeliveryState::failed", "name": "failed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn failed (& self) -> bool", "cfg": [], "target": "DeliveryState" }, { "id": "gpui_kit::content::message_list::DeliveryState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "The name a node publishes, so a test asserts the state rather than the colour it was drawn in.", "documentation": "The name a node publishes, so a test asserts the state rather than the\ncolour it was drawn in.", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "DeliveryState" }, { "id": "gpui_kit::content::message_list::Message", "name": "Message", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "One turn in a conversation.", "documentation": "One turn in a conversation.", "signature": "# [doc = \" One turn in a conversation.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct Message { id : SharedString, author : Option, time : EntryTime, body : MessageBody, delivery : DeliveryState, streaming : bool, tint : Option, attachments : Vec, reactions : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::message_list::Message::attachment", "name": "attachment", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn attachment (mut self, attachment : Attachment) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::author", "name": "author", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn author (mut self, author : impl Into) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::delivery", "name": "delivery", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn delivery (mut self, delivery : DeliveryState) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::failed", "name": "failed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn failed (self, reason : impl Into) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::markdown", "name": "markdown", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn markdown (id : impl Into, source : impl Into) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "`id` is the message's own identity, which every node it publishes is derived from, so an assertion survives the conversation growing above it.", "documentation": "`id` is the message's own identity, which every node it publishes is\nderived from, so an assertion survives the conversation growing above\nit.", "signature": "pub fn new (id : impl Into, body : impl Into) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::reaction", "name": "reaction", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn reaction (mut self, reaction : Reaction) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::streaming", "name": "streaming", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Marks the message as still arriving. The body keeps whatever has arrived so far.", "documentation": "Marks the message as still arriving. The body keeps whatever has\narrived so far.", "signature": "pub fn streaming (mut self, streaming : bool) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::time", "name": "time", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "The time, in the words the host chose.", "documentation": "The time, in the words the host chose.", "signature": "pub fn time (mut self, time : impl Into) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::Message::tint", "name": "tint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "The colour this speaker is known by.", "documentation": "The colour this speaker is known by.\n\nA transcript in which every turn is the same grey slab makes the\nreader work out who is talking from the byline alone, which is the one\nline a continued turn does not draw. The colour is carried as a wash\nbehind the turn and nothing else — no stripe beside the bubble, which\nwould be a second geometry saying what the wash has said — quiet enough\nthat a long thread still reads as one document.\n\nIt is never derived from the author's name, for the reason\n[`Avatar::tint`](crate::display::avatar::Avatar::tint) gives: this\ncomponent cannot know which colours the application has already spent.", "signature": "pub fn tint (mut self, tint : Hsla) -> Self", "cfg": [], "target": "Message" }, { "id": "gpui_kit::content::message_list::MessageBody", "name": "MessageBody", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "What a message says.", "documentation": "What a message says.", "signature": "# [doc = \" What a message says.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum MessageBody { # [doc = \" Shown exactly as it is, with no markup read into it.\"] Text (SharedString), # [doc = \" Rendered through [`Markdown`], with its rules about HTML, links, and\"] # [doc = \" images.\"] Markdown (SharedString), }", "cfg": [] }, { "id": "gpui_kit::content::message_list::MessageBody::source", "name": "source", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "The text as the caller wrote it, markup and all.", "documentation": "The text as the caller wrote it, markup and all.", "signature": "pub fn source (& self) -> & SharedString", "cfg": [], "target": "MessageBody" }, { "id": "gpui_kit::content::message_list::MessageList", "name": "MessageList", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "A conversation.", "documentation": "A conversation.", "signature": "# [doc = \" A conversation.\"] # [derive (IntoElement)] pub struct MessageList { ident : Ident, messages : Vec, visible_rows : Option, # [doc = \" How many lines of body a slot holds, or `None` for a conversation whose\"] # [doc = \" messages are as tall as what they say.\"] body_lines : Option, group_consecutive : bool, on_retry : Option, on_markdown : Option, }", "cfg": [] }, { "id": "gpui_kit::content::message_list::MessageList::body_lines", "name": "body_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "How many lines of body each message's slot holds.", "documentation": "How many lines of body each message's slot holds.", "signature": "pub fn body_lines (mut self, lines : usize) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::MessageList::group_consecutive", "name": "group_consecutive", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Whether consecutive messages from one author are drawn as one turn.", "documentation": "Whether consecutive messages from one author are drawn as one turn.\n\nDeclared, not inferred, for the same reason\n[`Toolbar::overflow_after`](crate::layout::Toolbar::overflow_after) is:\nwhether two messages a minute apart are one turn or two is a product\njudgement about the conversation, and this component knows nothing\nabout the conversation.", "signature": "pub fn group_consecutive (mut self, group : bool) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::MessageList::grows_to_fit", "name": "grows_to_fit", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Lets each message be as tall as what it says.", "documentation": "Lets each message be as tall as what it says.\n\nThe default is a slot: every message is the same height, which is what\nmakes a conversation of ten thousand cost the same as one of ten, and a\nbody longer than the slot says how many lines it left out. This trades\nthat for messages that are whole. The list then measures a message when\nit first comes into view, so it can only estimate how far a conversation\nit has not scrolled through reaches, and a scrollbar over one settles as\nthe reader moves down it.\n\nThis and [`MessageList::body_lines`] are the same setting: the last one\nnamed wins.", "signature": "pub fn grows_to_fit (mut self) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::MessageList::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, messages : impl IntoIterator) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::MessageList::on_markdown", "name": "on_markdown", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Forwards what a Markdown body reported, stamped with the message it came from.", "documentation": "Forwards what a Markdown body reported, stamped with the message it\ncame from.", "signature": "pub fn on_markdown (mut self, handler : impl Fn (SharedString, & MarkdownEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::MessageList::on_retry", "name": "on_retry", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Reports that a failed message should be tried again. Nothing is resent and nothing is removed.", "documentation": "Reports that a failed message should be tried again. Nothing is resent\nand nothing is removed.", "signature": "pub fn on_retry (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::MessageList::visible_rows", "name": "visible_rows", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "Bounds the viewport to `rows` messages, which is what lets the list skip the ones it does not show.", "documentation": "Bounds the viewport to `rows` messages, which is what lets the list\nskip the ones it does not show.", "signature": "pub fn visible_rows (mut self, rows : usize) -> Self", "cfg": [], "target": "MessageList" }, { "id": "gpui_kit::content::message_list::Reaction", "name": "Reaction", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "A reaction and how many people left it.", "documentation": "A reaction and how many people left it.", "signature": "# [doc = \" A reaction and how many people left it.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct Reaction { key : SharedString, label : SharedString, count : usize, }", "cfg": [] }, { "id": "gpui_kit::content::message_list::Reaction::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "", "documentation": "", "signature": "pub fn new (key : impl Into, label : impl Into, count : usize) -> Self", "cfg": [], "target": "Reaction" }, { "id": "gpui_kit::content::message_list::streaming_since", "name": "streaming_since", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::message_list", "path": "gpui_kit::content::message_list", "source": "crates/gpui-kit/src/content/message_list.rs", "summary": "When the streaming indicator on `message` in `list` began.", "documentation": "When the streaming indicator on `message` in `list` began.\n\nKeyed by the message's identity and nothing else, so text arriving into a\nmessage that is already streaming does not restart the indicator: a\nconversation whose \"still writing\" mark flickered on every token would be\nreporting the token, not the stream. Answers `None` once the message stops\nstreaming.", "signature": "pub fn streaming_since (list : & Ident, message : & str, window : & Window, cx : & App) -> Option", "cfg": [] }, { "id": "gpui_kit::content::outline::Mark", "name": "Mark", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "A place in the mapped surface worth returning to.", "documentation": "A place in the mapped surface worth returning to.", "signature": "# [doc = \" A place in the mapped surface worth returning to.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct Mark { id : SharedString, row : usize, title : SharedString, detail : Option, }", "cfg": [] }, { "id": "gpui_kit::content::outline::Mark::detail", "name": "detail", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "A second line for the preview: what followed this place, typically, so the reader recognises the one they want without going there.", "documentation": "A second line for the preview: what followed this place, typically, so\nthe reader recognises the one they want without going there.", "signature": "pub fn detail (mut self, detail : impl Into) -> Self", "cfg": [], "target": "Mark" }, { "id": "gpui_kit::content::outline::Mark::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & SharedString", "cfg": [], "target": "Mark" }, { "id": "gpui_kit::content::outline::Mark::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "`row` is the mapped list's row index, which is what makes the mark a destination rather than only a label.", "documentation": "`row` is the mapped list's row index, which is what makes the mark a\ndestination rather than only a label.", "signature": "pub fn new (id : impl Into, row : usize, title : impl Into) -> Self", "cfg": [], "target": "Mark" }, { "id": "gpui_kit::content::outline::Mark::row", "name": "row", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "", "documentation": "", "signature": "pub fn row (& self) -> usize", "cfg": [], "target": "Mark" }, { "id": "gpui_kit::content::outline::Outline", "name": "Outline", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "The outline of a long surface. Reports the mark that was chosen, and travels there.", "documentation": "The outline of a long surface. Reports the mark that was chosen, and\ntravels there.", "signature": "# [doc = \" The outline of a long surface. Reports the mark that was chosen, and\"] # [doc = \" travels there.\"] # [derive (IntoElement)] pub struct Outline { ident : Ident, over : Option, marks : Vec, slots : Option, on_select : Option, }", "cfg": [] }, { "id": "gpui_kit::content::outline::Outline::mark", "name": "mark", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "", "documentation": "", "signature": "pub fn mark (mut self, mark : Mark) -> Self", "cfg": [], "target": "Outline" }, { "id": "gpui_kit::content::outline::Outline::marks", "name": "marks", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "", "documentation": "", "signature": "pub fn marks (mut self, marks : impl IntoIterator) -> Self", "cfg": [], "target": "Outline" }, { "id": "gpui_kit::content::outline::Outline::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "Outline" }, { "id": "gpui_kit::content::outline::Outline::on_select", "name": "on_select", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "Reports the mark that was chosen. The travel happens either way: the minimap owns the scroll, and this is for a host that wants to know.", "documentation": "Reports the mark that was chosen. The travel happens either way: the\nminimap owns the scroll, and this is for a host that wants to know.", "signature": "pub fn on_select (mut self, handler : impl Fn (SharedString, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "Outline" }, { "id": "gpui_kit::content::outline::Outline::over", "name": "over", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "The list this is an outline of, by name.", "documentation": "The list this is an outline of, by name.\n\nWithout one the outline still draws and still reports, but it cannot\nknow which mark you are reading and clicking one moves nothing — which\nis why every real use names a list.", "signature": "pub fn over (mut self, list : impl Into) -> Self", "cfg": [], "target": "Outline" }, { "id": "gpui_kit::content::outline::Outline::slots", "name": "slots", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::outline", "path": "gpui_kit::content::outline", "source": "crates/gpui-kit/src/content/outline.rs", "summary": "Draws exactly this many marks instead of as many as the mapped list's height allows.", "documentation": "Draws exactly this many marks instead of as many as the mapped list's\nheight allows.\n\nFor a caller whose outline is not beside the list it maps, and for\ntests, which have no window height worth measuring.", "signature": "pub fn slots (mut self, slots : usize) -> Self", "cfg": [], "target": "Outline" }, { "id": "gpui_kit::content::reexport-1", "name": "agent_document :: { AgentBlockKind , AgentDocument , AgentDocumentBlock , AgentDocumentEvent , AgentDocumentState , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use agent_document::{ AgentBlockKind, AgentDocument, AgentDocumentBlock, AgentDocumentEvent, AgentDocumentState, };", "cfg": [] }, { "id": "gpui_kit::content::reexport-10", "name": "message_list :: { Attachment , DeliveryState , Message , MessageBody , MessageList , Reaction , streaming_since , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use message_list::{ Attachment, DeliveryState, Message, MessageBody, MessageList, Reaction, streaming_since, };", "cfg": [] }, { "id": "gpui_kit::content::reexport-11", "name": "outline :: { Mark , Outline }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use outline::{ Mark, Outline };", "cfg": [] }, { "id": "gpui_kit::content::reexport-12", "name": "rich_text :: { RichTextAlignment , RichTextBlock , RichTextBlockId , RichTextDocument , RichTextEditResult , RichTextEditSession , RichTextError , RichTextFormat , RichTextInlineStyle , RichTextInputKind , RichTextIntent , RichTextListItem , RichTextListKind , RichTextParagraphStyle , RichTextPosition , RichTextRange , RichTextSelection , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use rich_text::{ RichTextAlignment, RichTextBlock, RichTextBlockId, RichTextDocument, RichTextEditResult, RichTextEditSession, RichTextError, RichTextFormat, RichTextInlineStyle, RichTextInputKind, RichTextIntent, RichTextListItem, RichTextListKind, RichTextParagraphStyle, RichTextPosition, RichTextRange, RichTextSelection, };", "cfg": [] }, { "id": "gpui_kit::content::reexport-13", "name": "terminal :: { CellHit , CellSide , CellSnapshot , CursorSnapshot , Emulator , GridGeometry , GridPoint , GridSize , GridSnapshot , SelectionKind , Terminal , TerminalEvent , TerminalState , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "# [cfg (all (feature = \"terminal\", not (target_family = \"wasm\")))] pub use terminal::{ CellHit, CellSide, CellSnapshot, CursorSnapshot, Emulator, GridGeometry, GridPoint, GridSize, GridSnapshot, SelectionKind, Terminal, TerminalEvent, TerminalState, };", "cfg": [ "cfg (all (feature = \"terminal\", not (target_family = \"wasm\")))" ] }, { "id": "gpui_kit::content::reexport-14", "name": "transport :: { BufferedRange , MediaPresentation , TrackStep , TransportBar , TransportDuration , TransportEvent , TransportState , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use transport::{ BufferedRange, MediaPresentation, TrackStep, TransportBar, TransportDuration, TransportEvent, TransportState, };", "cfg": [] }, { "id": "gpui_kit::content::reexport-2", "name": "ansi :: { AnsiRun , strip_ansi }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use ansi::{ AnsiRun, strip_ansi };", "cfg": [] }, { "id": "gpui_kit::content::reexport-3", "name": "browser :: { BrowserPanel , ViewportState }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use browser::{ BrowserPanel, ViewportState };", "cfg": [] }, { "id": "gpui_kit::content::reexport-4", "name": "code_view :: { CodeLine , CodeView , LineMark }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use code_view::{ CodeLine, CodeView, LineMark };", "cfg": [] }, { "id": "gpui_kit::content::reexport-5", "name": "diff_view :: { DiffCursor , DiffFile , DiffHunk , DiffLine , DiffNote , DiffPresentation , DiffView , DiffViewEvent , word_spans , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use diff_view::{ DiffCursor, DiffFile, DiffHunk, DiffLine, DiffNote, DiffPresentation, DiffView, DiffViewEvent, word_spans, };", "cfg": [] }, { "id": "gpui_kit::content::reexport-6", "name": "highlight :: { Carry , Language }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use highlight::{ Carry, Language };", "cfg": [] }, { "id": "gpui_kit::content::reexport-7", "name": "image_viewer :: { FitMode , ImageFrame , ImageSize , ImageState , ImageViewer , ImageViewerEvent }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use image_viewer::{ FitMode, ImageFrame, ImageSize, ImageState, ImageViewer, ImageViewerEvent };", "cfg": [] }, { "id": "gpui_kit::content::reexport-8", "name": "log_stream :: { LogEntry , LogStream , LogStreamState }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use log_stream::{ LogEntry, LogStream, LogStreamState };", "cfg": [] }, { "id": "gpui_kit::content::reexport-9", "name": "markdown :: { Block , CellAlign , CodeBlock , CodeSpan , Document , ImageRequest , Inline , ListEntry , Markdown , MarkdownCodePresentation , MarkdownEvent , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content", "path": "gpui_kit::content", "source": "crates/gpui-kit/src/content/mod.rs", "summary": "", "documentation": "", "signature": "pub use markdown::{ Block, CellAlign, CodeBlock, CodeSpan, Document, ImageRequest, Inline, ListEntry, Markdown, MarkdownCodePresentation, MarkdownEvent, };", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextAlignment", "name": "RichTextAlignment", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Logical paragraph alignment. Start and end follow reading direction.", "documentation": "Logical paragraph alignment. Start and end follow reading direction.", "signature": "# [doc = \" Logical paragraph alignment. Start and end follow reading direction.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub enum RichTextAlignment { # [default] Start, Center, End, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextBlock", "name": "RichTextBlock", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "One paragraph-like block and its complete inline style coverage.", "documentation": "One paragraph-like block and its complete inline style coverage.", "signature": "# [doc = \" One paragraph-like block and its complete inline style coverage.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct RichTextBlock { id : RichTextBlockId, text : SharedString, styles : EditableStyleRuns, paragraph : RichTextParagraphStyle, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextBlock::id", "name": "id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn id (& self) -> & RichTextBlockId", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlock::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, text : impl Into) -> Self", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlock::paragraph", "name": "paragraph", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn paragraph (& self) -> RichTextParagraphStyle", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlock::styles", "name": "styles", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn styles (& self) -> & EditableStyleRuns", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlock::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn text (& self) -> & SharedString", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlock::with_paragraph", "name": "with_paragraph", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn with_paragraph (mut self, paragraph : RichTextParagraphStyle) -> Self", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlock::with_style", "name": "with_style", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Applies one complete style over a grapheme-safe range.", "documentation": "Applies one complete style over a grapheme-safe range.", "signature": "pub fn with_style (mut self, range : Range, style : RichTextInlineStyle) -> Self", "cfg": [], "target": "RichTextBlock" }, { "id": "gpui_kit::content::rich_text::RichTextBlockId", "name": "RichTextBlockId", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Stable caller-visible identity for one rich-text block.", "documentation": "Stable caller-visible identity for one rich-text block.\n\nIt is content identity, not a list position. A host should preserve it\nwhile converting to and from its durable document so selection, semantics,\nand collaboration adapters do not rename every following paragraph after\none insertion.", "signature": "# [doc = \" Stable caller-visible identity for one rich-text block.\"] # [doc = \"\"] # [doc = \" It is content identity, not a list position. A host should preserve it\"] # [doc = \" while converting to and from its durable document so selection, semantics,\"] # [doc = \" and collaboration adapters do not rename every following paragraph after\"] # [doc = \" one insertion.\"] # [derive (Clone, Debug, PartialEq, Eq, Hash)] pub struct RichTextBlockId (SharedString);", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextBlockId::as_str", "name": "as_str", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn as_str (& self) -> & str", "cfg": [], "target": "RichTextBlockId" }, { "id": "gpui_kit::content::rich_text::RichTextBlockId::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn new (value : impl Into) -> Self", "cfg": [], "target": "RichTextBlockId" }, { "id": "gpui_kit::content::rich_text::RichTextDocument", "name": "RichTextDocument", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "A non-empty storage-neutral rich-text document.", "documentation": "A non-empty storage-neutral rich-text document.", "signature": "# [doc = \" A non-empty storage-neutral rich-text document.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct RichTextDocument { blocks : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextDocument::block", "name": "block", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn block (& self, id : & RichTextBlockId) -> Option<& RichTextBlock>", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextDocument::blocks", "name": "blocks", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn blocks (& self) -> & [RichTextBlock]", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextDocument::empty", "name": "empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn empty (block_id : impl Into) -> Result", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextDocument::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Validates a caller-built document.", "documentation": "Validates a caller-built document.", "signature": "pub fn new (blocks : impl IntoIterator) -> Result", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextDocument::plain", "name": "plain", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn plain (block_id : impl Into, text : impl Into,) -> Result", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextDocument::selection_at_end", "name": "selection_at_end", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn selection_at_end (& self) -> RichTextSelection", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextDocument::selection_at_start", "name": "selection_at_start", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn selection_at_start (& self) -> RichTextSelection", "cfg": [], "target": "RichTextDocument" }, { "id": "gpui_kit::content::rich_text::RichTextEditResult", "name": "RichTextEditResult", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "What one command changed.", "documentation": "What one command changed.", "signature": "# [doc = \" What one command changed.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct RichTextEditResult { pub document_changed : bool, pub selection_changed : bool, pub pending_style_changed : bool, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextEditResult::changed", "name": "changed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn changed (self) -> bool", "cfg": [], "target": "RichTextEditResult" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession", "name": "RichTextEditSession", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Caller-owned editing state and reusable rich-document transaction history.", "documentation": "Caller-owned editing state and reusable rich-document transaction history.\n\nA component may hold an entity containing this session, but the host owns\nthat entity and decides its lifetime. Replacing the authoritative document\nclears history; undo can therefore never resurrect a document the host has\nsuperseded.", "signature": "# [doc = \" Caller-owned editing state and reusable rich-document transaction history.\"] # [doc = \"\"] # [doc = \" A component may hold an entity containing this session, but the host owns\"] # [doc = \" that entity and decides its lifetime. Replacing the authoritative document\"] # [doc = \" clears history; undo can therefore never resurrect a document the host has\"] # [doc = \" superseded.\"] # [derive (Debug)] pub struct RichTextEditSession { document : RichTextDocument, selection : RichTextSelection, pending_style : RichTextInlineStyle, done : Vec, undone : Vec, history_allowed : bool, composition : Option, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::apply", "name": "apply", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn apply (& mut self, intent : RichTextIntent) -> Result", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::can_redo", "name": "can_redo", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn can_redo (& self) -> bool", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::can_undo", "name": "can_undo", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn can_undo (& self) -> bool", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::document", "name": "document", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn document (& self) -> & RichTextDocument", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::forbid_history", "name": "forbid_history", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Stops recording permanently and clears recoverable text.", "documentation": "Stops recording permanently and clears recoverable text.", "signature": "pub fn forbid_history (& mut self)", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::marked_range", "name": "marked_range", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn marked_range (& self) -> Option<& RichTextRange>", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn new (document : RichTextDocument) -> Self", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::pending_style", "name": "pending_style", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn pending_style (& self) -> & RichTextInlineStyle", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::replace_document", "name": "replace_document", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Replaces the host authority and forgets transactions over the old one.", "documentation": "Replaces the host authority and forgets transactions over the old one.", "signature": "pub fn replace_document (& mut self, document : RichTextDocument, selection : RichTextSelection,) -> Result<(), RichTextError>", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextEditSession::selection", "name": "selection", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn selection (& self) -> & RichTextSelection", "cfg": [], "target": "RichTextEditSession" }, { "id": "gpui_kit::content::rich_text::RichTextError", "name": "RichTextError", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Invalid caller-owned document or position data.", "documentation": "Invalid caller-owned document or position data.", "signature": "# [doc = \" Invalid caller-owned document or position data.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub enum RichTextError { EmptyDocument, EmptyBlockId, DuplicateBlockId (RichTextBlockId), UnknownBlock (RichTextBlockId), BlockIdCount { expected : usize, actual : usize }, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextFormat", "name": "RichTextFormat", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Inline formats whose active state can be toggled independently.", "documentation": "Inline formats whose active state can be toggled independently.", "signature": "# [doc = \" Inline formats whose active state can be toggled independently.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq, Hash)] pub enum RichTextFormat { Bold, Italic, Underline, Strike, Code, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextInlineStyle", "name": "RichTextInlineStyle", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "The complete inline style at one source byte.", "documentation": "The complete inline style at one source byte.\n\nLinks are data, not actions. The editor reports their destination but does\nnot validate, fetch, or open it; those remain host policy.", "signature": "# [doc = \" The complete inline style at one source byte.\"] # [doc = \"\"] # [doc = \" Links are data, not actions. The editor reports their destination but does\"] # [doc = \" not validate, fetch, or open it; those remain host policy.\"] # [derive (Clone, Debug, Default, PartialEq, Eq)] pub struct RichTextInlineStyle { bold : bool, italic : bool, underline : bool, strike : bool, code : bool, link : Option, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextInlineStyle::format", "name": "format", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn format (& self, format : RichTextFormat) -> bool", "cfg": [], "target": "RichTextInlineStyle" }, { "id": "gpui_kit::content::rich_text::RichTextInlineStyle::link", "name": "link", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn link (& self) -> Option<& SharedString>", "cfg": [], "target": "RichTextInlineStyle" }, { "id": "gpui_kit::content::rich_text::RichTextInlineStyle::with_format", "name": "with_format", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn with_format (mut self, format : RichTextFormat, active : bool) -> Self", "cfg": [], "target": "RichTextInlineStyle" }, { "id": "gpui_kit::content::rich_text::RichTextInlineStyle::with_link", "name": "with_link", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn with_link (mut self, destination : Option) -> Self", "cfg": [], "target": "RichTextInlineStyle" }, { "id": "gpui_kit::content::rich_text::RichTextInputKind", "name": "RichTextInputKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "What supplied a text replacement, for transaction grouping.", "documentation": "What supplied a text replacement, for transaction grouping.", "signature": "# [doc = \" What supplied a text replacement, for transaction grouping.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum RichTextInputKind { Typing, Deleting, Paste, Cut, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextIntent", "name": "RichTextIntent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "A typed command accepted by [`RichTextEditSession::apply`].", "documentation": "A typed command accepted by [`RichTextEditSession::apply`].", "signature": "# [doc = \" A typed command accepted by [`RichTextEditSession::apply`].\"] # [derive (Clone, Debug, PartialEq, Eq)] pub enum RichTextIntent { Select (RichTextSelection), Replace { text : SharedString, kind : RichTextInputKind, }, # [doc = \" Replaces the selection with plain text whose normalized line breaks\"] # [doc = \" become hard blocks. There must be one fresh stable id per break.\"] ReplaceMultiline { text : SharedString, new_blocks : Vec, kind : RichTextInputKind, }, InsertSoftBreak, InsertHardBreak { new_block : RichTextBlockId, }, BackspaceAtStart, ToggleFormat (RichTextFormat), SetLink (Option), SetAlignment (RichTextAlignment), SetList (Option), ChangeListDepth (i8), Compose { text : SharedString, selection_in_text : Option>, }, EndComposition, Undo, Redo, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextListItem", "name": "RichTextListItem", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "List metadata for one paragraph.", "documentation": "List metadata for one paragraph.", "signature": "# [doc = \" List metadata for one paragraph.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub struct RichTextListItem { pub kind : RichTextListKind, pub depth : u8, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextListItem::depth", "name": "depth", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn depth (mut self, depth : u8) -> Self", "cfg": [], "target": "RichTextListItem" }, { "id": "gpui_kit::content::rich_text::RichTextListItem::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn new (kind : RichTextListKind) -> Self", "cfg": [], "target": "RichTextListItem" }, { "id": "gpui_kit::content::rich_text::RichTextListKind", "name": "RichTextListKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "The marker family of a list item.", "documentation": "The marker family of a list item.", "signature": "# [doc = \" The marker family of a list item.\"] # [derive (Clone, Copy, Debug, PartialEq, Eq)] pub enum RichTextListKind { Unordered, Ordered, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextParagraphStyle", "name": "RichTextParagraphStyle", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "Block presentation metadata independent of any storage syntax.", "documentation": "Block presentation metadata independent of any storage syntax.", "signature": "# [doc = \" Block presentation metadata independent of any storage syntax.\"] # [derive (Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct RichTextParagraphStyle { alignment : RichTextAlignment, list : Option, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextParagraphStyle::alignment", "name": "alignment", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn alignment (& self) -> RichTextAlignment", "cfg": [], "target": "RichTextParagraphStyle" }, { "id": "gpui_kit::content::rich_text::RichTextParagraphStyle::list", "name": "list", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn list (& self) -> Option", "cfg": [], "target": "RichTextParagraphStyle" }, { "id": "gpui_kit::content::rich_text::RichTextParagraphStyle::with_alignment", "name": "with_alignment", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn with_alignment (mut self, alignment : RichTextAlignment) -> Self", "cfg": [], "target": "RichTextParagraphStyle" }, { "id": "gpui_kit::content::rich_text::RichTextParagraphStyle::with_list", "name": "with_list", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn with_list (mut self, list : Option) -> Self", "cfg": [], "target": "RichTextParagraphStyle" }, { "id": "gpui_kit::content::rich_text::RichTextPosition", "name": "RichTextPosition", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "One UTF-8 position inside a stable block.", "documentation": "One UTF-8 position inside a stable block.", "signature": "# [doc = \" One UTF-8 position inside a stable block.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct RichTextPosition { pub block : RichTextBlockId, pub offset : usize, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextPosition::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn new (block : impl Into, offset : usize) -> Self", "cfg": [], "target": "RichTextPosition" }, { "id": "gpui_kit::content::rich_text::RichTextRange", "name": "RichTextRange", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "One normalized document range.", "documentation": "One normalized document range.", "signature": "# [doc = \" One normalized document range.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct RichTextRange { pub start : RichTextPosition, pub end : RichTextPosition, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextSelection", "name": "RichTextSelection", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "An anchor and moving head. Their order is preserved across bidi and drag selection; document operations normalize them only while applying an edit.", "documentation": "An anchor and moving head. Their order is preserved across bidi and drag\nselection; document operations normalize them only while applying an edit.", "signature": "# [doc = \" An anchor and moving head. Their order is preserved across bidi and drag\"] # [doc = \" selection; document operations normalize them only while applying an edit.\"] # [derive (Clone, Debug, PartialEq, Eq)] pub struct RichTextSelection { pub anchor : RichTextPosition, pub head : RichTextPosition, }", "cfg": [] }, { "id": "gpui_kit::content::rich_text::RichTextSelection::caret", "name": "caret", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn caret (position : RichTextPosition) -> Self", "cfg": [], "target": "RichTextSelection" }, { "id": "gpui_kit::content::rich_text::RichTextSelection::is_caret", "name": "is_caret", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn is_caret (& self) -> bool", "cfg": [], "target": "RichTextSelection" }, { "id": "gpui_kit::content::rich_text::RichTextSelection::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::rich_text", "path": "gpui_kit::content::rich_text", "source": "crates/gpui-kit/src/content/rich_text.rs", "summary": "", "documentation": "", "signature": "pub fn new (anchor : RichTextPosition, head : RichTextPosition) -> Self", "cfg": [], "target": "RichTextSelection" }, { "id": "gpui_kit::content::terminal::emulator::CellColor", "name": "CellColor", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "What a cell says its colour is, before a theme decides what that means.", "documentation": "What a cell says its colour is, before a theme decides what that means.\n\nKept symbolic on purpose. `Foreground` and `Background` are the terminal's\ndefaults and follow the theme; an index is a named slot or a point in the\ncolour cube; and only `Rgb` is a colour the program actually chose. A\nsnapshot that resolved these to pixels would have to be rebuilt on every\ntheme change, and would lose the distinction between \"red\" and `#ff0000`.", "signature": "# [doc = \" What a cell says its colour is, before a theme decides what that means.\"] # [doc = \"\"] # [doc = \" Kept symbolic on purpose. `Foreground` and `Background` are the terminal's\"] # [doc = \" defaults and follow the theme; an index is a named slot or a point in the\"] # [doc = \" colour cube; and only `Rgb` is a colour the program actually chose. A\"] # [doc = \" snapshot that resolved these to pixels would have to be rebuilt on every\"] # [doc = \" theme change, and would lose the distinction between \\\"red\\\" and `#ff0000`.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum CellColor { Foreground, Background, # [doc = \" 0-15 the ANSI slots, 16-231 the colour cube, 232-255 the grey ramp.\"] Indexed (u8), Rgb (u8, u8, u8), }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::CellSide", "name": "CellSide", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Which edge of a cell an anchor sits on.", "documentation": "Which edge of a cell an anchor sits on.\n\nA selection anchors to an edge, not to a cell: pressing on the left half of\na glyph includes it, the right half excludes it. Without the distinction a\ndrag cannot express \"up to but not including this character\".", "signature": "# [doc = \" Which edge of a cell an anchor sits on.\"] # [doc = \"\"] # [doc = \" A selection anchors to an edge, not to a cell: pressing on the left half of\"] # [doc = \" a glyph includes it, the right half excludes it. Without the distinction a\"] # [doc = \" drag cannot express \\\"up to but not including this character\\\".\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum CellSide { Left, Right, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::CellSnapshot", "name": "CellSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "One cell as it stands: the character, its colours, and the attributes that change how it is painted.", "documentation": "One cell as it stands: the character, its colours, and the attributes that\nchange how it is painted.", "signature": "# [doc = \" One cell as it stands: the character, its colours, and the attributes that\"] # [doc = \" change how it is painted.\"] # [derive (Debug, Clone, Copy, PartialEq)] pub struct CellSnapshot { pub ch : char, pub fg : CellColor, pub bg : CellColor, pub bold : bool, pub dim : bool, pub italic : bool, pub underline : bool, pub inverse : bool, pub hidden : bool, # [doc = \" A double-width character, covering this cell and the spacer after it.\"] pub wide : bool, # [doc = \" The spacer half of a wide character. Never shaped; only its background\"] # [doc = \" is painted, because the glyph beside it already covers this column.\"] pub wide_spacer : bool, pub selected : bool, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::CellSnapshot::display_colors", "name": "display_colors", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "The colours to paint with, after INVERSE and HIDDEN are resolved.", "documentation": "The colours to paint with, after INVERSE and HIDDEN are resolved.\n\nBoth are attributes about painting rather than about the text, so they\nare resolved here and not stored twice: a cell keeps what the program\nset, and this answers what a painter should use.", "signature": "pub fn display_colors (& self) -> (CellColor, CellColor)", "cfg": [], "target": "CellSnapshot" }, { "id": "gpui_kit::content::terminal::emulator::CursorSnapshot", "name": "CursorSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Where the cursor is, in viewport rows (row 0 is the top of what is visible).", "documentation": "Where the cursor is, in viewport rows (row 0 is the top of what is visible).", "signature": "# [doc = \" Where the cursor is, in viewport rows (row 0 is the top of what is visible).\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct CursorSnapshot { pub row : usize, pub col : usize, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::Emulator", "name": "Emulator", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "A terminal's state: a pure fold of output bytes into a grid.", "documentation": "A terminal's state: a pure fold of output bytes into a grid.", "signature": "# [doc = \" A terminal's state: a pure fold of output bytes into a grid.\"] pub struct Emulator { term : Term, parser : Processor, capture : EventCapture, title : Option, bell : bool, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::Emulator::app_cursor_mode", "name": "app_cursor_mode", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Whether arrows should be sent as SS3 (`ESC O A`) rather than CSI.", "documentation": "Whether arrows should be sent as SS3 (`ESC O A`) rather than CSI.", "signature": "pub fn app_cursor_mode (& self) -> bool", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::bracketed_paste_mode", "name": "bracketed_paste_mode", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Whether a paste should be wrapped in `ESC [200~` / `ESC [201~`.", "documentation": "Whether a paste should be wrapped in `ESC [200~` / `ESC [201~`.", "signature": "pub fn bracketed_paste_mode (& self) -> bool", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::clear_selection", "name": "clear_selection", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn clear_selection (& mut self)", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::cols", "name": "cols", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn cols (& self) -> usize", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::cursor", "name": "cursor", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "The cursor in viewport coordinates, or `None` when it is hidden or has scrolled out of view.", "documentation": "The cursor in viewport coordinates, or `None` when it is hidden or has\nscrolled out of view.", "signature": "pub fn cursor (& self) -> Option", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::display_offset", "name": "display_offset", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "How far the view is scrolled back; 0 is pinned to the live bottom.", "documentation": "How far the view is scrolled back; 0 is pinned to the live bottom.", "signature": "pub fn display_offset (& self) -> usize", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::feed", "name": "feed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Advance over output bytes, returning whatever the terminal wants written back.", "documentation": "Advance over output bytes, returning whatever the terminal wants\nwritten back.\n\nThe return value is not decoration: a cursor position report or a device\nattributes query is a question the program is waiting on, and a host\nthat drops the answer hangs it. Handing the bytes back rather than\nwriting them keeps this module free of the pty.", "signature": "pub fn feed (& mut self, bytes : & [u8]) -> Vec", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::grid_point", "name": "grid_point", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "The grid point under a viewport cell.", "documentation": "The grid point under a viewport cell.\n\nThe two coordinate systems differ by the scrollback offset, and this is\nthe only place they meet. The column clamps into the grid so a pointer\npast the right edge cannot anchor a selection outside it.", "signature": "pub fn grid_point (& self, viewport_row : usize, col : usize) -> GridPoint", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::has_selection", "name": "has_selection", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Whether anything is actually selected.", "documentation": "Whether anything is actually selected.", "signature": "pub fn has_selection (& self) -> bool", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::history_lines", "name": "history_lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "How many lines are available above the viewport.", "documentation": "How many lines are available above the viewport.", "signature": "pub fn history_lines (& self) -> usize", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::line", "name": "line", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "One viewport row, top row first.", "documentation": "One viewport row, top row first.", "signature": "pub fn line (& self, viewport_row : usize) -> Vec", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::lines", "name": "lines", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Every viewport row, top to bottom.", "documentation": "Every viewport row, top to bottom.", "signature": "pub fn lines (& self) -> Vec>", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn new (cols : u16, rows : u16) -> Self", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::resize", "name": "resize", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn resize (& mut self, cols : u16, rows : u16)", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::row_text", "name": "row_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "One viewport row as trimmed text, with wide-character spacers skipped.", "documentation": "One viewport row as trimmed text, with wide-character spacers skipped.\n\nA reading rather than a rendering: it is what a test asserts against and\nwhat a copy of a single row would contain.", "signature": "pub fn row_text (& self, viewport_row : usize) -> String", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::rows", "name": "rows", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn rows (& self) -> usize", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::scroll", "name": "scroll", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Scroll the view: positive goes up into history, negative toward live.", "documentation": "Scroll the view: positive goes up into history, negative toward live.", "signature": "pub fn scroll (& mut self, delta : i32)", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::scroll_to_bottom", "name": "scroll_to_bottom", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn scroll_to_bottom (& mut self)", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::selection_text", "name": "selection_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "The selected text, or `None` when nothing is selected.", "documentation": "The selected text, or `None` when nothing is selected.\n\nA click with no drag leaves an empty selection behind, and reporting\nthat as a selection is what makes a bare click clobber the clipboard.", "signature": "pub fn selection_text (& self) -> Option", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::start_selection", "name": "start_selection", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Begin a selection at a point, with the granularity the gesture implies.", "documentation": "Begin a selection at a point, with the granularity the gesture implies.", "signature": "pub fn start_selection (& mut self, kind : SelectionKind, point : GridPoint, side : CellSide)", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::take_bell", "name": "take_bell", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Whether a BEL has arrived since this was last asked. Reading clears it, because a bell is an event and a caller that missed one has missed it.", "documentation": "Whether a BEL has arrived since this was last asked. Reading clears it,\nbecause a bell is an event and a caller that missed one has missed it.", "signature": "pub fn take_bell (& mut self) -> bool", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::title", "name": "title", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "The title the running program set, if it set one. Text somebody else wrote, so a caller showing it owes it the same treatment as any other content it did not write.", "documentation": "The title the running program set, if it set one. Text somebody else\nwrote, so a caller showing it owes it the same treatment as any other\ncontent it did not write.", "signature": "pub fn title (& self) -> Option<& str>", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::Emulator::update_selection", "name": "update_selection", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Extend the selection in progress. Does nothing without one, so a drag that never started cannot invent a selection out of a pointer move.", "documentation": "Extend the selection in progress. Does nothing without one, so a drag\nthat never started cannot invent a selection out of a pointer move.", "signature": "pub fn update_selection (& mut self, point : GridPoint, side : CellSide)", "cfg": [], "target": "Emulator" }, { "id": "gpui_kit::content::terminal::emulator::GridPoint", "name": "GridPoint", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "A place on the grid, in the coordinates a *selection* anchors to.", "documentation": "A place on the grid, in the coordinates a *selection* anchors to.\n\n`line` is signed and counts down from the live viewport, so a negative line\nis scrollback. That is the difference between this and a viewport row: a\nviewport row is what a pointer hits and moves out from under the text as\noutput arrives, while a grid point stays on the text it named. Anchoring in\ngrid space is the whole reason a selection survives the screen scrolling.", "signature": "# [doc = \" A place on the grid, in the coordinates a *selection* anchors to.\"] # [doc = \"\"] # [doc = \" `line` is signed and counts down from the live viewport, so a negative line\"] # [doc = \" is scrollback. That is the difference between this and a viewport row: a\"] # [doc = \" viewport row is what a pointer hits and moves out from under the text as\"] # [doc = \" output arrives, while a grid point stays on the text it named. Anchoring in\"] # [doc = \" grid space is the whole reason a selection survives the screen scrolling.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct GridPoint { pub line : i32, pub column : usize, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::GridPoint::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "", "documentation": "", "signature": "pub fn new (line : i32, column : usize) -> Self", "cfg": [], "target": "GridPoint" }, { "id": "gpui_kit::content::terminal::emulator::GridSize", "name": "GridSize", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "The viewport, in cells.", "documentation": "The viewport, in cells.", "signature": "# [doc = \" The viewport, in cells.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct GridSize { pub cols : u16, pub rows : u16, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::GridSize::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Clamps to a grid that can hold something. A zero-column terminal is not a smaller terminal, it is a division by zero waiting to happen, and the caller measuring one has a window mid-collapse rather than an opinion.", "documentation": "Clamps to a grid that can hold something. A zero-column terminal is not\na smaller terminal, it is a division by zero waiting to happen, and the\ncaller measuring one has a window mid-collapse rather than an opinion.", "signature": "pub fn new (cols : u16, rows : u16) -> Self", "cfg": [], "target": "GridSize" }, { "id": "gpui_kit::content::terminal::emulator::SCROLLBACK_LINES", "name": "SCROLLBACK_LINES", "kind": "constant", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "Scrollback kept on the client, in lines.", "documentation": "Scrollback kept on the client, in lines.\n\nIt bounds what stays scrollable in the view and nothing else: whatever\nwindow of output the host keeps for itself is a separate decision, made\nwhere the output comes from.", "signature": "pub const SCROLLBACK_LINES: usize", "cfg": [] }, { "id": "gpui_kit::content::terminal::emulator::SelectionKind", "name": "SelectionKind", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::emulator", "path": "gpui_kit::content::terminal::emulator", "source": "crates/gpui-kit/src/content/terminal/emulator.rs", "summary": "How much a selection takes per gesture: a drag, a double-click word, a triple-click row.", "documentation": "How much a selection takes per gesture: a drag, a double-click word, a\ntriple-click row.\n\nThe granularity is the emulator's business rather than the caller's because\ndeciding where a word ends means reading the grid, and a caller that did it\nfrom the text it can see would disagree with the copy it gets back.", "signature": "# [doc = \" How much a selection takes per gesture: a drag, a double-click word, a\"] # [doc = \" triple-click row.\"] # [doc = \"\"] # [doc = \" The granularity is the emulator's business rather than the caller's because\"] # [doc = \" deciding where a word ends means reading the grid, and a caller that did it\"] # [doc = \" from the text it can see would disagree with the copy it gets back.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum SelectionKind { Drag, Word, Line, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::COALESCE_MS", "name": "COALESCE_MS", "kind": "constant", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "How long keyboard bytes are held before the host is told to write them.", "documentation": "How long keyboard bytes are held before the host is told to write them.\n\nA held key repeats faster than a frame, and a write per repeat turns a\nscrolled page into a write storm. The timer belongs to the host; the buffer\nunder it is [`InputCoalescer`], which is pure.", "signature": "pub const COALESCE_MS: u64", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::CellHit", "name": "CellHit", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Which cell a pointer landed on, and which edge of it an anchor takes.", "documentation": "Which cell a pointer landed on, and which edge of it an anchor takes.", "signature": "# [doc = \" Which cell a pointer landed on, and which edge of it an anchor takes.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub struct CellHit { pub row : usize, pub col : usize, pub side : CellSide, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::InputCoalescer", "name": "InputCoalescer", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Holds keyboard bytes between flushes.", "documentation": "Holds keyboard bytes between flushes.\n\n[`Self::push`] reports `true` exactly when a flush should be scheduled — the\nbuffer having been empty — so a burst of repeats schedules one timer rather\nthan one per key.", "signature": "# [doc = \" Holds keyboard bytes between flushes.\"] # [doc = \"\"] # [doc = \" [`Self::push`] reports `true` exactly when a flush should be scheduled — the\"] # [doc = \" buffer having been empty — so a burst of repeats schedules one timer rather\"] # [doc = \" than one per key.\"] # [derive (Debug, Default)] pub struct InputCoalescer { pending : Vec, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::InputCoalescer::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "", "documentation": "", "signature": "pub fn is_empty (& self) -> bool", "cfg": [], "target": "InputCoalescer" }, { "id": "gpui_kit::content::terminal::input::InputCoalescer::push", "name": "push", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Add bytes, reporting whether a flush now needs scheduling.", "documentation": "Add bytes, reporting whether a flush now needs scheduling.", "signature": "pub fn push (& mut self, bytes : & [u8]) -> bool", "cfg": [], "target": "InputCoalescer" }, { "id": "gpui_kit::content::terminal::input::InputCoalescer::take", "name": "take", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Take everything buffered, leaving the coalescer empty.", "documentation": "Take everything buffered, leaving the coalescer empty.", "signature": "pub fn take (& mut self) -> Vec", "cfg": [], "target": "InputCoalescer" }, { "id": "gpui_kit::content::terminal::input::RESIZE_DEBOUNCE_MS", "name": "RESIZE_DEBOUNCE_MS", "kind": "constant", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "How long a measured grid size waits before the host is told to resize.", "documentation": "How long a measured grid size waits before the host is told to resize.\n\nA drag across a window edge produces a size per frame, and a program that\nredraws on `SIGWINCH` redraws for each one. Waiting for the drag to settle\ncosts a moment of stale wrapping and saves the redraw storm.", "signature": "pub const RESIZE_DEBOUNCE_MS: u64", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::SELECTION_DRAG_THRESHOLD", "name": "SELECTION_DRAG_THRESHOLD", "kind": "constant", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "How far a pointer travels before a press becomes a selection.", "documentation": "How far a pointer travels before a press becomes a selection.\n\nWithout a threshold, the click that focuses the panel starts a one-cell\nselection whenever the hand moves a pixel, and a host that copies on\nselection change then clobbers the clipboard on every click.", "signature": "pub const SELECTION_DRAG_THRESHOLD: f32", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::cell_at", "name": "cell_at", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Map a position measured from the grid's first glyph onto a cell.", "documentation": "Map a position measured from the grid's first glyph onto a cell.\n\nA position outside the grid clamps to the nearest cell rather than reporting\nnothing, because that is what a drag needs: the pointer routinely leaves the\npanel mid-gesture, and the selection should reach the edge it left through\ninstead of freezing at the last sample taken inside.\n\nOvershoot also *forces the side*, which clamping alone does not do. Dragging\npast the bottom should take the last row whole even when the pointer drifted\nleft of where it started, and deriving the side from x there would stop the\nselection mid-row.", "signature": "pub fn cell_at (x : f32, y : f32, cell_width : f32, line_height : f32, cols : usize, rows : usize,) -> CellHit", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::control_bytes", "name": "control_bytes", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Encode a Ctrl combination in caret notation.", "documentation": "Encode a Ctrl combination in caret notation.\n\nPublic because a host with its own keymap has to be able to ask what\n`ctrl-c` is without going through a whole `Modifiers`.", "signature": "pub fn control_bytes (key : & str) -> Option>", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::keystroke_bytes", "name": "keystroke_bytes", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Encode a keystroke as terminal bytes, or report that it is not the terminal's.", "documentation": "Encode a keystroke as terminal bytes, or report that it is not the\nterminal's.\n\n`None` is not a failure: it is how a keystroke falls through to the\napplication keymap. A platform-primary combination is always the\napplication's, because a terminal that swallowed it would take the window's\nclose and quit with it.\n\n`app_cursor` is DECCKM, and it is why this needs the emulator's mode rather\nthan a fixed table: the same arrow key is `ESC [ A` normally and `ESC O A`\nonce a full-screen program has asked for application cursor keys.", "signature": "pub fn keystroke_bytes (key : & str, key_char : Option<& str>, modifiers : & Modifiers, app_cursor : bool,) -> Option>", "cfg": [] }, { "id": "gpui_kit::content::terminal::input::paste_bytes", "name": "paste_bytes", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::input", "path": "gpui_kit::content::terminal::input", "source": "crates/gpui-kit/src/content/terminal/input.rs", "summary": "Wrap pasted text for the terminal.", "documentation": "Wrap pasted text for the terminal.\n\nThe end marker is stripped whatever the mode, and that is a safety property\nrather than tidiness: text containing `ESC [201~` would otherwise end the\nbracket early and hand the rest of itself to the shell as typed input, which\nis how a copied block of text runs a command nobody typed.", "signature": "pub fn paste_bytes (text : & str, bracketed : bool) -> Vec", "cfg": [] }, { "id": "gpui_kit::content::terminal::reexport-1", "name": "emulator :: { CellColor , CellSide , CellSnapshot , CursorSnapshot , Emulator , GridPoint , GridSize , SCROLLBACK_LINES , SelectionKind , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal", "path": "gpui_kit::content::terminal", "source": "crates/gpui-kit/src/content/terminal/mod.rs", "summary": "", "documentation": "", "signature": "pub use emulator::{ CellColor, CellSide, CellSnapshot, CursorSnapshot, Emulator, GridPoint, GridSize, SCROLLBACK_LINES, SelectionKind, };", "cfg": [] }, { "id": "gpui_kit::content::terminal::reexport-2", "name": "input :: { COALESCE_MS , CellHit , InputCoalescer , RESIZE_DEBOUNCE_MS , SELECTION_DRAG_THRESHOLD , cell_at , control_bytes , keystroke_bytes , paste_bytes , }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal", "path": "gpui_kit::content::terminal", "source": "crates/gpui-kit/src/content/terminal/mod.rs", "summary": "", "documentation": "", "signature": "pub use input::{ COALESCE_MS, CellHit, InputCoalescer, RESIZE_DEBOUNCE_MS, SELECTION_DRAG_THRESHOLD, cell_at, control_bytes, keystroke_bytes, paste_bytes, };", "cfg": [] }, { "id": "gpui_kit::content::terminal::reexport-3", "name": "view :: { GridGeometry , GridSnapshot , Terminal , TerminalEvent , TerminalState }", "kind": "reexport", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal", "path": "gpui_kit::content::terminal", "source": "crates/gpui-kit/src/content/terminal/mod.rs", "summary": "", "documentation": "", "signature": "pub use view::{ GridGeometry, GridSnapshot, Terminal, TerminalEvent, TerminalState };", "cfg": [] }, { "id": "gpui_kit::content::terminal::view::GridGeometry", "name": "GridGeometry", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "The grid the element measured, in the coordinates a pointer arrives in.", "documentation": "The grid the element measured, in the coordinates a pointer arrives in.", "signature": "# [doc = \" The grid the element measured, in the coordinates a pointer arrives in.\"] # [derive (Debug, Clone, Copy, PartialEq)] pub struct GridGeometry { # [doc = \" The top-left of the first glyph, in window space.\"] pub origin : Point, pub cell_width : f32, pub line_height : f32, pub cols : u16, pub rows : u16, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::view::GridSnapshot", "name": "GridSnapshot", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "What the host hands back to be painted.", "documentation": "What the host hands back to be painted.", "signature": "# [doc = \" What the host hands back to be painted.\"] pub struct GridSnapshot { pub lines : Vec>, pub cursor : Option, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::view::Terminal", "name": "Terminal", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "A terminal grid.", "documentation": "A terminal grid.", "signature": "# [doc = \" A terminal grid.\"] # [derive (IntoElement)] pub struct Terminal { ident : Ident, state : TerminalState, grid : Option, on_event : Option, focused : bool, scrollback : bool, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::view::Terminal::focused", "name": "focused", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "Whether the grid holds keyboard focus. A focused cursor is a filled block and an unfocused one an outline, which is the difference between \"typing goes here\" and \"this is where typing left off\".", "documentation": "Whether the grid holds keyboard focus. A focused cursor is a filled\nblock and an unfocused one an outline, which is the difference between\n\"typing goes here\" and \"this is where typing left off\".", "signature": "pub fn focused (mut self, focused : bool) -> Self", "cfg": [], "target": "Terminal" }, { "id": "gpui_kit::content::terminal::view::Terminal::grid", "name": "grid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "The host's once-a-frame hook: it is told the grid that fits and returns what to draw in it. Without one the panel draws its chrome and nothing else, which is what a terminal with no session looks like.", "documentation": "The host's once-a-frame hook: it is told the grid that fits and returns\nwhat to draw in it. Without one the panel draws its chrome and nothing\nelse, which is what a terminal with no session looks like.", "signature": "pub fn grid (mut self, grid : impl Fn (GridGeometry, & mut App) -> Option + 'static,) -> Self", "cfg": [], "target": "Terminal" }, { "id": "gpui_kit::content::terminal::view::Terminal::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "Terminal" }, { "id": "gpui_kit::content::terminal::view::Terminal::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (TerminalEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "Terminal" }, { "id": "gpui_kit::content::terminal::view::Terminal::scrollback", "name": "scrollback", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "Whether the wheel scrolls the view. A full-screen program on the alternate screen has no scrollback, and scrolling one is how a reader ends up dragging a view that cannot move.", "documentation": "Whether the wheel scrolls the view. A full-screen program on the\nalternate screen has no scrollback, and scrolling one is how a reader\nends up dragging a view that cannot move.", "signature": "pub fn scrollback (mut self, scrollback : bool) -> Self", "cfg": [], "target": "Terminal" }, { "id": "gpui_kit::content::terminal::view::Terminal::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "What is known about the session.", "documentation": "What is known about the session.", "signature": "pub fn state (mut self, state : TerminalState) -> Self", "cfg": [], "target": "Terminal" }, { "id": "gpui_kit::content::terminal::view::TerminalEvent", "name": "TerminalEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "What the grid reports. Every variant is the host's to act on.", "documentation": "What the grid reports. Every variant is the host's to act on.", "signature": "# [doc = \" What the grid reports. Every variant is the host's to act on.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum TerminalEvent { # [doc = \" A gesture began on a cell. The row is a *viewport* row, so the host\"] # [doc = \" turns it into a grid point with `Emulator::grid_point`, which is the\"] # [doc = \" only thing that knows how far the view is scrolled back.\"] SelectionStarted { hit : CellHit, kind : SelectionKind, }, SelectionUpdated { hit : CellHit, }, SelectionCleared, # [doc = \" The wheel asked to move the view, in lines; positive goes into history.\"] Scrolled { lines : i32, }, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::view::TerminalState", "name": "TerminalState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "What is known about the session behind the grid.", "documentation": "What is known about the session behind the grid.\n\nA terminal whose process never started and one whose process ended are not\nthe same thing as one with nothing on screen yet, and an empty grid is a\nperfectly ordinary Ready terminal.", "signature": "# [doc = \" What is known about the session behind the grid.\"] # [doc = \"\"] # [doc = \" A terminal whose process never started and one whose process ended are not\"] # [doc = \" the same thing as one with nothing on screen yet, and an empty grid is a\"] # [doc = \" perfectly ordinary Ready terminal.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum TerminalState { # [doc = \" A session is being opened. Nothing has been drawn yet.\"] Loading, # [doc = \" No session could be opened, and the host says why.\"] Unavailable (SharedString), # [doc = \" The session ended or failed, and the host says why. Whatever was last\"] # [doc = \" on the grid is not erased by this: a reader still needs to see it.\"] Error (SharedString), # [default] Ready, }", "cfg": [] }, { "id": "gpui_kit::content::terminal::view::TerminalState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::terminal::view", "path": "gpui_kit::content::terminal::view", "source": "crates/gpui-kit/src/content/terminal/view.rs", "summary": "", "documentation": "", "signature": "pub fn name (& self) -> & 'static str", "cfg": [], "target": "TerminalState" }, { "id": "gpui_kit::content::transport::BufferedRange", "name": "BufferedRange", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "One span of media the host already holds, in seconds.", "documentation": "One span of media the host already holds, in seconds.", "signature": "# [doc = \" One span of media the host already holds, in seconds.\"] # [derive (Debug, Clone, Copy, PartialEq)] pub struct BufferedRange { pub start : f32, pub end : f32, }", "cfg": [] }, { "id": "gpui_kit::content::transport::BufferedRange::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn new (start : f32, end : f32) -> Self", "cfg": [], "target": "BufferedRange" }, { "id": "gpui_kit::content::transport::MediaPresentation", "name": "MediaPresentation", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "The host's actual video presentation, independent of playback and window fullscreen.", "documentation": "The host's actual video presentation, independent of playback and window fullscreen.", "signature": "# [doc = \" The host's actual video presentation, independent of playback and window fullscreen.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum MediaPresentation { # [default] Inline, Fullscreen, }", "cfg": [] }, { "id": "gpui_kit::content::transport::MediaPresentation::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "MediaPresentation" }, { "id": "gpui_kit::content::transport::TrackStep", "name": "TrackStep", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Which way a previous or next control steps.", "documentation": "Which way a previous or next control steps.", "signature": "# [doc = \" Which way a previous or next control steps.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum TrackStep { Previous, Next, }", "cfg": [] }, { "id": "gpui_kit::content::transport::TrackStep::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "TrackStep" }, { "id": "gpui_kit::content::transport::TransportBar", "name": "TransportBar", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "A transport for one piece of media.", "documentation": "A transport for one piece of media.", "signature": "# [doc = \" A transport for one piece of media.\"] # [derive (IntoElement)] pub struct TransportBar { ident : Ident, label : Option, state : TransportState, position : f32, duration : TransportDuration, elapsed : Option, remaining : Option, buffered : Vec, volume : f32, muted : bool, speed : f32, speeds : Vec, step : f32, seekable : bool, volume_control : bool, has_previous : bool, has_next : bool, control_size : ControlSize, presentation : Option<(MediaPresentation, SharedString)>, presentation_refusal : Option, disabled : bool, on_event : Option, }", "cfg": [] }, { "id": "gpui_kit::content::transport::TransportBar::buffered", "name": "buffered", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "The spans the host already holds. Supplying none draws no buffer.", "documentation": "The spans the host already holds. Supplying none draws no buffer.", "signature": "pub fn buffered (mut self, ranges : impl IntoIterator) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::duration", "name": "duration", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn duration (mut self, seconds : f32) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::elapsed", "name": "elapsed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "How far in the media is, in the host's own words. This crate formats no durations.", "documentation": "How far in the media is, in the host's own words. This crate formats\nno durations.", "signature": "pub fn elapsed (mut self, elapsed : impl Into) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::has_next", "name": "has_next", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn has_next (mut self, has_next : bool) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::has_previous", "name": "has_previous", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn has_previous (mut self, has_previous : bool) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "What is playing, shown beside the controls.", "documentation": "What is playing, shown beside the controls.", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::muted", "name": "muted", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn muted (mut self, muted : bool) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::on_event", "name": "on_event", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn on_event (mut self, handler : impl Fn (& TransportEvent, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::position", "name": "position", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Where the caller says the head is, in seconds.", "documentation": "Where the caller says the head is, in seconds.", "signature": "pub fn position (mut self, seconds : f32) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::presentation", "name": "presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Offers a host-supported presentation toggle. `label` names the next action in the host's locale; `state` is the verified presentation, not the request. Omit this method when native presentation is unsupported.", "documentation": "Offers a host-supported presentation toggle. `label` names the next action\nin the host's locale; `state` is the verified presentation, not the request.\nOmit this method when native presentation is unsupported.", "signature": "pub fn presentation (mut self, state : MediaPresentation, label : impl Into,) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::presentation_refused", "name": "presentation_refused", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Keeps the actual presentation visible and disables its request with the host's reason. Other playback controls remain independent.", "documentation": "Keeps the actual presentation visible and disables its request with the\nhost's reason. Other playback controls remain independent.", "signature": "pub fn presentation_refused (mut self, reason : impl Into) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::remaining", "name": "remaining", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "How much is left, in the host's own words. Without one nothing is shown, because the remainder is a duration and this crate computes none.", "documentation": "How much is left, in the host's own words. Without one nothing is\nshown, because the remainder is a duration and this crate computes\nnone.", "signature": "pub fn remaining (mut self, remaining : impl Into) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::seekable", "name": "seekable", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Whether the transport accepts seeks.", "documentation": "Whether the transport accepts seeks.\n\nA false capability keeps the position visible but installs no pointer,\nkeyboard, or native slider action for moving it.", "signature": "pub fn seekable (mut self, seekable : bool) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::speeds", "name": "speeds", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "The speeds the host offers, and which of them holds. Offering none leaves the control out entirely.", "documentation": "The speeds the host offers, and which of them holds. Offering none\nleaves the control out entirely.", "signature": "pub fn speeds (mut self, speeds : impl IntoIterator, current : f32) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn state (mut self, state : TransportState) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::step_seconds", "name": "step_seconds", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "How far one arrow key jumps, in seconds.", "documentation": "How far one arrow key jumps, in seconds.\n\nA caller input, because whether an arrow should move a second or a\nminute is a judgement about the media, and this component knows\nnothing about the media.", "signature": "pub fn step_seconds (mut self, seconds : f32) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::unknown_duration", "name": "unknown_duration", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Says there is a position and no total, for a live stream.", "documentation": "Says there is a position and no total, for a live stream.", "signature": "pub fn unknown_duration (mut self) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::volume", "name": "volume", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Where the volume control sits, between zero and one.", "documentation": "Where the volume control sits, between zero and one.", "signature": "pub fn volume (mut self, volume : f32) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportBar::volume_control", "name": "volume_control", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "Whether mute and volume controls are meaningful for this transport. Unsupported controls are absent rather than disabled forever.", "documentation": "Whether mute and volume controls are meaningful for this transport.\nUnsupported controls are absent rather than disabled forever.", "signature": "pub fn volume_control (mut self, available : bool) -> Self", "cfg": [], "target": "TransportBar" }, { "id": "gpui_kit::content::transport::TransportDuration", "name": "TransportDuration", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "How long the media runs, as far as the host knows.", "documentation": "How long the media runs, as far as the host knows.\n\n`Unknown` is a live stream: there is a position and there is no total, and\na bar that drew a fraction anyway would be reporting a number nobody has.", "signature": "# [doc = \" How long the media runs, as far as the host knows.\"] # [doc = \"\"] # [doc = \" `Unknown` is a live stream: there is a position and there is no total, and\"] # [doc = \" a bar that drew a fraction anyway would be reporting a number nobody has.\"] # [derive (Debug, Clone, Copy, PartialEq)] pub enum TransportDuration { Known (f32), Unknown, }", "cfg": [] }, { "id": "gpui_kit::content::transport::TransportDuration::is_known", "name": "is_known", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn is_known (self) -> bool", "cfg": [], "target": "TransportDuration" }, { "id": "gpui_kit::content::transport::TransportDuration::seconds", "name": "seconds", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "", "documentation": "", "signature": "pub fn seconds (self) -> Option", "cfg": [], "target": "TransportDuration" }, { "id": "gpui_kit::content::transport::TransportEvent", "name": "TransportEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "What a transport reports. It applies none of it.", "documentation": "What a transport reports. It applies none of it.", "signature": "# [doc = \" What a transport reports. It applies none of it.\"] # [derive (Debug, Clone, PartialEq)] pub enum TransportEvent { PlayRequested, PauseRequested, # [doc = \" Where the scrubber is while it is being dragged, in seconds.\"] # [doc = \"\"] # [doc = \" Reported on every move so a host can show a preview frame, and never\"] # [doc = \" as a seek, so a host does not seek once per pixel.\"] SeekPreview (f32), # [doc = \" Abandon any host preview without seeking or changing the verified position.\"] SeekCancelled, # [doc = \" Where the reader let go, or where a key asked to go, in seconds.\"] SeekRequested (f32), VolumeRequested (f32), MuteToggled, SpeedRequested (f32), Stepped (TrackStep), # [doc = \" Intent only. The host must present/dismiss the native video controller,\"] # [doc = \" then supply its actual state or refusal; this never changes the window.\"] PresentationRequested (MediaPresentation), }", "cfg": [] }, { "id": "gpui_kit::content::transport::TransportState", "name": "TransportState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "What the transport is doing, as the host reports it.", "documentation": "What the transport is doing, as the host reports it.", "signature": "# [doc = \" What the transport is doing, as the host reports it.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum TransportState { Playing, # [default] Paused, # [doc = \" Playing, and waiting for data. This is not paused, and it does not\"] # [doc = \" offer the control that would resume, because nothing has stopped.\"] Buffering, }", "cfg": [] }, { "id": "gpui_kit::content::transport::TransportState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "content::transport", "path": "gpui_kit::content::transport", "source": "crates/gpui-kit/src/content/transport.rs", "summary": "The name a semantic node publishes, so a test asserts the state rather than the label drawn for it.", "documentation": "The name a semantic node publishes, so a test asserts the state rather\nthan the label drawn for it.", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "TransportState" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput", "name": "OneTimeCodeInput", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "One sensitive editor presented as a bounded run of visual slots.", "documentation": "One sensitive editor presented as a bounded run of visual slots.\n\nA slot accepts one Unicode grapheme. The slots are not fields: one\n`TextInput` owns the focus, selection, composition, paste, and native text\nactions for the entire control.", "signature": "# [doc = \" One sensitive editor presented as a bounded run of visual slots.\"] # [doc = \"\"] # [doc = \" A slot accepts one Unicode grapheme. The slots are not fields: one\"] # [doc = \" `TextInput` owns the focus, selection, composition, paste, and native text\"] # [doc = \" actions for the entire control.\"] pub struct OneTimeCodeInput { ident : Ident, field : Entity, name : Option, initial : Option, slots : usize, size : ControlSize, input_options : gpui::TextInputOptions, disabled : bool, invalid : bool, required : bool, read_only : bool, seeded : bool, configured : bool, _subscriptions : Vec, }", "cfg": [] }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::input_options", "name": "input_options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Requests keyboard/autofill hints. `OneTimeCode` is only an operating system hint: clipboard paste is not SMS autofill, and this control neither reads SMS nor guarantees suggestions. Alphanumeric codes remain valid; callers choose whether a numeric keyboard suits their code.", "documentation": "Requests keyboard/autofill hints. `OneTimeCode` is only an operating\nsystem hint: clipboard paste is not SMS autofill, and this control\nneither reads SMS nor guarantees suggestions. Alphanumeric codes remain\nvalid; callers choose whether a numeric keyboard suits their code.", "signature": "pub fn input_options (mut self, options : gpui::TextInputOptions) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::invalid", "name": "invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn invalid (mut self, invalid : bool) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::is_complete", "name": "is_complete", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn is_complete (& self, cx : & App) -> bool", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::is_disabled", "name": "is_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn is_disabled (& self) -> bool", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::is_empty", "name": "is_empty", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn is_empty (& self, cx : & App) -> bool", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::len", "name": "len", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn len (& self, cx : & App) -> usize", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Names the one native sensitive input when its visible label is outside this view.", "documentation": "Names the one native sensitive input when its visible label is outside\nthis view.", "signature": "pub fn name (mut self, name : impl Into) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, window : & mut Window, cx : & mut Context) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::read_only", "name": "read_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn read_only (mut self, read_only : bool) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::required", "name": "required", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn required (mut self, required : bool) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_control_size", "name": "set_control_size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_control_size (& mut self, size : ControlSize, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_disabled", "name": "set_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_disabled (& mut self, disabled : bool, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_input_options", "name": "set_input_options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Updates hints without resetting code slots or the sensitive editor.", "documentation": "Updates hints without resetting code slots or the sensitive editor.", "signature": "pub fn set_input_options (& mut self, options : gpui::TextInputOptions, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_invalid", "name": "set_invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_invalid (& mut self, invalid : bool, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_name", "name": "set_name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "`None` removes the accessible name without replacing the sensitive editor.", "documentation": "`None` removes the accessible name without replacing the sensitive editor.", "signature": "pub fn set_name (& mut self, name : Option, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_read_only", "name": "set_read_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_read_only (& mut self, read_only : bool, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_required", "name": "set_required", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_required (& mut self, required : bool, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_slots", "name": "set_slots", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Changes the visual slots and future input limit. Existing text is retained.", "documentation": "Changes the visual slots and future input limit. Existing text is retained.", "signature": "pub fn set_slots (& mut self, slots : usize, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::set_value", "name": "set_value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_value (& mut self, value : impl Into, cx : & mut Context)", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::slot_count", "name": "slot_count", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn slot_count (& self) -> usize", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::slots", "name": "slots", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Chooses the visual/code length. Values outside 1 through 12 use the nearest bound so the control remains legible and finite.", "documentation": "Chooses the visual/code length. Values outside 1 through 12 use the\nnearest bound so the control remains legible and finite.", "signature": "pub fn slots (mut self, slots : usize) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Seeds the sensitive text without reporting a caller edit.", "documentation": "Seeds the sensitive text without reporting a caller edit.", "signature": "pub fn text (mut self, text : impl Into) -> Self", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInput::value", "name": "value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn value (& self, cx : & App) -> SharedString", "cfg": [], "target": "OneTimeCodeInput" }, { "id": "gpui_kit::controls::auth::OneTimeCodeInputEvent", "name": "OneTimeCodeInputEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "What a one-time code field reports to its owner.", "documentation": "What a one-time code field reports to its owner.", "signature": "# [doc = \" What a one-time code field reports to its owner.\"] # [derive (Clone, PartialEq, Eq)] pub enum OneTimeCodeInputEvent { Change (SharedString), Submit, }", "cfg": [] }, { "id": "gpui_kit::controls::auth::PasswordInput", "name": "PasswordInput", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "One sensitive password editor with a visual reveal action.", "documentation": "One sensitive password editor with a visual reveal action.\n\nRevealing changes only the pixels. The value remains a secret for\ndeterministic semantics, AccessKit text runs and values, Debug, and\nclipboard copy/cut.", "signature": "# [doc = \" One sensitive password editor with a visual reveal action.\"] # [doc = \"\"] # [doc = \" Revealing changes only the pixels. The value remains a secret for\"] # [doc = \" deterministic semantics, AccessKit text runs and values, Debug, and\"] # [doc = \" clipboard copy/cut.\"] pub struct PasswordInput { ident : Ident, field : Entity, reveal_focus : FocusHandle, placeholder : Option, name : Option, initial : Option, size : ControlSize, input_options : gpui::TextInputOptions, disabled : bool, invalid : bool, required : bool, read_only : bool, revealed : bool, seeded : bool, configured : bool, _subscriptions : Vec, }", "cfg": [] }, { "id": "gpui_kit::controls::auth::PasswordInput::bind", "name": "bind", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Keeps a password field and a caller-owned [`Signal`] holding the same text.", "documentation": "Keeps a password field and a caller-owned [`Signal`] holding the same\ntext.\n\nThe signal is the caller's storage for a credential, and it stays the\ncaller's: nothing here writes it anywhere else, and a [`Signal`] does\nnot print what it holds. Neither direction fires when the two already\nagree.\n\nThe subscriptions are the binding: the caller holds them for as long\nas the field and the signal should stay together.", "signature": "pub fn bind (field : & Entity, signal : & Signal, cx : & mut App) -> Vec", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::input_options", "name": "input_options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Caller-selected keyboard and autofill hints; reveal never removes the editor's secure flag. Next/previous emit [`gpui::TextInputAction`].", "documentation": "Caller-selected keyboard and autofill hints; reveal never removes the\neditor's secure flag. Next/previous emit [`gpui::TextInputAction`].", "signature": "pub fn input_options (mut self, options : gpui::TextInputOptions) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::invalid", "name": "invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn invalid (mut self, invalid : bool) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::is_disabled", "name": "is_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn is_disabled (& self) -> bool", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::is_revealed", "name": "is_revealed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn is_revealed (& self) -> bool", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Names the one native password input when its visible label is outside this view.", "documentation": "Names the one native password input when its visible label is outside\nthis view.", "signature": "pub fn name (mut self, name : impl Into) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, window : & mut Window, cx : & mut Context) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::placeholder", "name": "placeholder", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn placeholder (mut self, placeholder : impl Into) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::read_only", "name": "read_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn read_only (mut self, read_only : bool) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::required", "name": "required", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn required (mut self, required : bool) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::selected_range", "name": "selected_range", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn selected_range (& self, cx : & App) -> Range", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_control_size", "name": "set_control_size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_control_size (& mut self, size : ControlSize, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_disabled", "name": "set_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_disabled (& mut self, disabled : bool, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_input_options", "name": "set_input_options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Updates native hints while retaining the sensitive editing session.", "documentation": "Updates native hints while retaining the sensitive editing session.", "signature": "pub fn set_input_options (& mut self, options : gpui::TextInputOptions, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_invalid", "name": "set_invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_invalid (& mut self, invalid : bool, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_name", "name": "set_name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "`None` removes the name without replacing the sensitive editor.", "documentation": "`None` removes the name without replacing the sensitive editor.", "signature": "pub fn set_name (& mut self, name : Option, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_placeholder", "name": "set_placeholder", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "`None` restores the native empty placeholder.", "documentation": "`None` restores the native empty placeholder.", "signature": "pub fn set_placeholder (& mut self, placeholder : Option, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_read_only", "name": "set_read_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_read_only (& mut self, read_only : bool, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_required", "name": "set_required", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_required (& mut self, required : bool, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::set_value", "name": "set_value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn set_value (& mut self, value : impl Into, cx : & mut Context)", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "Seeds the sensitive text without reporting a caller edit.", "documentation": "Seeds the sensitive text without reporting a caller edit.", "signature": "pub fn text (mut self, text : impl Into) -> Self", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInput::value", "name": "value", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "", "documentation": "", "signature": "pub fn value (& self, cx : & App) -> SharedString", "cfg": [], "target": "PasswordInput" }, { "id": "gpui_kit::controls::auth::PasswordInputEvent", "name": "PasswordInputEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::auth", "path": "gpui_kit::controls::auth", "source": "crates/gpui-kit/src/controls/auth.rs", "summary": "What a password field reports to its owner.", "documentation": "What a password field reports to its owner.", "signature": "# [doc = \" What a password field reports to its owner.\"] # [derive (Clone, PartialEq, Eq)] pub enum PasswordInputEvent { Change (SharedString), Submit, Cancel, BackspaceAtStart, Focus, Blur, }", "cfg": [] }, { "id": "gpui_kit::controls::button::Button", "name": "Button", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "A labeled action.", "documentation": "A labeled action.\n\nThe click handler is only installed when the button is enabled and not\nloading, so an unavailable action cannot fire through a stray event.", "signature": "# [doc = \" A labeled action.\"] # [doc = \"\"] # [doc = \" The click handler is only installed when the button is enabled and not\"] # [doc = \" loading, so an unavailable action cannot fire through a stray event.\"] # [derive (IntoElement)] pub struct Button { ident : Ident, semantic_parent : Option, focus_handle : Option, label : Option, # [doc = \" What the button is called when the label is not what it is called, or\"] # [doc = \" when there is no label at all.\"] name : Option, description : Option, glyph : Option, icon_position : IconPosition, variant : ButtonVariant, tier : Option, color : Option, ground : Surface, size : ControlSize, disabled : bool, selected : bool, checked : Option, loading : bool, full_width : bool, icon_only : bool, join : ButtonJoin, on_click : Option, }", "cfg": [] }, { "id": "gpui_kit::controls::button::Button::accessible_description", "name": "accessible_description", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Adds supplementary literal help to the native button node.", "documentation": "Adds supplementary literal help to the native button node.", "signature": "pub fn accessible_description (mut self, description : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::accessible_name", "name": "accessible_name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "What assistive technology and a test call this action.", "documentation": "What assistive technology and a test call this action.\n\nOverrides the label, which a graphic button does not have.", "signature": "pub fn accessible_name (mut self, name : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::checked_state", "name": "checked_state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Publishes an explicit two-state answer, for a button that stays in.", "documentation": "Publishes an explicit two-state answer, for a button that stays in.\n\nA selected button publishes `checked` only when it is selected, because\n\"this is the current one\" has no meaningful false. A toggle does: out\nis a state, not the absence of one, so it says so.", "signature": "pub fn checked_state (mut self, checked : bool) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "The colour the shared tiers are resolved against.", "documentation": "The colour the shared tiers are resolved against.\n\nSetting a colour moves the button onto [`Theme::variant_colors`]; the\ntier defaults to the one the current weight maps to, so `.danger()`\nwith a colour keeps reading as filled intent in that colour.", "signature": "pub fn color (mut self, color : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::danger", "name": "danger", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn danger (self) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::full_width", "name": "full_width", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn full_width (mut self, full_width : bool) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::ghost", "name": "ghost", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn ghost (self) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::ground", "name": "ground", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "The surface this control stands on.", "documentation": "The surface this control stands on.\n\nA neutral button normally takes the raised surface step above a panel.\nWhen that step does not clear the theme's surface-separation floor over\nthe ground named here, it uses the shared light-tier neutral wash\ninstead. The default remains [`Surface::Panel`], preserving the paint\nof buttons built before this setting existed.", "signature": "pub fn ground (mut self, ground : Surface) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::icon", "name": "icon", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn icon (mut self, glyph : Icon) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::icon_only", "name": "icon_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Draws the button as a square carrying only its glyph, and names it.", "documentation": "Draws the button as a square carrying only its glyph, and names it.\n\nThe name is required rather than optional because a glyph on its own\nis an action nobody can announce or address.", "signature": "pub fn icon_only (mut self, glyph : Icon, name : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::icon_position", "name": "icon_position", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn icon_position (mut self, position : IconPosition) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::join", "name": "join", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Places the button in a joined run.", "documentation": "Places the button in a joined run.", "signature": "pub fn join (mut self, join : ButtonJoin) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::link", "name": "link", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn link (self) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::loading", "name": "loading", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Marks the action as in flight. A loading button is not actionable.", "documentation": "Marks the action as in flight. A loading button is not actionable.", "signature": "pub fn loading (mut self, loading : bool) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "A new button carries Primary weight until told otherwise: it is the one decision its local area is asking for, so a second action on the same surface must say it is [`Button::secondary`] or [`Button::ghost`]. [`IconButton`] starts Ghost instead, because a bare glyph is almost never that one decision.", "documentation": "A new button carries Primary weight until told otherwise: it is the\none decision its local area is asking for, so a second action on the\nsame surface must say it is [`Button::secondary`] or [`Button::ghost`].\n[`IconButton`] starts Ghost instead, because a bare glyph is almost\nnever that one decision.", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::on_click", "name": "on_click", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn on_click (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::primary", "name": "primary", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn primary (self) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::secondary", "name": "secondary", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn secondary (self) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::semantic_parent", "name": "semantic_parent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Names the surface this action belongs to in the semantic tree, so a reader can tell which notification or row an action came from.", "documentation": "Names the surface this action belongs to in the semantic tree, so a\nreader can tell which notification or row an action came from.", "signature": "pub fn semantic_parent (mut self, parent : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::track_focus", "name": "track_focus", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Puts the button on a caller-owned focus handle.", "documentation": "Puts the button on a caller-owned focus handle.\n\nAn overlay that keeps its own tab order needs a handle it can focus\ndirectly, and the published node then reports whether the keyboard is\non this action.", "signature": "pub fn track_focus (mut self, handle : & FocusHandle) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::Button::variant", "name": "variant", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn variant (mut self, variant : impl Into) -> Self", "cfg": [], "target": "Button" }, { "id": "gpui_kit::controls::button::ButtonGroup", "name": "ButtonGroup", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Adjacent related actions sharing one frame.", "documentation": "Adjacent related actions sharing one frame.\n\nThe group reports nothing: every action still reports itself, and the\ngroup only decides where the corners are. It publishes a `Group` node so\nthe actions inside it can be addressed as a set, and names each button as\nits child.", "signature": "# [doc = \" Adjacent related actions sharing one frame.\"] # [doc = \"\"] # [doc = \" The group reports nothing: every action still reports itself, and the\"] # [doc = \" group only decides where the corners are. It publishes a `Group` node so\"] # [doc = \" the actions inside it can be addressed as a set, and names each button as\"] # [doc = \" its child.\"] # [derive (IntoElement)] pub struct ButtonGroup { ident : Ident, buttons : Vec>, size : ControlSize, disabled : bool, }", "cfg": [] }, { "id": "gpui_kit::controls::button::ButtonGroup::child", "name": "child", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn child (mut self, button : impl Into>) -> Self", "cfg": [], "target": "ButtonGroup" }, { "id": "gpui_kit::controls::button::ButtonGroup::children", "name": "children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn children>> (mut self, buttons : impl IntoIterator,) -> Self", "cfg": [], "target": "ButtonGroup" }, { "id": "gpui_kit::controls::button::ButtonGroup::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into) -> Self", "cfg": [], "target": "ButtonGroup" }, { "id": "gpui_kit::controls::button::ButtonJoin", "name": "ButtonJoin", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Where a button sits in a joined run of them.", "documentation": "Where a button sits in a joined run of them.\n\nA joined button gives up the radius on the side it touches its neighbour\nand overlaps its border, so the run reads as one frame.", "signature": "# [doc = \" Where a button sits in a joined run of them.\"] # [doc = \"\"] # [doc = \" A joined button gives up the radius on the side it touches its neighbour\"] # [doc = \" and overlaps its border, so the run reads as one frame.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum ButtonJoin { # [default] Alone, Leading, Middle, Trailing, }", "cfg": [] }, { "id": "gpui_kit::controls::button::ButtonStyle", "name": "ButtonStyle", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Either presentation vocabulary a button accepts.", "documentation": "Either presentation vocabulary a button accepts.\n\n[`ButtonVariant`] is the button's own weight ladder; [`Variant`] is the\nshared tier system every coloured component resolves through\n[`Theme::variant_colors`]. `.variant(..)` takes both, so a caller moving\nto the shared tiers changes an argument, not a method.", "signature": "# [doc = \" Either presentation vocabulary a button accepts.\"] # [doc = \"\"] # [doc = \" [`ButtonVariant`] is the button's own weight ladder; [`Variant`] is the\"] # [doc = \" shared tier system every coloured component resolves through\"] # [doc = \" [`Theme::variant_colors`]. `.variant(..)` takes both, so a caller moving\"] # [doc = \" to the shared tiers changes an argument, not a method.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum ButtonStyle { Weight (ButtonVariant), Tier (Variant), }", "cfg": [] }, { "id": "gpui_kit::controls::button::ButtonVariant", "name": "ButtonVariant", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "How much weight an action carries. Primary is the one decision a local area is asking for; Danger is reserved for irreversible intent.", "documentation": "How much weight an action carries. Primary is the one decision a local\narea is asking for; Danger is reserved for irreversible intent.", "signature": "# [doc = \" How much weight an action carries. Primary is the one decision a local\"] # [doc = \" area is asking for; Danger is reserved for irreversible intent.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum ButtonVariant { # [default] Primary, Secondary, Ghost, Danger, Link, }", "cfg": [] }, { "id": "gpui_kit::controls::button::IconButton", "name": "IconButton", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "An action carried by a glyph alone.", "documentation": "An action carried by a glyph alone.\n\nThe accessible name is a constructor argument rather than an option: an\nicon with no name is an action neither a screen reader nor a test can\naddress, and there is no sensible default for what a picture means.\nEverything else — tone, size, refusal, the action in flight — is\n[`Button`]'s behaviour, reused rather than reimplemented.\n\nWhere [`Button`] starts Primary, this starts Ghost: a bare glyph is\nalmost never the one decision an area is asking for, so weight on one is\nsomething a caller opts into rather than something it has to remember to\ntake away.", "signature": "# [doc = \" An action carried by a glyph alone.\"] # [doc = \"\"] # [doc = \" The accessible name is a constructor argument rather than an option: an\"] # [doc = \" icon with no name is an action neither a screen reader nor a test can\"] # [doc = \" address, and there is no sensible default for what a picture means.\"] # [doc = \" Everything else — tone, size, refusal, the action in flight — is\"] # [doc = \" [`Button`]'s behaviour, reused rather than reimplemented.\"] # [doc = \"\"] # [doc = \" Where [`Button`] starts Primary, this starts Ghost: a bare glyph is\"] # [doc = \" almost never the one decision an area is asking for, so weight on one is\"] # [doc = \" something a caller opts into rather than something it has to remember to\"] # [doc = \" take away.\"] # [derive (IntoElement)] pub struct IconButton { button : Button, }", "cfg": [] }, { "id": "gpui_kit::controls::button::IconButton::color", "name": "color", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "The colour the shared tiers are resolved against. See [`Button::color`].", "documentation": "The colour the shared tiers are resolved against. See [`Button::color`].", "signature": "pub fn color (mut self, color : impl Into) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::danger", "name": "danger", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn danger (self) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::ghost", "name": "ghost", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn ghost (self) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::ground", "name": "ground", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "The surface this control stands on. See [`Button::ground`].", "documentation": "The surface this control stands on. See [`Button::ground`].", "signature": "pub fn ground (mut self, ground : Surface) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::join", "name": "join", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn join (mut self, join : ButtonJoin) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::loading", "name": "loading", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn loading (mut self, loading : bool) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, glyph : Icon, name : impl Into) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::on_click", "name": "on_click", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn on_click (mut self, handler : impl Fn (& mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::primary", "name": "primary", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn primary (self) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::secondary", "name": "secondary", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn secondary (self) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::semantic_parent", "name": "semantic_parent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn semantic_parent (mut self, parent : impl Into) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::track_focus", "name": "track_focus", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn track_focus (mut self, handle : & FocusHandle) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconButton::variant", "name": "variant", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "", "documentation": "", "signature": "pub fn variant (mut self, variant : impl Into) -> Self", "cfg": [], "target": "IconButton" }, { "id": "gpui_kit::controls::button::IconPosition", "name": "IconPosition", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::button", "path": "gpui_kit::controls::button", "source": "crates/gpui-kit/src/controls/button.rs", "summary": "Which side of the label the glyph sits on.", "documentation": "Which side of the label the glyph sits on.", "signature": "# [doc = \" Which side of the label the glyph sits on.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq, Default)] pub enum IconPosition { # [default] Leading, Trailing, }", "cfg": [] }, { "id": "gpui_kit::controls::cascader::Cascader", "name": "Cascader", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "A menu of progressively revealed caller-owned option columns.", "documentation": "A menu of progressively revealed caller-owned option columns.", "signature": "# [doc = \" A menu of progressively revealed caller-owned option columns.\"] pub struct Cascader { ident : Ident, focus_handle : FocusHandle, options : Vec, selected : Option, name : SharedString, placeholder : Option, size : ControlSize, disabled : bool, open : bool, open_path : Vec, active : Option, slots : Slots, }", "cfg": [] }, { "id": "gpui_kit::controls::cascader::Cascader::close", "name": "close", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "Closes the transient option surface and clears its open path.", "documentation": "Closes the transient option surface and clears its open path.", "signature": "pub fn close (& mut self, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::is_disabled", "name": "is_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn is_disabled (& self) -> bool", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::is_open", "name": "is_open", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn is_open (& self) -> bool", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn name (mut self, name : impl Into) -> Self", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, _window : & mut Window, cx : & mut Context) -> Self", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::open", "name": "open", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "Opens the transient option surface without changing any caller-owned value.", "documentation": "Opens the transient option surface without changing any caller-owned value.", "signature": "pub fn open (& mut self, window : & mut Window, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::open_path", "name": "open_path", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn open_path (& self) -> & [SharedString]", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::options", "name": "options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn options (mut self, options : impl IntoIterator) -> Self", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::placeholder", "name": "placeholder", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn placeholder (mut self, placeholder : impl Into) -> Self", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, id : impl Into) -> Self", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::selected_id", "name": "selected_id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn selected_id (& self) -> Option<& SharedString>", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::set_control_size", "name": "set_control_size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn set_control_size (& mut self, size : ControlSize, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::set_disabled", "name": "set_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn set_disabled (& mut self, disabled : bool, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::set_name", "name": "set_name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn set_name (& mut self, name : impl Into, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::set_options", "name": "set_options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn set_options (& mut self, options : Vec, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::set_placeholder", "name": "set_placeholder", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn set_placeholder (& mut self, placeholder : Option, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::Cascader::set_selected", "name": "set_selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn set_selected (& mut self, selected : Option, cx : & mut Context)", "cfg": [], "target": "Cascader" }, { "id": "gpui_kit::controls::cascader::CascaderEvent", "name": "CascaderEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "# [derive (Debug, Clone, PartialEq, Eq)] pub enum CascaderEvent { Selected (SharedString), Expanded (SharedString), Retry (SharedString), Opened, Closed, }", "cfg": [] }, { "id": "gpui_kit::controls::cascader::CascaderOption", "name": "CascaderOption", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "One caller-owned node in a cascader.", "documentation": "One caller-owned node in a cascader.", "signature": "# [doc = \" One caller-owned node in a cascader.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub struct CascaderOption { pub id : SharedString, pub label : SharedString, pub disabled : bool, # [doc = \" `None` is a leaf; `Some` is a branch, including before it is loaded.\"] pub children : Option, SharedString>>, }", "cfg": [] }, { "id": "gpui_kit::controls::cascader::CascaderOption::children", "name": "children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn children (mut self, children : impl IntoIterator) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::disabled", "name": "disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn disabled (mut self, disabled : bool) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::empty_children", "name": "empty_children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn empty_children (mut self) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::error_children", "name": "error_children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn error_children (mut self, reason : impl Into) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::idle_children", "name": "idle_children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn idle_children (mut self) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::loading_children", "name": "loading_children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn loading_children (mut self) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn new (id : impl Into, label : impl Into) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::cascader::CascaderOption::unavailable_children", "name": "unavailable_children", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::cascader", "path": "gpui_kit::controls::cascader", "source": "crates/gpui-kit/src/controls/cascader.rs", "summary": "", "documentation": "", "signature": "pub fn unavailable_children (mut self, reason : impl Into) -> Self", "cfg": [], "target": "CascaderOption" }, { "id": "gpui_kit::controls::color_picker::ColorPicker", "name": "ColorPicker", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "Hue, saturation-brightness, optional opacity, and host-owned swatches.", "documentation": "Hue, saturation-brightness, optional opacity, and host-owned swatches.", "signature": "# [doc = \" Hue, saturation-brightness, optional opacity, and host-owned swatches.\"] # [derive (IntoElement)] pub struct ColorPicker { ident : Ident, value : Hsla, alpha : bool, presets : Vec, recent : Vec, disabled : bool, on_change : Option, }", "cfg": [] }, { "id": "gpui_kit::controls::color_picker::ColorPicker::alpha", "name": "alpha", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn alpha (mut self, alpha : bool) -> Self", "cfg": [], "target": "ColorPicker" }, { "id": "gpui_kit::controls::color_picker::ColorPicker::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, value : Hsla) -> Self", "cfg": [], "target": "ColorPicker" }, { "id": "gpui_kit::controls::color_picker::ColorPicker::on_change", "name": "on_change", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn on_change (mut self, handler : impl Fn (Hsla, & mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "ColorPicker" }, { "id": "gpui_kit::controls::color_picker::ColorPicker::presets", "name": "presets", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn presets (mut self, colors : impl IntoIterator) -> Self", "cfg": [], "target": "ColorPicker" }, { "id": "gpui_kit::controls::color_picker::ColorPicker::recent", "name": "recent", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn recent (mut self, colors : impl IntoIterator) -> Self", "cfg": [], "target": "ColorPicker" }, { "id": "gpui_kit::controls::color_picker::ColorSwatch", "name": "ColorSwatch", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "A clickable colour chip. Reports the colour it was given; applies nothing.", "documentation": "A clickable colour chip. Reports the colour it was given; applies nothing.", "signature": "# [doc = \" A clickable colour chip. Reports the colour it was given; applies nothing.\"] # [derive (IntoElement)] pub struct ColorSwatch { ident : Ident, color : Hsla, selected : bool, disabled : bool, on_click : Option, }", "cfg": [] }, { "id": "gpui_kit::controls::color_picker::ColorSwatch::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, color : Hsla) -> Self", "cfg": [], "target": "ColorSwatch" }, { "id": "gpui_kit::controls::color_picker::ColorSwatch::on_click", "name": "on_click", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn on_click (mut self, handler : impl Fn (Hsla, & mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "ColorSwatch" }, { "id": "gpui_kit::controls::color_picker::ColorSwatch::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::color_picker", "path": "gpui_kit::controls::color_picker", "source": "crates/gpui-kit/src/controls/color_picker.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, selected : bool) -> Self", "cfg": [], "target": "ColorSwatch" }, { "id": "gpui_kit::controls::combobox::Combobox", "name": "Combobox", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "A [`Select`](crate::controls::select::Select) you can type into.", "documentation": "A [`Select`](crate::controls::select::Select) you can type into.\n\nIt owns the query and whether the menu is open. Which option holds is the\ncaller's answer, so escape puts the query back to it and reports nothing.", "signature": "# [doc = \" A [`Select`](crate::controls::select::Select) you can type into.\"] # [doc = \"\"] # [doc = \" It owns the query and whether the menu is open. Which option holds is the\"] # [doc = \" caller's answer, so escape puts the query back to it and reports nothing.\"] pub struct Combobox { ident : Ident, query : Entity, options : Vec, selected : Option, name : SharedString, placeholder : Option, size : ControlSize, disabled : bool, invalid : bool, open : bool, # [doc = \" The highlighted option by identity, so filtering does not move the\"] # [doc = \" highlight onto whatever happens to sit at the same position.\"] active : Option, allow_custom : bool, # [doc = \" Whether the current answer has been put in the field. The text is the\"] # [doc = \" typist's afterwards, so it is written once.\"] seeded : bool, scroll : ScrollHandle, trigger_bounds : Rc>>, reveal_active : bool, menu_geometry : Option, presentation : popover::PickerPresentation, sheet : Option, slots : Slots, # [doc = \" Held so the query subscription lives as long as the combobox does.\"] _subscriptions : Vec, }", "cfg": [] }, { "id": "gpui_kit::controls::combobox::Combobox::allow_custom", "name": "allow_custom", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Whether a query nothing answers may be reported as a new value.", "documentation": "Whether a query nothing answers may be reported as a new value.\n\nWith it off the combobox reports nothing at all for such a query, and\nthe list says that this is a closed set rather than drawing an empty\nlist that looks like a list with nothing in it.", "signature": "pub fn allow_custom (mut self, allow_custom : bool) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::invalid", "name": "invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn invalid (mut self, invalid : bool) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::is_disabled", "name": "is_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn is_disabled (& self) -> bool", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::is_open", "name": "is_open", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn is_open (& self) -> bool", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Names both the combobox and its editable query target.", "documentation": "Names both the combobox and its editable query target.", "signature": "pub fn name (mut self, name : impl Into) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, window : & mut Window, cx : & mut Context) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::open", "name": "open", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn open (& mut self, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::options", "name": "options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn options (mut self, options : impl IntoIterator) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::placeholder", "name": "placeholder", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn placeholder (mut self, placeholder : impl Into) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::presentation", "name": "presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Chooses an anchored menu or retained bottom modal for the same options.", "documentation": "Chooses an anchored menu or retained bottom modal for the same options.", "signature": "pub fn presentation (mut self, presentation : popover::PickerPresentation) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::query_input", "name": "query_input", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn query_input (& self) -> & Entity", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::query_text", "name": "query_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn query_text (& self, cx : & App) -> SharedString", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::selected", "name": "selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn selected (mut self, id : impl Into) -> Self", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::selected_id", "name": "selected_id", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn selected_id (& self) -> Option<& SharedString>", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::selected_option", "name": "selected_option", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn selected_option (& self) -> Option<& SelectOption>", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_allow_custom", "name": "set_allow_custom", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn set_allow_custom (& mut self, allow : bool, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_control_size", "name": "set_control_size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn set_control_size (& mut self, size : ControlSize, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_disabled", "name": "set_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn set_disabled (& mut self, disabled : bool, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_invalid", "name": "set_invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Draws the control as refused after it was built, for an owner that learns the answer is wrong later — a host that rejected it, or a form that found a required answer missing. Without it the message and the control it is about disagree.", "documentation": "Draws the control as refused after it was built, for an owner that\nlearns the answer is wrong later — a host that rejected it, or a form\nthat found a required answer missing. Without it the message and the\ncontrol it is about disagree.", "signature": "pub fn set_invalid (& mut self, invalid : bool, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_name", "name": "set_name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn set_name (& mut self, name : impl Into, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_options", "name": "set_options", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn set_options (& mut self, options : Vec, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_placeholder", "name": "set_placeholder", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Restore the localized default with `None`, retaining the query editor.", "documentation": "Restore the localized default with `None`, retaining the query editor.", "signature": "pub fn set_placeholder (& mut self, placeholder : Option, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_presentation", "name": "set_presentation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Changes presentation without resetting the query or caller selection.", "documentation": "Changes presentation without resetting the query or caller selection.", "signature": "pub fn set_presentation (& mut self, presentation : popover::PickerPresentation, cx : & mut Context,)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_query", "name": "set_query", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn set_query (& mut self, text : impl Into, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::set_selected", "name": "set_selected", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "Replaces the choice from the host side, and puts its label back in the field so the query and the answer agree again.", "documentation": "Replaces the choice from the host side, and puts its label back in the\nfield so the query and the answer agree again.", "signature": "pub fn set_selected (& mut self, id : Option, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::Combobox::toggle", "name": "toggle", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "", "documentation": "", "signature": "pub fn toggle (& mut self, window : & mut Window, cx : & mut Context)", "cfg": [], "target": "Combobox" }, { "id": "gpui_kit::controls::combobox::ComboboxEvent", "name": "ComboboxEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::combobox", "path": "gpui_kit::controls::combobox", "source": "crates/gpui-kit/src/controls/combobox.rs", "summary": "What a combobox reports. The owner decides what any of it means.", "documentation": "What a combobox reports. The owner decides what any of it means.", "signature": "# [doc = \" What a combobox reports. The owner decides what any of it means.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum ComboboxEvent { QueryChanged (SharedString), # [doc = \" One of the offered options was taken.\"] Selected (SharedString), # [doc = \" A value nothing offered answers, reported only when the caller allows\"] # [doc = \" custom values.\"] Custom (SharedString), Opened, Closed, }", "cfg": [] }, { "id": "gpui_kit::controls::copy_button::CopyButton", "name": "CopyButton", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "A button that copies caller-supplied text and confirms what happened.", "documentation": "A button that copies caller-supplied text and confirms what happened.", "signature": "# [doc = \" A button that copies caller-supplied text and confirms what happened.\"] pub struct CopyButton { ident : Ident, focus_handle : FocusHandle, text : SharedString, label : Option, # [doc = \" What the button is called when it carries only a glyph.\"] name : Option, glyph_only : bool, variant : ButtonVariant, size : ControlSize, disabled : bool, copier : Option, confirmation : Duration, state : CopyState, # [doc = \" Whether the current refusal came from the fallback clipboard check.\"] default_failure : bool, # [doc = \" How much of the confirmation is left, and when it was last spent.\"] remaining : Option, last_tick : Option, }", "cfg": [] }, { "id": "gpui_kit::controls::copy_button::CopyButton::clear_copier", "name": "clear_copier", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Restores owner-checked platform write and readback for future copies.", "documentation": "Restores owner-checked platform write and readback for future copies.", "signature": "pub fn clear_copier (& mut self, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::confirmation", "name": "confirmation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "How long a confirmation stays. A refusal is not timed and this does not touch it.", "documentation": "How long a confirmation stays. A refusal is not timed and this does not\ntouch it.", "signature": "pub fn confirmation (mut self, confirmation : Duration) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::copier", "name": "copier", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Supplies a host that knows whether the copy worked.", "documentation": "Supplies a host that knows whether the copy worked.\n\nThe default writes to the platform clipboard and reads it back; a host\nwith a better answer replaces it, and the failure text it returns is\nshown verbatim rather than reworded.", "signature": "pub fn copier (mut self, copier : impl Fn (& str, & mut App) -> Result<(), SharedString> + 'static,) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::copy", "name": "copy", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Does the copy and records what actually happened.", "documentation": "Does the copy and records what actually happened.", "signature": "pub fn copy (& mut self, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::glyph_only", "name": "glyph_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Draws the button as a square carrying only its glyph, and names it.", "documentation": "Draws the button as a square carrying only its glyph, and names it.", "signature": "pub fn glyph_only (mut self, name : impl Into) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::is_disabled", "name": "is_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn is_disabled (& self) -> bool", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::label", "name": "label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Words on the button instead of the catalogue's own.", "documentation": "Words on the button instead of the catalogue's own.", "signature": "pub fn label (mut self, label : impl Into) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, _window : & mut Window, cx : & mut Context) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_confirmation", "name": "set_confirmation", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Sets the duration for future copies without restarting an active confirmation.", "documentation": "Sets the duration for future copies without restarting an active confirmation.", "signature": "pub fn set_confirmation (& mut self, confirmation : Duration, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_control_size", "name": "set_control_size", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn set_control_size (& mut self, size : ControlSize, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_copier", "name": "set_copier", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Replaces the native host copier without changing the last outcome.", "documentation": "Replaces the native host copier without changing the last outcome.", "signature": "pub fn set_copier (& mut self, copier : impl Fn (& str, & mut App) -> Result<(), SharedString> + 'static, cx : & mut Context,)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_disabled", "name": "set_disabled", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn set_disabled (& mut self, disabled : bool, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_glyph_only", "name": "set_glyph_only", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Enables a named glyph-only button, or restores labeled mode with `None`.", "documentation": "Enables a named glyph-only button, or restores labeled mode with `None`.", "signature": "pub fn set_glyph_only (& mut self, name : Option, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_label", "name": "set_label", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Replaces the label, or restores the localized default with `None`.", "documentation": "Replaces the label, or restores the localized default with `None`.", "signature": "pub fn set_label (& mut self, label : Option, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_text", "name": "set_text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Replaces the payload from the host side, between frames.", "documentation": "Replaces the payload from the host side, between frames.", "signature": "pub fn set_text (& mut self, text : impl Into, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::set_variant", "name": "set_variant", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn set_variant (& mut self, variant : ButtonVariant, cx : & mut Context)", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn state (& self) -> & CopyState", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::text", "name": "text", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "The text this button copies. Never published: a copy button is a plausible carrier of a credential, so the tree gets the button, not its payload.", "documentation": "The text this button copies. Never published: a copy button is a\nplausible carrier of a credential, so the tree gets the button, not its\npayload.", "signature": "pub fn text (mut self, text : impl Into) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyButton::variant", "name": "variant", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn variant (mut self, variant : ButtonVariant) -> Self", "cfg": [], "target": "CopyButton" }, { "id": "gpui_kit::controls::copy_button::CopyEvent", "name": "CopyEvent", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "What a copy button reports. The owner decides what any of it means.", "documentation": "What a copy button reports. The owner decides what any of it means.", "signature": "# [doc = \" What a copy button reports. The owner decides what any of it means.\"] # [derive (Debug, Clone, PartialEq, Eq)] pub enum CopyEvent { Copied, # [doc = \" Carries the reason, which is the same text the button shows.\"] Failed (SharedString), }", "cfg": [] }, { "id": "gpui_kit::controls::copy_button::CopyState", "name": "CopyState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "What the button is currently claiming.", "documentation": "What the button is currently claiming.", "signature": "# [doc = \" What the button is currently claiming.\"] # [derive (Debug, Clone, PartialEq, Eq, Default)] pub enum CopyState { # [doc = \" Nothing has been tried, or the last confirmation has expired.\"] # [default] Idle, # [doc = \" The clipboard took it, and reading it back agreed.\"] Copied, # [doc = \" It did not go through, for the reason carried here.\"] Failed (SharedString), }", "cfg": [] }, { "id": "gpui_kit::controls::copy_button::CopyState::is_copied", "name": "is_copied", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn is_copied (& self) -> bool", "cfg": [], "target": "CopyState" }, { "id": "gpui_kit::controls::copy_button::CopyState::is_failed", "name": "is_failed", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "", "documentation": "", "signature": "pub fn is_failed (& self) -> bool", "cfg": [], "target": "CopyState" }, { "id": "gpui_kit::controls::copy_button::verified_clipboard_copy", "name": "verified_clipboard_copy", "kind": "function", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::copy_button", "path": "gpui_kit::controls::copy_button", "source": "crates/gpui-kit/src/controls/copy_button.rs", "summary": "Writes to the platform clipboard and reads it back to check.", "documentation": "Writes to the platform clipboard and reads it back to check.\n\nThe readback verifies delivery; an authorized write alone is only submission.", "signature": "pub fn verified_clipboard_copy (text : & str, cx : & mut App) -> Result<(), SharedString>", "cfg": [] }, { "id": "gpui_kit::controls::dropzone::Dropzone", "name": "Dropzone", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "An area that accepts a drop.", "documentation": "An area that accepts a drop.", "signature": "# [doc = \" An area that accepts a drop.\"] # [derive (IntoElement)] pub struct Dropzone { ident : Ident, label : SharedString, hint : Option, # [doc = \" Why a payload this zone does not handle is refused.\"] refusal : Option, kinds : Vec, pinned : Option, disabled : bool, # [doc = \" Validation owned by a surrounding field, separate from a live drag\"] # [doc = \" payload this zone itself refuses.\"] invalid : bool, icon : Option, on_drop : Option, on_files : Option, }", "cfg": [] }, { "id": "gpui_kit::controls::dropzone::Dropzone::accepts", "name": "accepts", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "Which payload kinds this zone handles. Anything else is refused.", "documentation": "Which payload kinds this zone handles. Anything else is refused.", "signature": "pub fn accepts> (mut self, kinds : impl IntoIterator) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::hint", "name": "hint", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "A second line, shown while the zone is idle.", "documentation": "A second line, shown while the zone is idle.", "signature": "pub fn hint (mut self, hint : impl Into) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::icon", "name": "icon", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "", "documentation": "", "signature": "pub fn icon (mut self, icon : Icon) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::invalid", "name": "invalid", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "", "documentation": "", "signature": "pub fn invalid (mut self, invalid : bool) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::new", "name": "new", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "", "documentation": "", "signature": "pub fn new (ident : impl Into, label : impl Into) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::on_drop", "name": "on_drop", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "", "documentation": "", "signature": "pub fn on_drop (mut self, handler : impl Fn (& DragItem, & mut Window, & mut App) + 'static) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::on_files", "name": "on_files", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "Reports paths the platform handed over when files were dropped.", "documentation": "Reports paths the platform handed over when files were dropped.\n\nThe paths are user-generated content, so they reach the handler and\nnever the semantic tree.", "signature": "pub fn on_files (mut self, handler : impl Fn (& ExternalPaths, & mut Window, & mut App) + 'static,) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::refusal", "name": "refusal", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "What the zone says when it refuses a payload.", "documentation": "What the zone says when it refuses a payload.", "signature": "pub fn refusal (mut self, refusal : impl Into) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::Dropzone::state", "name": "state", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "Pins the zone to one state.", "documentation": "Pins the zone to one state.\n\nA live drag decides the state otherwise. Pinning exists so all three\ncan be reviewed side by side in a capture, which no single pointer\nposition could produce.", "signature": "pub fn state (mut self, state : DropzoneState) -> Self", "cfg": [], "target": "Dropzone" }, { "id": "gpui_kit::controls::dropzone::DropzoneState", "name": "DropzoneState", "kind": "enum", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "What a dropzone is currently saying.", "documentation": "What a dropzone is currently saying.", "signature": "# [doc = \" What a dropzone is currently saying.\"] # [derive (Debug, Clone, Copy, PartialEq, Eq)] pub enum DropzoneState { Idle, Accepting, Refusing, }", "cfg": [] }, { "id": "gpui_kit::controls::dropzone::DropzoneState::name", "name": "name", "kind": "method", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::dropzone", "path": "gpui_kit::controls::dropzone", "source": "crates/gpui-kit/src/controls/dropzone.rs", "summary": "", "documentation": "", "signature": "pub fn name (self) -> & 'static str", "cfg": [], "target": "DropzoneState" }, { "id": "gpui_kit::controls::editor::Editor", "name": "Editor", "kind": "struct", "package": "gpui-box-kit", "crate": "gpui_kit", "module": "controls::editor", "path": "gpui_kit::controls::editor", "source": "crates/gpui-kit/src/controls/editor.rs", "summary": "Plain source editing with caller-owned language policy.", "documentation": "Plain source editing with caller-owned language policy.", "signature": "# [doc = \" Plain source editing with caller-owned language policy.\"] pub struct Editor { ident : Ident, label : SharedString, area : Entity