Skip to main content

OutputNode

Struct OutputNode 

Source
pub struct OutputNode {
    pub name: String,
    pub entry_type: EntryType,
    pub text: Option<String>,
    pub cells: Vec<String>,
    pub children: Vec<OutputNode>,
}
Expand description

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 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.

Fields§

§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).

Implementations§

Source§

impl OutputNode

Source

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

Create a new node with a name.

Source

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

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

Source

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

Set the entry type for rendering hints.

Source

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

Set additional columns for tabular output.

Source

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

Set child nodes for tree output.

Source

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

Set text content.

Source

pub fn is_text_only(&self) -> bool

Check if this is a text-only node.

Source

pub fn has_children(&self) -> bool

Check if this node has children.

Source

pub fn estimated_byte_size(&self) -> usize

Estimate brace-notation byte size without materializing.

Source

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

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

Source

pub fn display_name(&self) -> &str

Get the display name, potentially with text content.

Trait Implementations§

Source§

impl Clone for OutputNode

Source§

fn clone(&self) -> OutputNode

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutputNode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OutputNode

Source§

fn default() -> OutputNode

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OutputNode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for OutputNode

Source§

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. Read more
Source§

impl Eq for OutputNode

Source§

impl StructuralPartialEq for OutputNode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

impl<'p, T> Seq<'p, T> for T
where T: Clone,

Source§

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.
Source§

type Iter<'a> = Once<&'a T> where T: 'a

An iterator over the items within this container, by reference.
Source§

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.
Source§

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.
Source§

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a MaybeRef.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> OrderedSeq<'_, T> for T
where T: Clone,