Struct PermissionMode 

#[non_exhaustive]
pub struct PermissionMode { /* private fields */ }

How much an agent may do without asking, as one entry of a PermissionMenu: an id, a label, a line of description, and an icon.

The id comes from the domain and is unique in the menu. The default set is PermissionMode::defaults; an application defines its own modes the same way.

use gpui_cn::PermissionMode;
use gpui_kit::assets::IconName;

let strict = PermissionMode::new("strict", "Strict")
    .description("Ask before every change")
    .icon(IconName::Check);
assert_eq!(strict.label().as_ref(), "Strict");

Implementations

impl PermissionMode

pub const AUTO: &'static str = "auto"

The id of the default Auto mode.

pub const MANUAL: &'static str = "manual"

The id of the default Manual mode.

pub const PLAN: &'static str = "plan"

The id of the default Plan mode.

pub const BYPASS: &'static str = "bypass"

The id of the default Bypass all mode.

pub fn new(id: impl Into<SharedString>, label: impl Into<SharedString>) -> Self

A mode with a stable id and the label it shows.

pub fn description(self, description: impl Into<SharedString>) -> Self

A line under the label in the menu.

pub fn icon(self, icon: impl Into<Icon>) -> Self

The icon before the label, in the menu and on the trigger.

pub fn tone(self, tone: PermissionTone) -> Self

Marks the mode risky or ordinary. A risky one shows in the warning color on the trigger and in the menu.

pub fn tone_of(&self) -> PermissionTone

The tone.

pub fn id(&self) -> &SharedString

The id.

pub fn label(&self) -> &SharedString

The label.

pub fn description_text(&self) -> Option<&SharedString>

The line under the label.

pub fn icon_of(&self) -> Option<&Icon>

The icon.

pub fn defaults() -> Vec<Self>

The four default modes: Auto, Manual, Plan, and Bypass all.

Trait Implementations

impl Clone for PermissionMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.