Struct PageContext 

pub struct PageContext {
    pub kind: String,
    pub item: Option<String>,
    pub revision: Option<String>,
    pub change: Option<String>,
    pub request: Option<String>,
    pub project: Option<String>,
    pub view: Option<String>,
    pub rule: Option<String>,
    pub query: Option<String>,
    pub filters: Vec<(String, String)>,
    pub selected: Option<String>,
    pub shown: Vec<String>,
}

What a page declares (see the module documentation).

Fields

kind: String

One of KINDS; empty = no context.

item: Option<String>

Item number.

revision: Option<String>

Revision code (with item).

change: Option<String>

Change order number.

request: Option<String>

Change request number.

project: Option<String>

Project group code.

view: Option<String>

The section or tab: overview, files, bom, where-used …

rule: Option<String>

The revision rule of a BOM view: latest, latest-released …

query: Option<String>

The search query or list filter text.

filters: Vec<(String, String)>

Further list filters (state = released …).

selected: Option<String>

The selected row (an item number in the vault explorer).

shown: Vec<String>

Item numbers of the rows currently shown (at most MAX_SHOWN).

Implementations

impl PageContext

pub fn parse(v: &Value) -> PageContext

Reads the context a client sent. Never fails: whatever has the wrong type, characters or length is dropped, lists are capped.

pub fn is_empty(&self) -> bool

Nothing declared.

pub fn label(&self) -> String

A short description for the chip and the thread: PRT-000009/A · BOM (latest released). Built from the fields of this context, so call it on the resolved context only.

pub fn model_note(&self) -> String

The note appended to the user’s message: where the user is. Only resolved values are in it; the model is told it is a hint.

Trait Implementations

impl Clone for PageContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageContext

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

Formats the value using the given formatter.

impl Default for PageContext

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PageContext

impl PartialEq for PageContext

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PageContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PageContext