Struct ProgramOptionRecord 

pub struct ProgramOptionRecord {
    pub source: u16,
    pub program: Option<String>,
    pub name: String,
    pub node_id: String,
}

One Cmdoption.add_target_and_index call the parse layer made (sphinx/domains/std/__init__.py:308-315).

Fields

source: u16

Source-table index of the registering signature (an option inside an included file must attribute to that file). Deliberately not #[serde(default)] — the cache-shape rule RegistryExport::program_options explains.

program: Option<String>

The .. program:: in scope, None outside one.

name: String

One desc_signature['allnames'] spelling (--file, -f, …).

node_id: String

signode['ids'][0] — the first id of the signature, which is what Sphinx registers for every spelling in it.

Trait Implementations

impl Clone for ProgramOptionRecord

fn clone(&self) -> ProgramOptionRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgramOptionRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgramOptionRecord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgramOptionRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.