Struct ClassWrapper 

pub struct ClassWrapper {
    pub head: Vec<String>,
    pub class_docs: Vec<String>,
    pub class_doc_lines: Vec<String>,
    pub members: Vec<String>,
    pub tail: Vec<String>,
    pub member_names: Vec<String>,
}

One impl block’s R wrapper, in the parts the wrapper writer merges per Rust type (#1776): the class is defined once, from the defining block’s head and tail, and every block’s members attach to it. See miniextendr_api::registry::ClassBlockEntry.

Fields

head: Vec<String>

The class definition: the class’s roxygen block, with the CLASS_DOCS_MARKER line where the impl docs go and the CLASS_DOC_LINES_MARKER line where member-derived class docs go, the class object, the constructor and the class-level helpers.

class_docs: Vec<String>

The block’s own doc comment as roxygen lines (with the constructor’s, for S3 and vctrs, whose class block is the constructor’s block).

class_doc_lines: Vec<String>

Roxygen lines the block’s members add to the class’s roxygen block.

members: Vec<String>

The block’s methods and static methods.

tail: Vec<String>

What follows the members of every block, such as R6’s $lock().

member_names: Vec<String>

The names the members bind in the class’s own namespaces, worded for the writer’s message when two blocks bind the same one.

Implementations

impl ClassWrapper

fn mark_class_doc_lines( &mut self, head: &mut Vec<String>, parsed_impl: &ParsedImpl, )

Put the CLASS_DOC_LINES_MARKER before the last line of head, the tag that closes the class’s roxygen block, and add the lifecycle imports of the block’s methods to the class docs.

Trait Implementations

impl Debug for ClassWrapper

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

Formats the value using the given formatter.

impl Default for ClassWrapper

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 144 bytes