Nushell Nu Protocol

https://docs.rs/nu-protocol/latest/nu_protocol/
Admin
The nu-protocol crate defines the core structs and traits used across the Nushell project,...
Tokens:257,894
Snippets:2,306
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Unit::as_str Method Example

Source: https://docs.rs/nu-protocol/latest/nu_protocol/ast/unit/enum

Demonstrates how to use the `as_str` method to get the string representation of a Unit variant, which is useful for parsing.

```rust
assert_eq!(Unit::Nanosecond.as_str(), "ns");
assert_eq!(Unit::Filesize(FilesizeUnit::B).as_str(), "B");
assert_eq!(Unit::Second.as_str().parse(), Ok(Unit::Second));
assert_eq!(Unit::Filesize(FilesizeUnit::KB).as_str().parse(), Ok(Unit::Filesize(FilesizeUnit::KB)));
```

--------------------------------

### Rust: ParserPath Methods for Path Operations

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Provides essential methods for interacting with ParserPath instances. These include checking if a path is a directory or file, retrieving the parent path, getting the file stem, and joining path components. These methods are crucial for navigating and manipulating paths, whether real or virtual.

```rust
pub fn is_dir(&self) -> bool
pub fn is_file(&self) -> bool
pub fn exists(&self) -> bool
pub fn path(&self) -> &Path
pub fn path_buf(self) -> PathBuf
pub fn parent(&self) -> Option<&Path>
pub fn file_stem(&self) -> Option<&OsStr>
pub fn extension(&self) -> Option<&OsStr>
pub fn join(self, path: impl AsRef<Path>) -> ParserPath
```

--------------------------------

### Re-exporting AST Unit and Config in Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/index

Illustrates the re-exporting of abstract syntax tree (AST) units and configuration-related items. This ensures that common utilities for parsing and configuration are readily available.

```Rust
pub use ast::unit::*;

pub use config::*;
```

--------------------------------

### Itertools Get and Zip Methods

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

The `get` method returns a subsection of the iterator. `zip_longest` pairs elements from two iterators, using `None` for missing elements, while `zip_eq` pairs elements and stops when either iterator is exhausted.

```rust
impl<T> Itertools for T where T: Iterator + ?Sized,
fn get<R>(self, index: R) -> <R as IteratorIndex<Self>>::Output where Self: Sized, R: IteratorIndex<Self>,

```

```rust
impl<T> Itertools for T where T: Iterator + ?Sized,
fn zip_longest<J>( self, other: J, ) -> ZipLongest<Self, <J as IntoIterator>::IntoIter> where J: IntoIterator, Self: Sized,

```

```rust
impl<T> Itertools for T where T: Iterator + ?Sized,
fn zip_eq<J>(self, other: J) -> ZipEq<Self, <J as IntoIterator>::IntoIter> where J: IntoIterator, Self: Sized,

```

--------------------------------

### ParserPath Static Methods

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Details on static methods used to create or convert ParserPath instances.

```APIDOC
## ParserPath Static Methods

### `from_virtual_path( working_set: &StateWorkingSet<'_>, name: &str, virtual_path: &VirtualPath, ) -> Self`
Creates a ParserPath from a virtual path context.
```

--------------------------------

### nu-protocol UseAnsiColoring get Method Implementation

Source: https://docs.rs/nu-protocol/latest/nu_protocol/config/enum

Implements the `get` method for the `UseAnsiColoring` enum. This method determines whether ANSI colors should be used, considering the enum's value and environment variables like FORCE_COLOR and NO_COLOR. It returns a boolean indicating if ANSI colors are enabled.

```rust
pub fn get(self, engine_state: &EngineState) -> bool
```

--------------------------------

### Apply Style

Source: https://docs.rs/nu-protocol/latest/nu_protocol/ast/struct

Applies a style to the output. The style is determined at runtime.

```rust
fn style(&self, style: Style) -> Styled<&Self>
```

--------------------------------

### Get Value Type - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Retrieves the `Type` of the current `Value`.

```rust
pub fn get_type(&self) -> Type
```

--------------------------------

### TryFrom and TryInto Implementations

Source: https://docs.rs/nu-protocol/latest/nu_protocol/process/enum

Documentation for `TryFrom` and `TryInto` trait implementations for type conversions.

```APIDOC
## POST /try_from

### Description
Performs a conversion from one type to another using `TryFrom`.

### Method
POST

### Endpoint
/try_from

### Parameters
#### Request Body
- **value** (U) - Required - The value to convert.

### Response
#### Success Response (200)
- **Result** (Result<T, <T as TryFrom<U>>::Error>) - The converted value or an error.

#### Response Example
```json
{
  "result": "Ok(converted_value)"
}
```

## POST /try_into

### Description
Performs a conversion from one type to another using `TryInto`.

### Method
POST

### Endpoint
/try_into

### Parameters
#### Request Body
- **self** (T) - Required - The value to convert.

### Response
#### Success Response (200)
- **Result** (Result<U, <U as TryFrom<T>>::Error>) - The converted value or an error.

#### Response Example
```json
{
  "result": "Ok(converted_value)"
}
```
```

--------------------------------

### Get Span - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Retrieves the `Span` associated with the current `Value`.

```rust
pub fn span(&self) -> Span
```

--------------------------------

### Rust: ParserPath Blanket Implementations (Any, Borrow, CloneToUninit, Comparable)

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Details blanket implementations for ParserPath, covering generic traits like `Any` for type identification, `Borrow` for immutable borrowing, `CloneToUninit` for efficient cloning into uninitialized memory (nightly-only), and `Comparable` for key-based comparisons.

```rust
impl<T> Any for T
impl<T> Borrow<T> for T
impl<T> CloneToUninit for T
impl<Q, K> Comparable<K> for Q
```

--------------------------------

### TryInto Implementation

Source: https://docs.rs/nu-protocol/latest/nu_protocol/process/struct

Provides a `TryInto` implementation for conversions where the target type implements `TryFrom` the source type. Includes error handling for conversion failures.

```rust
impl<T, U> TryInto<U> for T
where U: TryFrom<T>
```

```rust
type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

--------------------------------

### Rust: Trait Implementations for Any

Source: https://docs.rs/nu-protocol/latest/nu_protocol/byte_stream/struct

Provides the `type_id` method to get the unique identifier for a type.

```rust
/// Gets the `TypeId` of `self`.
fn type_id(&self) -> TypeId
where T: 'static + ?Sized,
```

--------------------------------

### OwoColorize Implementations for Generic Types

Source: https://docs.rs/nu-protocol/latest/nu_protocol/engine/enum

Demonstrates the application of OwoColorize traits, which allow for adding color to terminal output. These blanket implementations are available for any type that implements the necessary traits, enabling colored display of various data.

```rust
impl<D> OwoColorize for D
where
    D: 'static,
{
    fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
    fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
    fn black(&self) -> FgColorDisplay<'_, Black, Self>
    fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
    fn red(&self) -> FgColorDisplay<'_, Red, Self>
    fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
    fn green(&self) -> FgColorDisplay<'_, Green, Self>
    fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
    fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
    fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
    fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
    fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
    fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
    fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
    fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
    fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
    fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
    fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
    fn white(&self) -> FgColorDisplay<'_, White, Self>
    fn on_white(&self) -> BgColorDisplay<'_, White, Self>
    fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
}
```

--------------------------------

### Get Data by Key - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Retrieves `Option<Value>` associated with a given key from the `Value`.

```rust
pub fn get_data_by_key(&self, name: &str) -> Option<Value>
```

--------------------------------

### Get Value Columns (Rust)

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Returns an iterator over the column names of a `Value`, if it represents a table-like structure.

```rust
pub fn columns(&self) -> impl Iterator<Item = &String>
```

--------------------------------

### PartialEq Implementation for AdditionalContext

Source: https://docs.rs/nu-protocol/latest/nu_protocol/shell_error/io/struct

Defines how to compare two AdditionalContext instances for equality. Includes methods for both equality (`eq`) and inequality (`ne`).

```rust
impl PartialEq for AdditionalContext
fn eq(&self, other: &AdditionalContext) -> bool
fn ne(&self, other: &Rhs) -> bool
```

--------------------------------

### Trait Implementations for VirtualPath

Source: https://docs.rs/nu-protocol/latest/nu_protocol/marker/struct

Details the trait implementations available for the VirtualPath struct, such as Clone, Hash, Ord, PartialEq, and others, with links to their respective source code and documentation.

```APIDOC
## Trait Implementations

### impl Clone for VirtualPath

- **clone()**: Returns a duplicate of the value.
- **clone_from()**: Performs copy-assignment from `source`.

### impl Hash for VirtualPath

- **hash()**: Feeds this value into the given `Hasher`.
- **hash_slice()**: Feeds a slice of this type into the given `Hasher`.

### impl Ord for VirtualPath

- **cmp()**: Returns an `Ordering` between `self` and `other`.
- **max()**: Compares and returns the maximum of two values.
- **min()**: Compares and returns the minimum of two values.
- **clamp()**: Restrict a value to a certain interval.

### impl PartialEq for VirtualPath

- **eq()**: Tests for `self` and `other` values to be equal.
- **ne()**: Tests for `!=`.

### impl PartialOrd for VirtualPath

- **partial_cmp()**: Returns an ordering between `self` and `other` values if one exists.
- **lt()**: Tests less than.
- **le()**: Tests less than or equal to.
- **gt()**: Tests greater than.
- **ge()**: Tests greater than or equal to.

### impl Copy for VirtualPath

### impl Eq for VirtualPath

### impl StructuralPartialEq for VirtualPath
```

--------------------------------

### Implement Blanket Trait Any for T

Source: https://docs.rs/nu-protocol/latest/nu_protocol/debugger/debugger_trait/struct

Implements the `Any` trait for any type `T` that is `'static` and not `?Sized`, providing a method to get the `TypeId` of the value.

```rust
fn type_id(&self) -> TypeId;
```

--------------------------------

### Blanket Implementations for Generic Types

Source: https://docs.rs/nu-protocol/latest/nu_protocol/config/struct

Shows blanket implementations for generic types, such as Any, Borrow, BorrowMut, CloneToUninit, Equivalent, From, Into, IntoEither, IntoSpanned, and OwoColorize, demonstrating generic utility functions.

```rust
impl<T> Any for T
impl<T> Borrow<T> for T
impl<T> BorrowMut<T> for T
impl<T> CloneToUninit for T
impl<Q, K> Equivalent<K> for Q
impl<T> From<T> for T
impl<T, U> Into<U> for T
impl<T> IntoEither for T
impl<T> IntoSpanned for T
impl<D> OwoColorize for D
```

--------------------------------

### Get Closure Reference - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Retrieves a reference to the inner `Closure` value. Returns an error if the `Value` is not a closure.

```rust
pub fn as_closure(&self) -> Result<&Closure, ShellError>
```

--------------------------------

### Terminal Text Formatting with OwoColorize in Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Provides methods to apply foreground and background colors to terminal output. It supports a wide range of ANSI colors, including basic, bright, and specific named colors.

```rust
impl<D> OwoColorize for D {
    fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
    where
        C: Color,
    {
        // Implementation details omitted for brevity
        unimplemented!()
    }

    fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
    where
        C: Color,
    {
        // Implementation details omitted for brevity
        unimplemented!()
    }

    fn black(&self) -> FgColorDisplay<'_, Black, Self> { unimplemented!() }
    fn on_black(&self) -> BgColorDisplay<'_, Black, Self> { unimplemented!() }
    fn red(&self) -> FgColorDisplay<'_, Red, Self> { unimplemented!() }
    fn on_red(&self) -> BgColorDisplay<'_, Red, Self> { unimplemented!() }
    fn green(&self) -> FgColorDisplay<'_, Green, Self> { unimplemented!() }
    fn on_green(&self) -> BgColorDisplay<'_, Green, Self> { unimplemented!() }
    fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self> { unimplemented!() }
    fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self> { unimplemented!() }
    fn blue(&self) -> FgColorDisplay<'_, Blue, Self> { unimplemented!() }
    fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self> { unimplemented!() }
    fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self> { unimplemented!() }
    fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self> { unimplemented!() }
    fn purple(&self) -> FgColorDisplay<'_, Magenta, Self> { unimplemented!() }
    fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self> { unimplemented!() }
    fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self> { unimplemented!() }
    fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self> { unimplemented!() }
    fn white(&self) -> FgColorDisplay<'_, White, Self> { unimplemented!() }
    fn on_white(&self) -> BgColorDisplay<'_, White, Self> { unimplemented!() }
    fn default_color(&self) -> FgColorDisplay<'_, Default, Self> { unimplemented!() }
    fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self> { unimplemented!() }
    fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self> { unimplemented!() }
    fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self> { unimplemented!() }
    fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self> { unimplemented!() }
    fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self> { unimplemented!() }
    fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self> { unimplemented!() }
    fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self> { unimplemented!() }
    fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self> { unimplemented!() }
    fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self> { unimplemented!() }
    fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self> { unimplemented!() }
    fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self> { unimplemented!() }
    fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self> { unimplemented!() }
    fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self> { unimplemented!() }
}
```

--------------------------------

### Get Owned Type (Rust)

Source: https://docs.rs/nu-protocol/latest/nu_protocol/ast/unit/struct

Defines the `Owned` associated type, representing the type that results from obtaining ownership of the data.

```rust
type Owned = T
```

--------------------------------

### Apply Bold Text Style (Rust)

Source: https://docs.rs/nu-protocol/latest/nu_protocol/debugger/profiler/struct

Makes the text bold. This is a common text formatting option for emphasis.

```rust
fn bold(&self) -> BoldDisplay<'_, Self>
```

--------------------------------

### Create Enumerate Iterator

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Creates an iterator that yields pairs of the iteration count and the element. The count starts at zero.

```rust
fn enumerate(self) -> Enumerate<Self>
where Self: Sized,
Creates an iterator which gives the current iteration count as well as the next value. Read more
```

--------------------------------

### TryFrom Implementation

Source: https://docs.rs/nu-protocol/latest/nu_protocol/process/struct

Provides a `TryFrom` implementation for conversions where the source type implements `Into` the target type. Includes error handling for conversion failures.

```rust
impl<T, U> TryFrom<U> for T
where U: Into<T>
```

```rust
type Error = Infallible;
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

--------------------------------

### Rust: Value Starts With Check

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Checks if a `Value` begins with a specified prefix, returning a `Result<Value, ShellError>`.

```rust
pub fn starts_with( &self, op: Span, rhs: &Value, span: Span, ) -> Result<Value, ShellError>
```

--------------------------------

### Get a subsection of an iterator in Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/list_stream/struct

Returns an iterator over a subsection of the original iterator. Requires the index type `R` to implement `IteratorIndex`.

```Rust
fn get<R>(self, index: R) -> <R as IteratorIndex<Self>>::Output
where
    Self: Sized,
    R: IteratorIndex<Self>,
```

--------------------------------

### PartialEq Implementation for VirtualPath

Source: https://docs.rs/nu-protocol/latest/nu_protocol/marker/struct

Illustrates the `PartialEq` trait implementation for `VirtualPath`. This enables equality comparisons between `VirtualPath` instances using `eq()` and inequality using `ne()`.

```rust
impl PartialEq for VirtualPath
fn eq(&self, other: &VirtualPath) -> bool
fn ne(&self, other: &Rhs) -> bool

```

--------------------------------

### Get a subsection of an iterator in Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/byte_stream/struct

Returns an iterator over a subsection of the original iterator, defined by an index type that supports iterator indexing.

```rust
fn get<R>(self, index: R) -> <R as IteratorIndex<Self>>::Output
where Self: Sized,
R: IteratorIndex<Self>,
```

--------------------------------

### Blanket Implementations for T

Source: https://docs.rs/nu-protocol/latest/nu_protocol/shell_error/io/struct

Showcases blanket implementations that apply to any type T. These include implementations for Any, Borrow, BorrowMut, CloneToUninit, Equivalent, From<T>, and Into<U>.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
fn type_id(&self) -> TypeId
impl<T> Borrow<T> for T
where T: ?Sized,
fn borrow(&self) -> &T
impl<T> BorrowMut<T> for T
where T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
impl<T> CloneToUninit for T
where T: Clone,
unsafe fn clone_to_uninit(&self, dest: *mut u8)
impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
fn equivalent(&self, key: &K) -> bool
impl<T> From<T> for T
fn from(t: T) -> T
impl<T, U> Into<U> for T
where U: From<T>
```

--------------------------------

### Get Iterator by Reference

Source: https://docs.rs/nu-protocol/latest/nu_protocol/byte_stream/struct

Creates a "by reference" adapter for an iterator. This allows borrowing the iterator's state without consuming it.

```rust
fn by_ref(&mut self) -> &mut Self
where Self: Sized,
```

--------------------------------

### IrBlock Display Method

Source: https://docs.rs/nu-protocol/latest/nu_protocol/ir/struct

The `display` method for `IrBlock` returns a formatter that can be used with `Display` to present a detailed listing of the instructions within the `IrBlock`. It requires an `EngineState` to provide context for the display.

```rust
pub fn display<'a>(&'a self, engine_state: &'a EngineState) -> FmtIrBlock<'a>
```

--------------------------------

### Rust: Get All Value Variants

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Returns a vector containing one of each `Value` variant (except `Custom`), intended for test data only.

```rust
pub fn test_values() -> Vec<Value>
```

--------------------------------

### Rust: ParserPath Methods for File Content and Reading

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Details methods for reading and accessing the content of paths represented by ParserPath. This includes reading directory contents (`read_dir`) and opening files for reading (`open`), which may involve interacting with a `StateWorkingSet`. It also includes a method to read the raw bytes of a file.

```rust
pub fn read_dir(&self) -> Option<Vec<ParserPath>>
pub fn open<'a>( &'a self, working_set: &'a StateWorkingSet<'_>, ) -> Result<Box<dyn Read + 'a>>
pub fn read<'a>( &'a self, working_set: &'a StateWorkingSet<'_>, ) -> Option<Vec<u8>>
```

--------------------------------

### Get Cell Path Reference - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Retrieves a reference to the inner `CellPath` value. Returns an error if the `Value` is not a cell path.

```rust
pub fn as_cell_path(&self) -> Result<&CellPath, ShellError>
```

--------------------------------

### Generic Blanket Implementations

Source: https://docs.rs/nu-protocol/latest/nu_protocol/marker/struct

Details various generic blanket implementations applied to `VirtualPath` through trait bounds. These include implementations for `Any`, `Borrow`, `BorrowMut`, `CloneToUninit`, `Comparable`, `Equivalent`, `From`, `Into`, `IntoEither`, and `IntoSpanned`.

```rust
impl<T> Any for T where T: 'static + ?Sized
impl<T> Borrow<T> for T where T: ?Sized
impl<T> BorrowMut<T> for T where T: ?Sized
impl<T> CloneToUninit for T where T: Clone
impl<Q, K> Comparable<K> for Q where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized
impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized
impl<T> From<T> for T
impl<T, U> Into<U> for T where U: From<T>
impl<T> IntoEither for T
impl<T> IntoSpanned for T

```

--------------------------------

### Get Binary Slice Reference - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Returns a reference to the inner binary slice. Returns an error if the `Value` is not a binary value.

```rust
pub fn as_binary(&self) -> Result<&[u8], ShellError>
```

--------------------------------

### ReportLog Blanket Implementations - Conversion

Source: https://docs.rs/nu-protocol/latest/nu_protocol/report_error/struct

Illustrates blanket implementations for conversion traits like 'From' and 'Into', enabling seamless data transformations.

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

```rust
impl<T, U> Into<U> for T
where U: From<T>
```

```rust
fn into(self) -> U
```

--------------------------------

### Get Indices of Elements Satisfying Predicate

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Yields the indices of elements that satisfy a given predicate function. The indices are counted from the beginning of the iterator.

```rust
fn positions<P>(self, predicate: P) -> Positions<Self, P>
where Self: Sized, P: FnMut(Self::Item) -> bool,
```

--------------------------------

### Blanket Implementations for VirtualPath

Source: https://docs.rs/nu-protocol/latest/nu_protocol/marker/struct

Details blanket implementations that apply to VirtualPath due to its generic implementations of standard traits.

```APIDOC
## Blanket Implementations

### impl<T> Any for T

- **type_id()**: Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T

- **borrow()**: Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T

- **borrow_mut()**: Mutably borrows from an owned value.

### impl<T> CloneToUninit for T

- **clone_to_uninit()**: Performs copy-assignment from `self` to `dest` (nightly-only).

### impl<Q, K> Comparable<K> for Q

- **compare()**: Compare self to `key` and return their ordering.

### impl<Q, K> Equivalent<K> for Q

- **equivalent()**: Compare self to `key` and return `true` if they are equal.

### impl<T> From<T> for T

- **from()**: Returns the argument unchanged.

### impl<T, U> Into<U> for T

- **into()**: Calls `U::from(self)`.

### impl<T> IntoEither for T

- **into_either()**: Converts `self` into a `Left` or `Right` variant of `Either<Self, Self>`.
- **into_either_with()**: Converts `self` based on a predicate function.

### impl<T> IntoSpanned for T
```

--------------------------------

### Get Custom Value Reference - Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/enum

Retrieves a reference to the inner `CustomValue` trait object. Returns an error if the `Value` is not a custom value.

```rust
pub fn as_custom_value(&self) -> Result<&dyn CustomValue, ShellError>
```

--------------------------------

### Display Implementation for AdditionalContext

Source: https://docs.rs/nu-protocol/latest/nu_protocol/shell_error/io/struct

Shows the Display trait implementation for AdditionalContext, enabling instances to be formatted as strings for general output.

```rust
impl Display for AdditionalContext
fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result
```

--------------------------------

### ReportLog Colorization Implementations

Source: https://docs.rs/nu-protocol/latest/nu_protocol/report_error/struct

Details implementations for the 'OwoColorize' trait, providing methods to apply various ANSI escape codes for foreground and background colors to the ReportLog.

```rust
impl<D> OwoColorize for D
```

```rust
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color
```

```rust
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color
```

```rust
fn black(&self) -> FgColorDisplay<'_, Black, Self>
```

```rust
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
```

```rust
fn red(&self) -> FgColorDisplay<'_, Red, Self>
```

```rust
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
```

```rust
fn green(&self) -> FgColorDisplay<'_, Green, Self>
```

```rust
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
```

```rust
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
```

```rust
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
```

```rust
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
```

```rust
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
```

```rust
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
```

```rust
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
```

```rust
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
```

```rust
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
```

```rust
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
```

```rust
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
```

```rust
fn white(&self) -> FgColorDisplay<'_, White, Self>
```

```rust
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
```

```rust
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
```

```rust
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
```

```rust
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
```

--------------------------------

### Get All Maximum Elements by Custom Comparison

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Returns a vector of all maximum elements identified by a custom comparison function. This allows for flexible definitions of 'maximum'.

```Rust
fn max_set_by<F>(self, compare: F) -> Vec<Self::Item>
where Self: Sized,
 F: FnMut(&Self::Item, &Self::Item) -> Ordering,
```

--------------------------------

### Get All Maximum Elements

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Returns a vector containing all elements that are considered maximum according to the `Ord` trait. Useful for finding all occurrences of the largest value.

```Rust
fn max_set(self) -> Vec<Self::Item>
where Self: Sized,
 Self::Item: Ord,
```

--------------------------------

### Apply Style in Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/marker/struct

Applies a style to the text where the style itself is determined at runtime. Returns a styled reference.

```Rust
fn style(&self, style: Style) -> Styled<&Self>
```

--------------------------------

### Get All Minimum Elements by Custom Comparison

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Returns a vector of all minimum elements identified by a custom comparison function. This allows for flexible definitions of 'minimum'.

```Rust
fn min_set_by<F>(self, compare: F) -> Vec<Self::Item>
where Self: Sized,
 F: FnMut(&Self::Item, &Self::Item) -> Ordering,
```

--------------------------------

### Rust Blanket Implementations for Visibility

Source: https://docs.rs/nu-protocol/latest/nu_protocol/engine/struct

Showcases blanket implementations applied to the `Visibility` struct, leveraging generic implementations for traits like `Any`, `Borrow`, `BorrowMut`, `CloneToUninit`, `From`, `Into`, `IntoEither`, `IntoSpanned`, and `OwoColorize`.

```Rust
impl<T> Any for T where T: 'static + ?Sized
fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized
fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized
fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for T where T: Clone
unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T
fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>
fn into(self) -> U

impl<T> IntoEither for T
fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> where F: FnOnce(&Self) -> bool

impl<T> IntoSpanned for T
fn into_spanned(self, span: Span) -> Spanned<T>

impl<D> OwoColorize for D
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where C: Color
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where C: Color
fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
```

--------------------------------

### Get All Minimum Elements

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Returns a vector containing all elements that are considered minimum according to the `Ord` trait. Useful for finding all occurrences of the smallest value.

```Rust
fn min_set(self) -> Vec<Self::Item>
where Self: Sized,
 Self::Item: Ord,
```

--------------------------------

### Get Iterator Length in Rust

Source: https://docs.rs/nu-protocol/latest/nu_protocol/byte_stream/struct

The `try_len` method attempts to return the exact length of an iterator. If the length cannot be determined, it returns the iterator's size hint.

```Rust
fn try_len(&self) -> Result<usize, (usize, Option<usize>)>
```

--------------------------------

### Apply Runtime Style (Rust)

Source: https://docs.rs/nu-protocol/latest/nu_protocol/struct

Applies a style to the output where the style itself is determined at runtime. This allows for dynamic styling of terminal text.

```rust
fn style(&self, style: Style) -> Styled<&Self>
```

--------------------------------

### Get Last N Elements

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Consumes the iterator and returns a new iterator containing the last `n` elements. This is useful for examining the tail end of a sequence.

```Rust
fn tail(self, n: usize) -> IntoIter<Self::Item>
where Self: Sized,
```

--------------------------------

### VirtualPath Struct

Source: https://docs.rs/nu-protocol/latest/nu_protocol/marker/struct

Provides details about the VirtualPath struct, its purpose, and its source.

```APIDOC
## Struct VirtualPath

### Description
Represents a virtual path within the nu-protocol.

### Source
`nu_protocol::marker::VirtualPath`

### Summary
```rust
pub struct VirtualPath;
```
```

--------------------------------

### Get All Maximum Elements by Key

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Returns a vector of all elements that yield the maximum value when a provided key function is applied. The key type must implement `Ord`.

```Rust
fn max_set_by_key<K, F>(self, key: F) -> Vec<Self::Item>
where Self: Sized,
 K: Ord,
 F: FnMut(&Self::Item) -> K,
```

--------------------------------

### ParserPath Trait Implementations

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Summary of implemented traits for the ParserPath enum, including Clone, Debug, Ord, PartialEq, PartialOrd, and Eq.

```APIDOC
## ParserPath Trait Implementations

### `impl Clone for ParserPath`
Allows ParserPath instances to be cloned.

### `impl Debug for ParserPath`
Enables debugging output for ParserPath instances.

### `impl Ord for ParserPath`
Provides total ordering for ParserPath instances.

### `impl PartialEq for ParserPath`
Allows for equality comparison between ParserPath instances.

### `impl PartialOrd for ParserPath`
Provides partial ordering for ParserPath instances.

### `impl Eq for ParserPath`
Marks ParserPath as having a total equivalence relation.
```

--------------------------------

### Clone Implementation for ProfilerOptions

Source: https://docs.rs/nu-protocol/latest/nu_protocol/debugger/profiler/struct

Provides methods to clone ProfilerOptions, including a direct clone and a clone_from method for efficient copying.

```rust
impl Clone for ProfilerOptions
fn clone(&self) -> ProfilerOptions
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Get All Minimum Elements by Key

Source: https://docs.rs/nu-protocol/latest/nu_protocol/record/struct

Returns a vector of all elements that yield the minimum value when a provided key function is applied. The key type must implement `Ord`.

```Rust
fn min_set_by_key<K, F>(self, key: F) -> Vec<Self::Item>
where Self: Sized,
 K: Ord,
 F: FnMut(&Self::Item) -> K,
```

--------------------------------

### Get Last n Elements of Iterator

Source: https://docs.rs/nu-protocol/latest/nu_protocol/list_stream/struct

Consumes the iterator and returns a new iterator containing the last `n` elements. This method is useful for retrieving a trailing subset of data.

```rust
fn tail(self, n: usize) -> IntoIter<Self::Item>
where Self: Sized
```

--------------------------------

### Matcher Trait

Source: https://docs.rs/nu-protocol/latest/nu_protocol/engine/trait

Details the Matcher trait, its purpose, and its required methods.

```APIDOC
## Trait Matcher

### Description
A trait that defines how to match a given value against a pattern.

### Required Methods
#### fn match_value(&self, value: &Value, matches: &mut Vec<(VarId, Value)>) -> bool

This method attempts to match the provided `value` against the implementor's pattern. If a match is found, it populates the `matches` vector with variable bindings and returns `true`. Otherwise, it returns `false`.

### Implementors

#### impl Matcher for Pattern
This implementation allows matching values using the `Pattern` type.

#### impl Matcher for MatchPattern
This implementation allows matching values using the `MatchPattern` type.
```

--------------------------------

### Get Last n Elements in Rust Iterator

Source: https://docs.rs/nu-protocol/latest/nu_protocol/byte_stream/struct

Consumes the iterator and returns a new iterator containing the last `n` elements. If the iterator has fewer than `n` elements, it returns all of them.

```rust
fn tail(self, n: usize) -> IntoIter<Self::Item>
where Self: Sized,
{
    // Implementation details...
}
```

--------------------------------

### Rust: ParserPath from_virtual_path Function

Source: https://docs.rs/nu-protocol/latest/nu_protocol/parser_path/enum

Illustrates the creation of a ParserPath instance from a virtual path. The `from_virtual_path` function takes a `StateWorkingSet`, a name, and a `VirtualPath` to construct a new ParserPath, facilitating the integration of virtual file system structures.

```rust
pub fn from_virtual_path(
    working_set: &StateWorkingSet<'_>,
    name: &str,
    virtual_path: &VirtualPath,
) -> Self
```
Tokens:
Raw