Struct ExperimentalOption 

pub struct ExperimentalOption { /* private fields */ }

Experimental option (aka feature flag).

This struct holds one experimental option that can change some part of Nushell’s behavior. These options let users opt in or out of experimental changes while keeping the rest stable. They’re useful for testing new ideas and giving users a way to go back to older behavior if needed.

You can find all options in the statics of nu_experimental. Everything there, except ALL, is a toggleable option. ALL gives a full list and can be used to check which options are set.

The Debug implementation shows the option’s identifier, stability, and current value. To also include the description in the output, use the plus sign, e.g. format!("{OPTION:+#?}").

Implementations

impl ExperimentalOption

pub fn identifier(&self) -> &'static str

pub fn description(&self) -> &'static str

pub fn status(&self) -> Status

pub fn since(&self) -> (u16, u16, u16)

pub fn issue_id(&self) -> u32

pub fn issue_url(&self) -> String

pub fn get(&self) -> bool

pub unsafe fn set(&self, value: bool)

Sets the state of an experimental option.

Safety

This method is unsafe to emphasize that experimental options are not designed to change dynamically at runtime. Changing their state at arbitrary points can lead to inconsistent behavior. You should set experimental options only during initialization, before the application fully starts.

pub unsafe fn unset(&self)

Unsets an experimental option, resetting it to an uninitialized state.

Safety

Like set, this method is unsafe to highlight that experimental options should remain stable during runtime. Only unset options in controlled, initialization contexts to avoid unpredictable behavior.

Trait Implementations

impl Debug for ExperimentalOption

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

Formats the value using the given formatter.

impl PartialEq for ExperimentalOption

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ExperimentalOption