Skip to main content

SectionGuard

Struct SectionGuard 

Source
pub struct SectionGuard<'p> { /* private fields */ }
Expand description

Open section. Holds a reference to Printer and the renderer’s depth. Drop closes the section: emits a deferred (none) placeholder if no children rendered (and keep_when_empty was true), or leaves no trace (if keep_when_empty was false).

Implementations§

Source§

impl<'p> SectionGuard<'p>

Source

pub fn bullet(&self, text: impl Into<String>) -> &Self

Source

pub fn kv(&self, key: impl Into<String>, value: impl Into<String>) -> &Self

Source

pub fn kv_block<I, K, V>(&self, pairs: I) -> &Self
where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Source

pub fn hint(&self, text: impl Into<String>) -> &Self

Source

pub fn note(&self, text: impl Into<String>) -> &Self

Source

pub fn table(&self, table: Table) -> &Self

Source

pub fn empty_state(&self, text: impl Into<String>) -> &Self

Set the empty-state placeholder for this section (overrides the default “(none)”). Only meaningful for sections opened with section() (not section_or_collapse()).

Source

pub fn status_simple(&self, role: Role, subject: impl Into<String>) -> &Self

Status with no extra fields. For chained detail/duration/target, use status for the chainable builder.

Source

pub fn status( &self, role: Role, subject: impl Into<String>, ) -> StatusBuilder<'_>

Status builder at this section’s depth. Commits on Drop.

Source

pub fn section(&self, name: impl Into<String>) -> SectionGuard<'_>

Open a child section. Returns a guard that borrows &self so the parent is locked until the child drops.

Source

pub fn section_or_collapse(&self, name: impl Into<String>) -> SectionGuard<'_>

Source

pub fn spinner(&self, message: impl Into<String>) -> Spinner<'_>

Section-scoped spinner. Inherits the section’s depth so the eventual Status emitted by finish_* lands at the right indentation.

Source

pub fn progress_bar( &self, total: u64, message: impl Into<String>, ) -> ProgressBar<'_>

Section-scoped progress bar.

Source

pub fn run( &self, cmd: &mut Command, label: impl Into<String>, ) -> Result<CommandOutput>

Run an external command at this section’s depth with live output. TTY+non-quiet → spinner with tailing ring indented under the section; otherwise → streaming lines. Either path captures full stdout/stderr.

Source

pub fn close(self)

Manually close (alternative to drop). Useful when the caller needs the section to close before the binding goes out of scope.

Trait Implementations§

Source§

impl Drop for SectionGuard<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'p> Freeze for SectionGuard<'p>

§

impl<'p> !RefUnwindSafe for SectionGuard<'p>

§

impl<'p> Send for SectionGuard<'p>

§

impl<'p> Sync for SectionGuard<'p>

§

impl<'p> Unpin for SectionGuard<'p>

§

impl<'p> UnsafeUnpin for SectionGuard<'p>

§

impl<'p> !UnwindSafe for SectionGuard<'p>

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> 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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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