Struct OutputNode 

#[non_exhaustive]
pub struct OutputNode {
    pub name: String,
    pub entry_type: EntryType,
    pub text: Option<String>,
    pub cells: Vec<String>,
    pub children: Vec<OutputNode>,
    pub line: Option<u64>,
}

A node in the output tree.

All fields are always serialized (no skip_serializing_if) for predictable shape across JSON, postcard, and bincode formats.

text is Option<String> because None and Some(“”) are semantically distinct:

• None: this is a named entry (file listing, table row), not a text node
• Some(“”): this IS a text node whose content is empty (e.g. echo "")

The is_text_only() method depends on this distinction.

#[non_exhaustive] for the same reason OutputData is: this struct grows — line was added in 0.16 — and an out-of-tree struct literal would break on each addition. Build one with OutputNode::new or OutputNode::text and the builder methods.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Primary identifier (filename, key, label).

entry_type: EntryType

Rendering hint (colors, icons).

text: Option<String>

Text content (for echo, cat, exec).

Three-state semantics:

• None — named entry (file listing, table row), not text
• Some("") — text node with empty content (e.g., echo "")
• Some("x") — text node with content

is_text_only() returns true iff text is Some AND name/cells/children are empty.

cells: Vec<String>

Additional columns (for ls -l, ps, env).

children: Vec<OutputNode>

Child nodes (for tree, find).

line: Option<u64>

Which line of the file or stream this row is, 1-based.

The anchor a builtin declares and every consumer reads: --json renders it as an integer named line, and the REPL and embedders read the same field. None means the row has no line to point at (a directory entry, a process, an environment variable), not line zero.

Set it with OutputNode::at_line. Do not re-derive it from cells — a cell is a rendering choice, positional and per-builtin, and reading one back is what this field exists to stop.

Implementations

impl OutputNode

pub fn new(name: impl Into<String>) -> OutputNode

Create a new node with a name.

pub fn text(content: impl Into<String>) -> OutputNode

Create a text-only node (for echo, cat, etc.).

pub fn with_entry_type(self, entry_type: EntryType) -> OutputNode

Set the entry type for rendering hints.

pub fn at_line(self, line: u64) -> OutputNode

Declare which line of the file or stream this row is, 1-based.

A builtin says which line; the kernel decides how to render it.

use kaish_types::OutputNode;

let node = OutputNode::new("fn main() {").at_line(42);
assert_eq!(node.line, Some(42));

pub fn with_cells(self, cells: Vec<String>) -> OutputNode

Set additional columns for tabular output.

pub fn with_children(self, children: Vec<OutputNode>) -> OutputNode

Set child nodes for tree output.

pub fn with_text(self, text: impl Into<String>) -> OutputNode

Set text content.

pub fn is_text_only(&self) -> bool

Check if this is a text-only node.

pub fn has_children(&self) -> bool

Check if this node has children.

pub fn estimated_byte_size(&self) -> usize

Estimate brace-notation byte size without materializing.

pub fn write_canonical( &self, w: &mut dyn Write, budget: usize, ) -> Result<usize, Error>

Write brace-notation to a writer. Returns bytes written.

pub fn display_name(&self) -> &str

Get the display name, potentially with text content.

Trait Implementations

impl Clone for OutputNode

fn clone(&self) -> OutputNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputNode

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

Formats the value using the given formatter.

impl Default for OutputNode

fn default() -> OutputNode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputNode

where OutputNode: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<OutputNode, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OutputNode

impl PartialEq for OutputNode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OutputNode

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OutputNode