Struct ProgramStatus 

pub struct ProgramStatus<'a> {
    pub state: ProgramStatusState<'a>,
    pub id: Option<&'a str>,
    pub kind: Option<ProgramStatusKind<'a>>,
    pub progress: Option<u8>,
    pub app: Option<&'a str>,
    pub title: Option<&'a str>,
    pub message: Option<&'a str>,
}

A complete OSC 7501 report, with borrowed text.

Each report replaces its record, so include every field that should remain present. An absent app inherits from the nearest ancestor with one. Text and identifiers are validated by write_program_status before any output. Callers supply plain UTF-8, not base64.

Fields

state: ProgramStatusState<'a>

Required record state.

id: Option<&'a str>

Optional record path. At most 128 bytes and eight slash-separated segments, each 1-32 bytes from [A-Za-z0-9_.+-]. None selects root.

kind: Option<ProgramStatusKind<'a>>

Reason for blocking. Terminals use this only with state blocked.

progress: Option<u8>

Percentage, from 0 to 100. Terminals use this only with state working or blocked. None means indeterminate progress.

app: Option<&'a str>

Program name: 1-32 bytes from [A-Za-z0-9_.+-].

title: Option<&'a str>

Human-readable record label, at most 192 UTF-8 bytes. C0, DEL, and C1 control characters are rejected.

message: Option<&'a str>

Human-readable status message, at most 2048 UTF-8 bytes. C0, DEL, and C1 control characters are rejected.

Implementations

impl<'a> ProgramStatus<'a>

pub fn new(state: ProgramStatusState<'a>) -> Self

Create a root report with the specified state and no optional fields.

Trait Implementations

impl<'a> Clone for ProgramStatus<'a>

fn clone(&self) -> ProgramStatus<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProgramStatus<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for ProgramStatus<'a>

impl<'a> PartialEq for ProgramStatus<'a>

fn eq(&self, other: &ProgramStatus<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for ProgramStatus<'a>